Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>pull/3628/head
| @@ -93,7 +93,7 @@ If `matrix_admin` is already configured in your `vars.yml` configuration, you ca | |||||
| # | # | ||||
| # .. unless you've made yourself an admin of all bots/bridges like this: | # .. unless you've made yourself an admin of all bots/bridges like this: | ||||
| # | # | ||||
| # matrix_admin: '@yourAdminAccount:domain.com' | |||||
| # matrix_admin: '@yourAdminAccount:example.com' | |||||
| ``` | ``` | ||||
| ### 👥 Initial users configuration | ### 👥 Initial users configuration | ||||
| @@ -39,11 +39,11 @@ matrix_bot_postmoogle_password: PASSWORD_FOR_THE_BOT | |||||
| # Uncomment to add one or more admins to this bridge: | # Uncomment to add one or more admins to this bridge: | ||||
| # | # | ||||
| # matrix_bot_postmoogle_admins: | # matrix_bot_postmoogle_admins: | ||||
| # - '@yourAdminAccount:domain.com' | |||||
| # - '@yourAdminAccount:example.com' | |||||
| # | # | ||||
| # .. unless you've made yourself an admin of all bots/bridges like this: | # .. unless you've made yourself an admin of all bots/bridges like this: | ||||
| # | # | ||||
| # matrix_admin: '@yourAdminAccount:domain.com' | |||||
| # matrix_admin: '@yourAdminAccount:example.com' | |||||
| ``` | ``` | ||||
| ### DNS | ### DNS | ||||
| @@ -25,11 +25,11 @@ You don't just use the "email" protocols (SMTP, POP3, IMAP) directly though. The | |||||
| In the world of the Matrix chat protocol, there are various client programs. The first and currently most full-featured one is called [Element](https://element.io/) (used to be called Riot.im and Vector.im in the past). There are [many other clients](https://matrix.org/clients/). You can switch clients as much as you want until you find the one that is right for you on a given platform (you may use Element on your desktop, but Fluffychat on your phone, etc). | In the world of the Matrix chat protocol, there are various client programs. The first and currently most full-featured one is called [Element](https://element.io/) (used to be called Riot.im and Vector.im in the past). There are [many other clients](https://matrix.org/clients/). You can switch clients as much as you want until you find the one that is right for you on a given platform (you may use Element on your desktop, but Fluffychat on your phone, etc). | ||||
| Matrix is also like email due to the fact that there are many servers around the world which can all talk to each other (you can send email from `@gmail.com` addresses to `@yahoo.com` and `@hotmail.com` addresses). It's the same with Matrix (`@bob:his-domain.com` can talk to `@alice:her-domain.org`). | |||||
| Matrix is also like email due to the fact that there are many servers around the world which can all talk to each other (you can send email from `@gmail.com` addresses to `@yahoo.com` and `@hotmail.com` addresses). It's the same with Matrix (`@bob:example.com` can talk to `@alice:example.org`). | |||||
| If someone else is hosting your Matrix server (you being `@user:matrix.org` or some other public server like this), all you need is a Matrix client program, like Element. | If someone else is hosting your Matrix server (you being `@user:matrix.org` or some other public server like this), all you need is a Matrix client program, like Element. | ||||
| If you'd like to host your own server (you being `@user:your-own-domain.com`), you'd need to set up a Matrix server program, like Synapse. | |||||
| If you'd like to host your own server (you being `@user:example.com`), you'd need to set up a Matrix server program, like Synapse. | |||||
| In short: | In short: | ||||
| @@ -57,7 +57,7 @@ There are 3 ways to get into Matrix, depending on your technical ability and nee | |||||
| - **using some other server** - instead of using the largest public server (`matrix.org`), you can use another public one. Here's a [list of public Matrix servers](https://joinmatrix.org/servers/) to choose from. Again, you download [Element](https://element.io) or [some other client](https://matrix.org/clients/) of your choosing and adjust the homeserver URL during login. | - **using some other server** - instead of using the largest public server (`matrix.org`), you can use another public one. Here's a [list of public Matrix servers](https://joinmatrix.org/servers/) to choose from. Again, you download [Element](https://element.io) or [some other client](https://matrix.org/clients/) of your choosing and adjust the homeserver URL during login. | ||||
| - **using your own server** - running your own server puts you in ultimate control of your data. It also lets you have your own user identifiers (e.g. `@bob:your-domain.com`). See [How do I set up my own Matrix server](#how-do-i-set-up-my-own-matrix-server). | |||||
| - **using your own server** - running your own server puts you in ultimate control of your data. It also lets you have your own user identifiers (e.g. `@bob:example.com`). See [How do I set up my own Matrix server](#how-do-i-set-up-my-own-matrix-server). | |||||
| ### How do I set up my own Matrix server? | ### How do I set up my own Matrix server? | ||||
| @@ -39,7 +39,7 @@ This requires an [access token](obtaining-access-tokens.md) from a server admin | |||||
| If you didn't make your account a server admin when you created it, you can learn how to switch it now by reading about it in [Adding/Removing Administrator privileges to an existing Synapse user](registering-users.md#addingremoving-administrator-privileges-to-an-existing-synapse-user). | If you didn't make your account a server admin when you created it, you can learn how to switch it now by reading about it in [Adding/Removing Administrator privileges to an existing Synapse user](registering-users.md#addingremoving-administrator-privileges-to-an-existing-synapse-user). | ||||
| ### Example: | ### Example: | ||||
| To set @user:domain.com's password to `correct_horse_battery_staple` you could use this curl command: | |||||
| To set @user:example.com's password to `correct_horse_battery_staple` you could use this curl command: | |||||
| ``` | ``` | ||||
| curl -XPOST -d '{ "new_password": "correct_horse_battery_staple" }' "https://matrix.<domain>/_matrix/client/r0/admin/reset_password/@user:domain.com?access_token=MDA...this_is_my_access_token | |||||
| curl -XPOST -d '{ "new_password": "correct_horse_battery_staple" }' "https://matrix.example.com/_matrix/client/r0/admin/reset_password/@user:example.com?access_token=MDA...this_is_my_access_token | |||||
| ``` | ``` | ||||
| @@ -14,4 +14,4 @@ Copy the [matrix.conf](matrix.conf) file to your nginx server's filesystem, modi | |||||
| This configuration **disables SSL certificate retrieval**, so you will **need to obtain SSL certificates manually** (e.g. by using [certbot](https://certbot.eff.org/)) and set the appropriate path in `matrix.conf`. In the example nginx configuration, a single certificate is used for all subdomains (`matrix.DOMAIN`, `element.DOMAIN`, etc.). For your setup, may wish to change this and use separate `server` blocks and separate certificate files for each host. | This configuration **disables SSL certificate retrieval**, so you will **need to obtain SSL certificates manually** (e.g. by using [certbot](https://certbot.eff.org/)) and set the appropriate path in `matrix.conf`. In the example nginx configuration, a single certificate is used for all subdomains (`matrix.DOMAIN`, `element.DOMAIN`, etc.). For your setup, may wish to change this and use separate `server` blocks and separate certificate files for each host. | ||||
| Also note that your copy of the `matrix.conf` file has to be adapted to whatever services you are using. For example, remove `element.domain.com` from the `server_name` list if you don't use [Element](../../../docs/configuring-playbook-client-element.md) web client or add `dimension.domain.com` to it if you do use the [Dimension](../../../docs/configuring-playbook-dimension.md) integration manager. | |||||
| Also note that your copy of the `matrix.conf` file has to be adapted to whatever services you are using. For example, remove `element.example.com` from the `server_name` list if you don't use [Element](../../../docs/configuring-playbook-client-element.md) web client or add `dimension.example.com` to it if you do use the [Dimension](../../../docs/configuring-playbook-dimension.md) integration manager. | |||||
| @@ -73,7 +73,7 @@ matrix_bot_chatgpt_matrix_default_prefix_reply: false # MATRIX_DEFAULT_PREFIX_R | |||||
| # Matrix Access Control (optional) | # Matrix Access Control (optional) | ||||
| # | # | ||||
| # Lists of space-separated entries. Example: | # Lists of space-separated entries. Example: | ||||
| # matrix_bot_chatgpt_matrix_whitelist: ":{{ matrix_domain }} :second-domain.com :third-domain.com" | |||||
| # matrix_bot_chatgpt_matrix_whitelist: ":{{ matrix_domain }} :second-example.com :third-example.com" | |||||
| matrix_bot_chatgpt_matrix_blacklist: '' | matrix_bot_chatgpt_matrix_blacklist: '' | ||||
| matrix_bot_chatgpt_matrix_whitelist: ':{{ matrix_domain }}' | matrix_bot_chatgpt_matrix_whitelist: ':{{ matrix_domain }}' | ||||
| @@ -213,7 +213,7 @@ client_api: | |||||
| threshold: {{ matrix_dendrite_client_api_rate_limiting_threshold | to_json }} | threshold: {{ matrix_dendrite_client_api_rate_limiting_threshold | to_json }} | ||||
| cooloff_ms: {{ matrix_dendrite_client_api_rate_limiting_cooloff_ms | to_json }} | cooloff_ms: {{ matrix_dendrite_client_api_rate_limiting_cooloff_ms | to_json }} | ||||
| exempt_user_ids: | exempt_user_ids: | ||||
| # - "@user:domain.com" | |||||
| # - "@user:example.com" | |||||
| # Configuration for the Federation API. | # Configuration for the Federation API. | ||||
| federation_api: | federation_api: | ||||
| @@ -16,7 +16,7 @@ matrix_dimension_path_prefix: / | |||||
| # For information on how to acquire an access token, visit https://t2bot.io/docs/access_tokens | # For information on how to acquire an access token, visit https://t2bot.io/docs/access_tokens | ||||
| matrix_dimension_access_token: "" | matrix_dimension_access_token: "" | ||||
| # Users in form: ['@user1:domain.com', '@user2:domain.com'] | |||||
| # Users in form: ['@user1:example.com', '@user2:example.com'] | |||||
| matrix_dimension_admins: [] | matrix_dimension_admins: [] | ||||
| # Whether to allow Dimension widgets serve websites with invalid or self signed SSL certificates | # Whether to allow Dimension widgets serve websites with invalid or self signed SSL certificates | ||||
| @@ -691,7 +691,7 @@ tls_private_key_path: {{ matrix_synapse_tls_private_key_path|to_json }} | |||||
| # | # | ||||
| #federation_certificate_verification_whitelist: | #federation_certificate_verification_whitelist: | ||||
| # - lon.example.com | # - lon.example.com | ||||
| # - "*.domain.com" | |||||
| # - "*.example.com" | |||||
| # - "*.onion" | # - "*.onion" | ||||
| # List of custom certificate authorities for federation traffic. | # List of custom certificate authorities for federation traffic. | ||||