Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken link #3288

Merged
merged 1 commit into from
Sep 21, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

MongooseIM is a robust, scalable and efficient XMPP server at the core of an Instant Messaging platform aimed at large installations.

<img align="left" src="../../MongooseIM_logo.png" alt="MongooseIM platform's logo" style="padding-right: 20px;"/>
<img align="left" src="MongooseIM_logo.png" alt="MongooseIM platform's logo" style="padding-right: 20px;"/>

Designed for enterprise, it is fault-tolerant, can utilise the resources of multiple clustered machines, and easily scales for more capacity by simply adding a box or a VM.

Expand All @@ -28,7 +28,7 @@ MongooseIM is brought to you by [Erlang Solutions](https://www.erlang-solutions.

## MongooseIM platform components

<img src="../../MongooseIM_Platform_components.png" alt="MongooseIM platform schema" />
<img src="MongooseIM_Platform_components.png" alt="MongooseIM platform schema" />

### Server-side components

Expand All @@ -51,7 +51,7 @@ We offer a set of additional server-side components:
* iOS, Swift: [Jayme](https://github.com/inaka/Jayme)
* Android, Java: [Retrofit](https://github.com/square/retrofit)

<img src="../../mongoose_top_banner_800.jpeg" alt="MongooseIM platform's mongooses faces" />
<img src="mongoose_top_banner_800.jpeg" alt="MongooseIM platform's mongooses faces" />

## Download packages

Expand Down
4 changes: 2 additions & 2 deletions doc/migrations/3.6.0_3.7.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You can also specify a list of all supported SCRAM-SHA mechanisms with:
`{sasl_mechanisms, [cyrsasl_scram_sha1, cyrsasl_scram_sha224, cyrsasl_scram_sha256, cyrsasl_scram_sha384, cyrsasl_scram_sha512, cyrsasl_scram_sha1_plus, cyrsasl_scram_sha224_plus, cyrsasl_scram_sha256_plus, cyrsasl_scram_sha384_plus, cyrsasl_scram_sha512_plus]}`

Before setting up this configuration, please make sure that the client application is capable of authenticating with a selected set of authentication mechanisms.
For more details please refer to the [authentication](../../Advanced-configuration#authentication) section.
For more details please refer to the [authentication](../configuration/auth.md) section.

### SCRAM password format

Expand Down Expand Up @@ -62,7 +62,7 @@ However, mixing of the old password format with the new authentication mechanism
If you want to use the new password format with a full set of supported SHA hashes, a password change is required to calculate all the new SHA hashes.
Otherwise, please make sure that you provide the right `sasl_mechanism` configuration, where the mechanism you authenticate with is compatible with the password format you store.

For more details related to the new password format, please refer to [authentication](../../Advanced-configuration#authentication) and [SCRAM serialization](../developers-guide/SCRAM-serialization.md) sections.
For more details related to the new password format, please refer to [authentication](../configuration/auth.md) and [SCRAM serialization](../developers-guide/SCRAM-serialization.md) sections.

## Message retraction

Expand Down
2 changes: 1 addition & 1 deletion doc/migrations/3.7.0_4.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Note that a minor [4.0.1](https://github.com/esl/MongooseIM/releases/tag/4.0.1) version has been released with small but important changes to take into account if you're migrating to MongooseIM 4.0.

There is a new [TOML configuration file](../../Advanced-configuration): `mongooseim.toml`.
There is a new [TOML configuration file](../configuration/configuration-files.md): `mongooseim.toml`.
The legacy `mongooseim.cfg` file is still supported as an alternative, but deprecated.

You are advised to rewrite your configuration file in the TOML format.
Expand Down
4 changes: 2 additions & 2 deletions doc/migrations/4.0.0_4.0.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ Please use the `http` backend for `mod_event_pusher`, which is the direct equiva

### Metrics

`mod_http_notification` metric was updated and now is available as [`mod_event_pusher_http`](../../modules/mod_event_pusher_http/#metrics).
For more details on how to configure `mod_event_pusher` with `http` backend, please see [this section](../../modules/mod_event_pusher_http/).
`mod_http_notification` metric was updated and now is available as [`mod_event_pusher_http`](../modules/mod_event_pusher_http.md#metrics).
For more details on how to configure `mod_event_pusher` with `http` backend, please see [this section](../modules/mod_event_pusher_http.md).
22 changes: 11 additions & 11 deletions doc/migrations/4.0.1_4.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,24 @@ Since release 4.1.0, we are no longer supporting the `*.cfg` MongooseIM configur

## Minor changes in the `TOML` config format

* [`mod_bosh.max_pause`](../../modules/mod_bosh/#modulesmod_boshmax_pause) instead of `maxpause`
* [`mod_bosh.max_pause`](../modules/mod_bosh.md#modulesmod_boshmax_pause) instead of `maxpause`

* [`mod_disco.server_info.module`](../../modules/mod_disco/#modulesmod_discoserver_info): the field is optional, no longer required
* [`mod_disco.server_info.module`](../modules/mod_disco.md#modulesmod_discoserver_info): the field is optional, no longer required

* [`mod_global_distrib.connections.advertised_endpoints`](../../modules/mod_global_distrib/#modulesmod_global_distribconnectionsadvertised_endpoints): default not set (`false` is no longer accepted)
* [`mod_global_distrib.connections.advertised_endpoints`](../modules/mod_global_distrib.md#modulesmod_global_distribconnectionsadvertised_endpoints): default not set (`false` is no longer accepted)

* `mod_global_distrib.connections.tls.enabled`: the flag was removed, TLS is enabled by providing the [`cacertfile`](../../modules/mod_global_distrib/#modulesmod_global_distribconnectionstlscacertfile) and [`certfile`](../../modules/mod_global_distrib/#modulesmod_global_distribconnectionstlscertfile) options
* `mod_global_distrib.connections.tls.enabled`: the flag was removed, TLS is enabled by providing the [`cacertfile`](../modules/mod_global_distrib.md#modulesmod_global_distribconnectionstlscacertfile) and [`certfile`](../modules/mod_global_distrib.md#modulesmod_global_distribconnectionstlscertfile) options

* [`mod_http_upload.max_file_size`](../../modules/mod_http_upload/#modulesmod_http_uploadmax_file_size): `undefined` is no longer allowed
* [`mod_http_upload.max_file_size`](../modules/mod_http_upload.md#modulesmod_http_uploadmax_file_size): `undefined` is no longer allowed

* [`mod_mam_meta.user_prefs_store`](../../modules/mod_mam/#modulesmod_mam_metauser_prefs_store): `false` is no longer allowed
* [`mod_mam_meta.user_prefs_store`](../modules/mod_mam.md#modulesmod_mam_metauser_prefs_store): `false` is no longer allowed

* [`mod_muc_light.config_schema`](../../modules/mod_muc_light/#modulesmod_muc_lightconfig_schema): the usage of `value` and `type` fields was replaced with one of the following fields: `string_value`, `integer_value` or `float_value`
* [`mod_muc_light.config_schema`](../modules/mod_muc_light.md#modulesmod_muc_lightconfig_schema): the usage of `value` and `type` fields was replaced with one of the following fields: `string_value`, `integer_value` or `float_value`

* [`mod_muc_log.css_file`](../../modules/mod_muc_log/#modulesmod_muc_logcss_file): the default value was changed from `"false"` to `not set`
* [`mod_muc_log.css_file`](../modules/mod_muc_log.md#modulesmod_muc_logcss_file): the default value was changed from `"false"` to `not set`

* `mod_stream_management`: minor adjustments of [`buffer_max`](../../modules/mod_stream_management/#modulesmod_stream_managementbuffer_max) and [`ack_freq`](../../modules/mod_stream_management/#modulesmod_stream_managementack_freq) options, [`buffer`](../../modules/mod_stream_management/#modulesmod_stream_managementbuffer) and [`ack`](../../modules/mod_stream_management/#modulesmod_stream_managementack) booleans were added
* `mod_stream_management`: minor adjustments of [`buffer_max`](../modules/mod_stream_management.md#modulesmod_stream_managementbuffer_max) and [`ack_freq`](../modules/mod_stream_management.md#modulesmod_stream_managementack_freq) options, [`buffer`](../modules/mod_stream_management.md#modulesmod_stream_managementbuffer) and [`ack`](../modules/mod_stream_management.md#modulesmod_stream_managementack) booleans were added

* [`listen.c2s.tls.ciphers`](../../advanced-configuration/listen/#listenc2stlsciphers), [`listen.http.tls.ciphers`](../../advanced-configuration/listen/#listenhttptlsciphers) and [`outgoing_pools.*.*.connection.tls.ciphers`](../../advanced-configuration/outgoing-connections/#outgoing_poolsconnectiontlsciphers): the ciphers should now be formatted as a specification string
* [`listen.c2s.tls.ciphers`](../configuration/listen.md#listenc2stlsciphers), [`listen.http.tls.ciphers`](../configuration/listen.md#listenhttptlsciphers) and [`outgoing_pools.*.*.connection.tls.ciphers`](../configuration/outgoing-connections.md#outgoing_poolsconnectiontlsciphers): the ciphers should now be formatted as a specification string

* [listen.http.handlers.mod_websockets.ping_rate](../../advanced-configuration/listen/#listenhttphandlersmod_websocketsping_rate): `none` is no longer allowed
* [listen.http.handlers.mod_websockets.ping_rate](../configuration/listen.md#listenhttphandlersmod_websocketsping_rate): `none` is no longer allowed
6 changes: 3 additions & 3 deletions doc/migrations/4.1.0_4.2.0.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Minor changes in the `TOML` config format

* The `pgsql_users_number_estimate` option was moved to [`auth.rdbms.users_number_estimate`](../../authentication-methods/rdbms#authrdbmsusers_number_estimate). The new option supports PostgreSQL and MySQL.
* The `pgsql_users_number_estimate` option was moved to [`auth.rdbms.users_number_estimate`](../authentication-methods/rdbms.md#authrdbmsusers_number_estimate). The new option supports PostgreSQL and MySQL.

## DB migrations

Expand All @@ -23,7 +23,7 @@ ALTER TABLE inbox

### Archived groupchat messages in `mod_mam`

The [`archive_groupchats`](../../modules/mod_mam#modulesmod_mam_metapmarchive_groupchats) option is now set to `false` by default, as documented.
The [`archive_groupchats`](../modules/mod_mam.md#modulesmod_mam_metapmarchive_groupchats) option is now set to `false` by default, as documented.
Before the change, the private message (PM) archive stored incoming groupchat messages as well, contrary to the documentation.
After the upgrade you can manually remove those messages from the database.
For example, when the MUC domain is `muc.localhost` and `rdbms_message_format` has the default value `internal`, one can remove such messages with the following query:
Expand All @@ -37,4 +37,4 @@ This can be a heavy operation and it needs to be done with caution.

### Using `mod_auth_token` with MySQL and MS SQL

The [`mod_auth_token`](../../modules/mod_auth_token) module supports MySQL and MS SQL now. To use this functionality, you need to create the `auth_token` table with the query which you can find in `priv/mysql.sql` and `priv/mssql2012.sql`, respectively.
The [`mod_auth_token`](../modules/mod_auth_token.md) module supports MySQL and MS SQL now. To use this functionality, you need to create the `auth_token` table with the query which you can find in `priv/mysql.sql` and `priv/mssql2012.sql`, respectively.