Skip to content

Commit

Permalink
[skip ci] Reword dynamic domains support in modules
Browse files Browse the repository at this point in the history
  • Loading branch information
gustawlippa committed Sep 10, 2021
1 parent c636891 commit 20339d6
Show file tree
Hide file tree
Showing 13 changed files with 52 additions and 30 deletions.
42 changes: 16 additions & 26 deletions doc/advanced-configuration/Modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,29 +191,19 @@ Provides support for vCards, as specified in [XEP-0054: vcard-temp](http://xmpp.
### [mod_version](../modules/mod_version.md)
This module provides the functionality specified in [XEP-0092: Software Version](https://xmpp.org/extensions/xep-0092.html).

## Modules supporting dynamic domains

These modules can be enabled when using host types in `modules` or [`host_config.modules`](./host_config.md#host_configmodules) sections:

* [mod_blocking](../modules/mod_blocking.md)
* [mod_caps](../modules/mod_caps.md)
* [mod_cache_users](../modules/mod_cache_users.md)
* [mod_carboncopy](../modules/mod_carboncopy.md)
* [mod_commands](../modules/mod_commands.md)
* [mod_disco](../modules/mod_disco.md)
* [mod_domain_isolation](../modules/mod_domain_isolation.md)
* [mod_inbox](../modules/mod_inbox.md)
* [mod_last](../modules/mod_last.md)
* [mod_mam](../modules/mod_mam.md)
* [mod_muc](../modules/mod_muc.md)
* [mod_muc_log](../modules/mod_muc_log.md)
* [mod_muc_light](../modules/mod_muc_light.md)
* [mod_muc_light_commands](../modules/mod_muc_light_commands.md)
* [mod_offline](../modules/mod_offline.md)
* [mod_offline_stub](../modules/mod_offline_stub.md)
* [mod_ping](../modules/mod_ping.md)
* [mod_privacy](../modules/mod_privacy.md)
* [mod_private](../modules/mod_private.md)
* [mod_roster](../modules/mod_roster.md)
* [mod_stream_management](../modules/mod_stream_management.md)
* [mod_vcard](../modules/mod_vcard.md)
## Modules incompatible with dynamic domains

There are some modules that don't support dynamic domains for now.
These must not be enabled when using host types in `modules` or [`host_config.modules`](./host_config.md#host_configmodules) sections:

* [mod_amp](../modules/mod_amp.md)
* [mod_auth_token](../modules/mod_auth_token.md)
* [mod_event_pusher](../modules/mod_event_pusher.md)
* [mod_extdisco](../modules/mod_extdisco.md)
* [mod_global_distrib](../modules/mod_global_distrib.md)
* [mod_http_upload](../modules/mod_http_upload.md)
* [mod_jingle_sip](../modules/mod_jingle_sip.md)
* [mod_keystore](../modules/mod_keystore.md)
* [mod_pubsub](../modules/mod_pubsub.md)
* [mod_push_service_mongoosepush](../modules/mod_push_service_mongoosepush.md)
* [mod_shared_roster_ldap](../modules/mod_shared_roster_ldap.md)
4 changes: 2 additions & 2 deletions doc/advanced-configuration/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ Each host type can be seen as a label for a group of independent domains that us
In order to configure these host types independently, use the [`host_config` section](./host_config.md).
The domains can be added or removed dynamically via the [dynamic domains REST API](../rest-api/Dynamic-domains.md).

If you use the host type mechanism, make sure you only configure modules which support it in the [`modules`](./Modules.md) or [`host_config.modules`](./host_config.md#host_configmodules) sections.
If you use the host type mechanism, make sure you only configure modules which support dynamic domains in the [`modules`](./Modules.md) or [`host_config.modules`](./host_config.md#host_configmodules) sections.
MongooseIM will not start otherwise.
In order to see which modules support dynamic domains, please check the [modules list](./Modules.md#modules-supporting-dynamic-domains).
Most of the modules are compatible with host types, but please read the particular extension module's page, or the [incompatible modules list](./Modules.md#modules-incompatible-with-dynamic-domains) to see which do not.

!!! Note
At least one of `general.hosts` or `general.host_types` have to be provided.
Expand Down
3 changes: 3 additions & 0 deletions doc/modules/mod_amp.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ provide features related to timed delivery, i.e the `expire-at` condition.
The `error` and `notify` actions are supported, while `alert` and `drop` are
not. See more below, under XEP Support.

!!! warning
This module does not support [dynamic domains](../advanced-configuration/general.md#generalhost_types).

## Options

None.
Expand Down
3 changes: 3 additions & 0 deletions doc/modules/mod_auth_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ It provides services necessary to:
The module itself does not implement protocol related details - these are implemented in `cyrsasl.erl`.
Generation of keys necessary to sign binary tokens is delegated to module `mod_keystore.erl`.

!!! warning
This module does not support [dynamic domains](../advanced-configuration/general.md#generalhost_types).

## Options

### `modules.mod_auth_token.validity_period`
Expand Down
3 changes: 3 additions & 0 deletions doc/modules/mod_event_pusher.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ and outgoing) are already hooked up to the frontend via `mod_event_pusher_hook_t
`mod_event_pusher` dependency, which is a proxy between various hooks and the `push_event/3` hook
handler.

!!! warning
This module does not support [dynamic domains](../advanced-configuration/general.md#generalhost_types).

## Options

### `modules.mod_event_pusher.backend`
Expand Down
3 changes: 3 additions & 0 deletions doc/modules/mod_extdisco.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Implements [XEP-0215: External Service Discovery](http://xmpp.org/extensions/xep-0215.html) for discovering information about services external to the XMPP network.
The main use-case is to help discover STUN/TURN servers to allow for negotiating media exchanges.

!!! warning
This module does not support [dynamic domains](../advanced-configuration/general.md#generalhost_types).

## Options

### `modules.mod_extdisco.service.type`
Expand Down
3 changes: 3 additions & 0 deletions doc/modules/mod_global_distrib.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
This module enables global distribution of a single XMPP domain.
With `mod_global_distrib`, multiple distinct MongooseIM clusters can share a single domain name and route messages to the specific datacenter where the recipient is available.

!!! warning
This module does not support [dynamic domains](../advanced-configuration/general.md#generalhost_types).

## How it works

There are multiple subsystems that cooperate to enable global distribution:
Expand Down
3 changes: 3 additions & 0 deletions doc/modules/mod_http_upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ A slot is a pair of URLs, one of which can be used with a `PUT` method to upload

Currently, the module supports only the [S3][s3] backend using [AWS Signature Version 4](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html).

!!! warning
This module does not support [dynamic domains](../advanced-configuration/general.md#generalhost_types).

## Options

### `modules.mod_http_upload.iqdisc.type`
Expand Down
6 changes: 4 additions & 2 deletions doc/modules/mod_jingle_sip.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ When MongooseIM observes the above Jingle stanzas, it will translate them to a S
In the SDP content of the request, there will be a custom attribute `a=jingle-action`.
The value of the custom attribute is one of the three presented above.

Similarly when MongooseIM gets a SIP in-dialog `INVITE` request,
Similarly, when MongooseIM gets a SIP in-dialog `INVITE` request,
it will check if there is a custom attribute and use it as the `action` attribute of the Jingle stanza sent to the user.
If there is no such attribute, the action will be set to regular Jingle `transport-info`.

Expand All @@ -83,7 +83,6 @@ This may be useful in web applications when there is a need to handle the call i
In order to get the `session-initiate`, which was not answered yet, the user can send a `get` Jingle stanza to self with action set to `existing-session-initiate`.
As a result, MongooseIM will resend the original `session-initiate` request to the device which sent the query.


## Prerequisites

By default, MongooseIM is built without SIP support.
Expand All @@ -98,6 +97,9 @@ tools/configure with-all

MongooseIM packages are built with Jingle/SIP support.

!!! warning
This module does not support [dynamic domains](../advanced-configuration/general.md#generalhost_types).

## Options

### `modules.mod_jingle_sip.proxy_host`
Expand Down
3 changes: 3 additions & 0 deletions doc/modules/mod_keystore.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ multi-tenant hosting scenarios.
In a multi-tenant server **`mod_keystore` must be configured separately
for each virtual XMPP domain to avoid sharing keys between domains!**

!!! warning
This module does not support [dynamic domains](../advanced-configuration/general.md#generalhost_types).

## Options

### `modules.mod_keystore.ram_key_size`
Expand Down
3 changes: 3 additions & 0 deletions doc/modules/mod_pubsub.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Due to the complexity of the protocol, the PubSub engine makes successive calls
Such an architecture makes it much easier to write custom pubsub plugins and add new storage backends.
It's all about tailoring PubSub to your needs!

!!! warning
This module does not support [dynamic domains](../advanced-configuration/general.md#generalhost_types).

## Options

### `modules.mod_pubsub.iqdisc.type`
Expand Down
3 changes: 3 additions & 0 deletions doc/modules/mod_push_service_mongoosepush.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ This module handles the `push_notification` hook generated by `mod_pubsub` with
Each `push_notification` hook is converted as a `REST` API call to the [MongoosePush](https://github.com/esl/MongoosePush) service.
You can find the full list of supported `publish-options` [here](../user-guide/push-notifications/Push-notifications-client-side.md#publish-options).

!!! warning
This module does not support [dynamic domains](../advanced-configuration/general.md#generalhost_types).

### Prerequisites

This module uses a connection pool via `mongoose_http_client`.
Expand Down
3 changes: 3 additions & 0 deletions doc/modules/mod_shared_roster_ldap.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ It might get quite complicated to configure it properly, so fasten your seatbelt
When a default value for an option is defined with "top-level/XXX", it means that the default value is equal to a top-level parameter in `mongooseim.toml` of the same name.
If it is not defined, XXX becomes the default value.

!!! warning
This module does not support [dynamic domains](../advanced-configuration/general.md#generalhost_types).

## Options: general

### `modules.mod_shared_roster_ldap.ldap_pool_tag`
Expand Down

0 comments on commit 20339d6

Please sign in to comment.