Skip to content

mod_privacy

Module Description

This module implements XEP-0016: Privacy Lists. This extension allows user to block IQs, messages, presences, or all, based on JIDs, subscription, and roster groups.

Options

modules.mod_privacy.backend

  • Syntax: string, one of "mnesia", "rdbms", "riak".
  • Default: "mnesia"
  • Example: backend = "mnesia"

Warning

Riak is deprecated and its support will be withdrawn in future versions of MongooseIM.

Riak-specific options

modules.mod_privacy.riak.defaults_bucket_type

  • Syntax: string.
  • Default: "privacy_defaults"
  • Example: riak.defaults_bucket_type = "privacy_defaults"

Riak bucket type for information about default list name.

modules.mod_privacy.riak.names_bucket_type

  • Syntax: string.
  • Default: "privacy_lists_names"
  • Example: riak.names_bucket_type = "privacy_lists_names"

Riak bucket type for information about privacy list names.

modules.mod_privacy.riak.bucket_type

  • Syntax: string.
  • Default: "privacy_lists"
  • Example: riak.bucket_type = "privacy_lists"

Riak bucket type for privacy lists.

Example Configuration

1
2
3
[modules.mod_privacy]
  backend = "riak"
  riak.defaults_bucket_type = "privacy_defaults"

Metrics

If you'd like to learn more about metrics in MongooseIM, please visit MongooseIM metrics page.

Backend action Description (when it gets incremented)
get_privacy_list A privacy list is retrieved from a DB.
get_list_names Names of user's privacy lists are fetched from a DB.
get_default_list A default privacy list for a user is fetched from a DB.
set_default_list A default list's name for a user is set in a DB.
forget_default_list A default list's name for a user is removed from a DB.
remove_privacy_list A privacy list is deleted from a DB.
replace_privacy_list A privacy list is updated (replaced) in a DB.