Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>pull/3601/head
| @@ -357,7 +357,7 @@ You can configure the **initial values** for these via Ansible, via the `matrix_ | |||||
| Example **additional** `vars.yml` configuration: | Example **additional** `vars.yml` configuration: | ||||
| ```yml | ```yml | ||||
| # NOTE: these are initial defaults for the bot's global configuration. | |||||
| # Note: these are initial defaults for the bot's global configuration. | |||||
| # As such, changing any of these values subsequently has no effect on the bot's behavior. | # As such, changing any of these values subsequently has no effect on the bot's behavior. | ||||
| # Once initially configured, the global configuration is managed via bot commands, not via Ansible. | # Once initially configured, the global configuration is managed via bot commands, not via Ansible. | ||||
| @@ -79,7 +79,7 @@ To use the bot, invite the `@bot.buscarron:DOMAIN` to the room you specified in | |||||
| </form> | </form> | ||||
| ``` | ``` | ||||
| **NOTE**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if: | |||||
| **Note**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if: | |||||
| - if you hit the homepage (HTTP `GET` request to `/`) | - if you hit the homepage (HTTP `GET` request to `/`) | ||||
| - if you submit a form to the wrong URL (`POST` request to `/non-existing-form`) | - if you submit a form to the wrong URL (`POST` request to `/non-existing-form`) | ||||
| @@ -2,7 +2,7 @@ | |||||
| The playbook can install and configure [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) for you. `matrix-appservice-kakaotalk` is a bridge to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG) based on [node-kakao](https://github.com/storycraft/node-kakao) (now unmaintained) and some [mautrix-facebook](https://github.com/mautrix/facebook) code. | The playbook can install and configure [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) for you. `matrix-appservice-kakaotalk` is a bridge to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG) based on [node-kakao](https://github.com/storycraft/node-kakao) (now unmaintained) and some [mautrix-facebook](https://github.com/mautrix/facebook) code. | ||||
| **NOTE**: there have been recent reports (~2022-09-16) that **using this bridge may get your account banned**. | |||||
| **Note**: there have been recent reports (~2022-09-16) that **using this bridge may get your account banned**. | |||||
| See the project's [documentation](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) to learn what it does and why it might be useful to you. | See the project's [documentation](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) to learn what it does and why it might be useful to you. | ||||
| @@ -2,7 +2,7 @@ | |||||
| By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Conduit](https://conduit.rs). | By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Conduit](https://conduit.rs). | ||||
| **NOTES**: | |||||
| **Notes**: | |||||
| - **You can't switch an existing Matrix server's implementation** (e.g. Synapse -> Conduit). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet. | - **You can't switch an existing Matrix server's implementation** (e.g. Synapse -> Conduit). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet. | ||||
| @@ -2,7 +2,7 @@ | |||||
| By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Dendrite](https://github.com/matrix-org/dendrite). | By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Dendrite](https://github.com/matrix-org/dendrite). | ||||
| **NOTES**: | |||||
| **Notes**: | |||||
| - **You can't switch an existing Matrix server's implementation** (e.g. Synapse -> Dendrite). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet. | - **You can't switch an existing Matrix server's implementation** (e.g. Synapse -> Dendrite). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet. | ||||
| @@ -29,4 +29,3 @@ To use Dendrite, you **generally** need the following additional `vars.yml` conf | |||||
| ```yaml | ```yaml | ||||
| matrix_homeserver_implementation: dendrite | matrix_homeserver_implementation: dendrite | ||||
| ``` | ``` | ||||
| @@ -5,7 +5,7 @@ If that's alright, you can skip this. | |||||
| If you'd like to use an external PostgreSQL server that you manage, you can edit your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`). | If you'd like to use an external PostgreSQL server that you manage, you can edit your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`). | ||||
| **NOTE**: using **an external Postgres server is currently [not very seamless](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1682#issuecomment-1061461683) when it comes to enabling various other playbook services** - you will need to create a new database/credentials for each service and to point each service to its corresponding database using custom `vars.yml` configuration. **For the best experience with the playbook, stick to using the integrated Postgres server**. | |||||
| **Note**: using **an external Postgres server is currently [not very seamless](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1682#issuecomment-1061461683) when it comes to enabling various other playbook services** - you will need to create a new database/credentials for each service and to point each service to its corresponding database using custom `vars.yml` configuration. **For the best experience with the playbook, stick to using the integrated Postgres server**. | |||||
| If you'd like to use an external Postgres server, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file (adapt to your needs): | If you'd like to use an external Postgres server, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file (adapt to your needs): | ||||
| @@ -6,7 +6,7 @@ This adds [prometheus-nginxlog-exporter](https://github.com/martin-helmich/prome | |||||
| It will collect access logs from various nginx reverse-proxies which may be used internally (e.g. `matrix-synapse-reverse-proxy-companion`, if Synapse workers are enabled) and will make them available at a Prometheus-compatible `/metrics` endpoint. | It will collect access logs from various nginx reverse-proxies which may be used internally (e.g. `matrix-synapse-reverse-proxy-companion`, if Synapse workers are enabled) and will make them available at a Prometheus-compatible `/metrics` endpoint. | ||||
| **NOTE**: nginx is only used internally by this Ansible playbook. With Traefik being our default reverse-proxy, collecting nginx metrics is less relevant. | |||||
| **Note**: nginx is only used internally by this Ansible playbook. With Traefik being our default reverse-proxy, collecting nginx metrics is less relevant. | |||||
| To make use of this, you need to install [Prometheus](./configuring-playbook-prometheus-grafana.md) either via the playbook or externally. When using an external Prometheus, configuration adjustments are necessary - see [Save metrics on an external Prometheus server](#save-metrics-on-an-external-prometheus-server). | To make use of this, you need to install [Prometheus](./configuring-playbook-prometheus-grafana.md) either via the playbook or externally. When using an external Prometheus, configuration adjustments are necessary - see [Save metrics on an external Prometheus server](#save-metrics-on-an-external-prometheus-server). | ||||
| @@ -65,7 +65,7 @@ You'll need an Amazon S3 bucket and some IAM user credentials (access key + secr | |||||
| } | } | ||||
| ``` | ``` | ||||
| **NOTE**: This policy needs to be attached to an IAM user created from the **Security Credentials** menu. This is not a **Bucket Policy**. | |||||
| **Note**: This policy needs to be attached to an IAM user created from the **Security Credentials** menu. This is not a **Bucket Policy**. | |||||
| ## Backblaze B2 | ## Backblaze B2 | ||||
| @@ -10,7 +10,7 @@ Element X iOS is [available on TestFlight](https://testflight.apple.com/join/uZb | |||||
| Element X Android is [available on the Github Releases page](https://github.com/element-hq/element-x-android/releases). | Element X Android is [available on the Github Releases page](https://github.com/element-hq/element-x-android/releases). | ||||
| **NOTE**: The sliding-sync proxy is **not required** when using the **Conduit homeserver**. Starting from version `0.6.0` Conduit has native support for some sliding sync features. If there are issues with the native implementation, you might have a better experience when enabling the sliding-sync proxy anyway. | |||||
| **Note**: The sliding-sync proxy is **not required** when using the **Conduit homeserver**. Starting from version `0.6.0` Conduit has native support for some sliding sync features. If there are issues with the native implementation, you might have a better experience when enabling the sliding-sync proxy anyway. | |||||
| ## Decide on a domain and path | ## Decide on a domain and path | ||||
| @@ -5,7 +5,7 @@ The playbook can install and configure [synapse-auto-invite-accept](https://gith | |||||
| See that project's [documentation](https://github.com/matrix-org/synapse-auto-accept-invite) to learn what it does and why it might be useful to you. | See that project's [documentation](https://github.com/matrix-org/synapse-auto-accept-invite) to learn what it does and why it might be useful to you. | ||||
| In short, it automatically accepts room invites. You can specify that only 1:1 room invites are auto-accepted. Defaults to false if not specified. | In short, it automatically accepts room invites. You can specify that only 1:1 room invites are auto-accepted. Defaults to false if not specified. | ||||
| **NOTE**: Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.109.0), the same feature [has been merged](https://github.com/element-hq/synapse/pull/17147) into Synapse (see the [Native alternative](#native-alternative) section below). You'd better use the native feature, instead of the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) 3rd party module. | |||||
| **Note**: Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.109.0), the same feature [has been merged](https://github.com/element-hq/synapse/pull/17147) into Synapse (see the [Native alternative](#native-alternative) section below). You'd better use the native feature, instead of the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) 3rd party module. | |||||
| ## Configuration | ## Configuration | ||||
| @@ -35,7 +35,7 @@ Otherwise, you can decide to go against the default for this playbook, and inste | |||||
| ## Server Delegation via a DNS SRV record (advanced) | ## Server Delegation via a DNS SRV record (advanced) | ||||
| **NOTE**: doing Server Delegation via a DNS SRV record is a more **advanced** way to do it and is not the default for this playbook. This is usually **much more complicated** to set up, so **we don't recommend it**. If you're not an experience sysadmin, you'd better stay away from this. | |||||
| **Note**: doing Server Delegation via a DNS SRV record is a more **advanced** way to do it and is not the default for this playbook. This is usually **much more complicated** to set up, so **we don't recommend it**. If you're not an experience sysadmin, you'd better stay away from this. | |||||
| As per the [Server-Server spec](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery), it's possible to do Server Delegation using only a SRV record (without a `/.well-known/matrix/server` file). | As per the [Server-Server spec](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery), it's possible to do Server Delegation using only a SRV record (without a `/.well-known/matrix/server` file). | ||||
| @@ -16,7 +16,7 @@ The up-to-date list can be accessed on [traefik's documentation](https://doc.tra | |||||
| ## The changes | ## The changes | ||||
| **NOTE**: the changes below instruct you how to do this for a basic Synapse installation. You will need to adapt the variable name and the content of the labels: | |||||
| **Note**: the changes below instruct you how to do this for a basic Synapse installation. You will need to adapt the variable name and the content of the labels: | |||||
| - if you're using another homeserver implementation (e.g. [Conduit](./configuring-playbook-conduit.md) or [Dendrite](./configuring-playbook-dendrite.md)) | - if you're using another homeserver implementation (e.g. [Conduit](./configuring-playbook-conduit.md) or [Dendrite](./configuring-playbook-dendrite.md)) | ||||
| - if you're using [Synapse with workers enabled](./configuring-playbook-synapse.md#load-balancing-with-workers) (`matrix_synapse_workers_enabled: true`). In that case, it's actually the `matrix-synapse-reverse-proxy-companion` service which has Traefik labels attached | - if you're using [Synapse with workers enabled](./configuring-playbook-synapse.md#load-balancing-with-workers) (`matrix_synapse_workers_enabled: true`). In that case, it's actually the `matrix-synapse-reverse-proxy-companion` service which has Traefik labels attached | ||||
| @@ -73,6 +73,6 @@ | |||||
| devture_playbook_runtime_messages_list | default([]) | devture_playbook_runtime_messages_list | default([]) | ||||
| + | + | ||||
| [ | [ | ||||
| "NOTE: Your appservice-irc database files have been imported into Postgres. The original database files have been moved from `{{ matrix_appservice_irc_data_path }}/*.db` to `{{ matrix_appservice_irc_data_path }}/*.db.backup`. When you've confirmed that the import went well and everything works, you should be able to safely delete these files." | |||||
| "Note: Your appservice-irc database files have been imported into Postgres. The original database files have been moved from `{{ matrix_appservice_irc_data_path }}/*.db` to `{{ matrix_appservice_irc_data_path }}/*.db.backup`. When you've confirmed that the import went well and everything works, you should be able to safely delete these files." | |||||
| ] | ] | ||||
| }} | }} | ||||
| @@ -69,6 +69,6 @@ | |||||
| devture_playbook_runtime_messages_list | default([]) | devture_playbook_runtime_messages_list | default([]) | ||||
| + | + | ||||
| [ | [ | ||||
| "NOTE: Your appservice-slack database files have been imported into Postgres. The original database files have been moved from `{{ matrix_appservice_slack_data_path }}/*.db` to `{{ matrix_appservice_slack_data_path }}/*.db.backup`. When you've confirmed that the import went well and everything works, you should be able to safely delete these files." | |||||
| "Note: Your appservice-slack database files have been imported into Postgres. The original database files have been moved from `{{ matrix_appservice_slack_data_path }}/*.db` to `{{ matrix_appservice_slack_data_path }}/*.db.backup`. When you've confirmed that the import went well and everything works, you should be able to safely delete these files." | |||||
| ] | ] | ||||
| }} | }} | ||||
| @@ -34,6 +34,6 @@ | |||||
| devture_playbook_runtime_messages_list | default([]) | devture_playbook_runtime_messages_list | default([]) | ||||
| + | + | ||||
| [ | [ | ||||
| "NOTE: Your mautrix-facebook bridge is still on SQLite and on the last version that supported it, before support was dropped. Support has been subsequently re-added in v0.3.2, so we advise you to upgrade (by removing your `matrix_mautrix_facebook_docker_image` definition from vars.yml)" | |||||
| "Note: Your mautrix-facebook bridge is still on SQLite and on the last version that supported it, before support was dropped. Support has been subsequently re-added in v0.3.2, so we advise you to upgrade (by removing your `matrix_mautrix_facebook_docker_image` definition from vars.yml)" | |||||
| ] | ] | ||||
| }} | }} | ||||
| @@ -7,7 +7,7 @@ | |||||
| ansible.builtin.fail: | ansible.builtin.fail: | ||||
| msg: "To use the external IP address auto-detection feature, you need to set matrix_coturn_turn_external_ip_address_auto_detection_echoip_service_url" | msg: "To use the external IP address auto-detection feature, you need to set matrix_coturn_turn_external_ip_address_auto_detection_echoip_service_url" | ||||
| # NOTE: | |||||
| # Note: | |||||
| # `ansible.builtin.uri` does not provide a way to configure whether IPv4 or IPv6 is used. | # `ansible.builtin.uri` does not provide a way to configure whether IPv4 or IPv6 is used. | ||||
| # Luckily, the default instance we use does not define AAAA records for now, so it's always IPv4. | # Luckily, the default instance we use does not define AAAA records for now, so it's always IPv4. | ||||
| - name: Fetch IP address information from EchoIP service | - name: Fetch IP address information from EchoIP service | ||||
| @@ -87,7 +87,7 @@ matrix_prometheus_nginxlog_exporter_container_http_host_bind_port: '' | |||||
| # Controls whether the matrix-prometheus_nginxlog_exporter container exposes its SYSLOG port (udp/6514 in the container). | # Controls whether the matrix-prometheus_nginxlog_exporter container exposes its SYSLOG port (udp/6514 in the container). | ||||
| # | # | ||||
| # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:6514"), or empty string to not expose. | # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:6514"), or empty string to not expose. | ||||
| # NOTE: is an UDP connection! | |||||
| # Note: is an UDP connection! | |||||
| matrix_prometheus_nginxlog_exporter_container_syslog_host_bind_port: '' | matrix_prometheus_nginxlog_exporter_container_syslog_host_bind_port: '' | ||||
| matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags: "{{ matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_auto + matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_custom }}" | matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags: "{{ matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_auto + matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_custom }}" | ||||
| @@ -1581,7 +1581,7 @@ auto_accept_invites: | |||||
| enable_metrics: {{ matrix_synapse_metrics_enabled|to_json }} | enable_metrics: {{ matrix_synapse_metrics_enabled|to_json }} | ||||
| # Enable sentry integration | # Enable sentry integration | ||||
| # NOTE: While attempts are made to ensure that the logs don't contain | |||||
| # Note: While attempts are made to ensure that the logs don't contain | |||||
| # any sensitive information, this cannot be guaranteed. By enabling | # any sensitive information, this cannot be guaranteed. By enabling | ||||
| # this option the sentry server may therefore receive sensitive | # this option the sentry server may therefore receive sensitive | ||||
| # information, and it in turn may then diseminate sensitive information | # information, and it in turn may then diseminate sensitive information | ||||