From 6dff60e7a472cb7a33590d0a56007a26fb4f5776 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Wed, 23 Oct 2024 03:28:18 +0900 Subject: [PATCH] =?UTF-8?q?Fix=20capitalization:=20Rageshake=20=E2=86=92?= =?UTF-8?q?=20rageshake?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Based on https://github.com/matrix-org/rageshake Signed-off-by: Suguru Hirahara --- CHANGELOG.md | 6 +++--- README.md | 2 +- YEAR-IN-REVIEW.md | 2 +- docs/configuring-dns.md | 4 ++-- docs/configuring-playbook-rageshake.md | 14 +++++++------- docs/configuring-playbook.md | 2 +- roles/custom/matrix-rageshake/defaults/main.yml | 2 +- .../matrix-rageshake/templates/config.yml.j2 | 2 +- .../templates/systemd/matrix-rageshake.service.j2 | 2 +- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d03d59b95..84c5b1722 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -972,11 +972,11 @@ We recommend that you follow the guide for [Fronting the integrated reverse-prox # 2023-02-25 -## Rageshake support +## rageshake support -Thanks to [Benjamin Kampmann](https://github.com/gnunicorn), the playbook can now install and configure the [Rageshake](https://github.com/matrix-org/rageshake) bug report server. +Thanks to [Benjamin Kampmann](https://github.com/gnunicorn), the playbook can now install and configure the [rageshake](https://github.com/matrix-org/rageshake) bug report server. -Additional details are available in [Setting up Rageshake](docs/configuring-playbook-rageshake.md). +Additional details are available in [Setting up rageshake](docs/configuring-playbook-rageshake.md). # 2023-02-17 diff --git a/README.md b/README.md index 58fc410d6..50a4cbaea 100644 --- a/README.md +++ b/README.md @@ -155,7 +155,7 @@ Services that help you in administrating and monitoring your Matrix installation | [synapse-admin](https://github.com/Awesome-Technologies/synapse-admin) | x | A web UI tool for administrating users and rooms on your Matrix server | [Link](docs/configuring-playbook-synapse-admin.md) | | Metrics and Graphs | x | Consists of the [Prometheus](https://prometheus.io) time-series database server, the Prometheus [node-exporter](https://prometheus.io/docs/guides/node-exporter/) host metrics exporter, and the [Grafana](https://grafana.com/) web UI | [Link](docs/configuring-playbook-prometheus-grafana.md) | | [Borg](https://borgbackup.org) | x | Backups | [Link](docs/configuring-playbook-backup-borg.md) | -| [Rageshake](https://github.com/matrix-org/rageshake) | x | Bug report server | [Link](docs/configuring-playbook-rageshake.md) | +| [rageshake](https://github.com/matrix-org/rageshake) | x | Bug report server | [Link](docs/configuring-playbook-rageshake.md) | | [synapse-usage-exporter](https://github.com/loelkes/synapse-usage-exporter) | x | Export the usage statistics of a Synapse homeserver to be scraped by Prometheus. | [Link](docs/configuring-playbook-synapse-usage-exporter.md) | ### Misc diff --git a/YEAR-IN-REVIEW.md b/YEAR-IN-REVIEW.md index b1b7c70c5..3c756e81b 100644 --- a/YEAR-IN-REVIEW.md +++ b/YEAR-IN-REVIEW.md @@ -33,7 +33,7 @@ A few other **major components and changes** landed in 2023: * (2023-02-10) The [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation tool (successor to [Mjolnir](https://github.com/matrix-org/mjolnir)), thanks to a PR by [FSG-Cat](https://github.com/FSG-Cat) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#draupnir-moderation-tool-bot-support)) * (2023-02-10) [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) to add Matrix Authentication Support to our Jitsi setup, thanks to a PR by [Jakob S.](https://github.com/jakicoll) from [zakk gGmbH](https://github.com/zakk-it) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#matrix-authentication-support-for-jitsi)) -* (2023-02-25) The [Rageshake](https://github.com/matrix-org/rageshake) bug report server, thanks to a PR by [Benjamin Kampmann](https://github.com/gnunicorn) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#rageshake-support)) +* (2023-02-25) The [rageshake](https://github.com/matrix-org/rageshake) bug report server, thanks to a PR by [Benjamin Kampmann](https://github.com/gnunicorn) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#rageshake-support)) * (2023-03-07) [Sliding Sync proxy](https://github.com/matrix-org/sliding-sync) (currently a necessary component for [Element X](https://element.io/labs/element-x) to work), thanks to: [Benjamin Kampmann](https://github.com/gnunicorn) and [FSG-Cat](https://github.com/FSG-Cat) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#sliding-sync-proxy-element-x-support)) * (2023-03-12) synapse-auto-compressor to periodically and automatically run [rust-synapse-compress-state](https://github.com/matrix-org/rust-synapse-compress-state), thanks to a PR by [Aine](https://gitlab.com/etke.cc) from [etke.cc](https://etke.cc/) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#synapse-auto-compressor-support)) * (2023-07-17) [matrix-media-repo](https://github.com/turt2live/matrix-media-repo),  thanks to a PR by [Michael Hollister](https://github.com/Michael-Hollister) from [FUTO](https://www.futo.org/), the creators of the [Circles app](https://circu.li/) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#matrix-media-repo-support)) diff --git a/docs/configuring-dns.md b/docs/configuring-dns.md index e027b7f1b..605da4182 100644 --- a/docs/configuring-dns.md +++ b/docs/configuring-dns.md @@ -43,7 +43,7 @@ When you're done configuring DNS, proceed to [Configuring the playbook](configur | [SchildiChat](configuring-playbook-client-schildichat.md) web client | CNAME | `schildichat` | - | - | - | `matrix.example.com` | | [wsproxy](configuring-playbook-bridge-mautrix-wsproxy.md) sms bridge | CNAME | `wsproxy` | - | - | - | `matrix.example.com` | | [Buscarron](configuring-playbook-bot-buscarron.md) helpdesk bot | CNAME | `buscarron` | - | - | - | `matrix.example.com` | -| [Rageshake](docs/configuring-playbook-rageshake.md) bug report server | CNAME | `rageshake` | - | - | - | `matrix.example.com` | +| [rageshake](docs/configuring-playbook-rageshake.md) bug report server | CNAME | `rageshake` | - | - | - | `matrix.example.com` | | [Postmoogle](configuring-playbook-bot-postmoogle.md)/[Email2Matrix](configuring-playbook-email2matrix.md) email bridges | MX | `matrix` | 10 | 0 | - | `matrix.example.com` | | [Postmoogle](configuring-playbook-bot-postmoogle.md) email bridge | TXT | `matrix` | - | - | - | `v=spf1 ip4: -all` | | [Postmoogle](configuring-playbook-bot-postmoogle.md) email bridge | TXT | `_dmarc.matrix` | - | - | - | `v=DMARC1; p=quarantine;` | @@ -81,7 +81,7 @@ The `wsproxy.example.com` subdomain may be necessary, because this playbook coul The `buscarron.example.com` subdomain may be necessary, because this playbook could install the [buscarron](https://github.com/etkecc/buscarron) bot. The installation of buscarron is disabled by default, it is not a core required component. To learn how to install it, see our [configuring buscarron guide](configuring-playbook-bot-buscarron.md). If you do not wish to set up buscarron, feel free to skip the `buscarron.example.com` DNS record. -The `rageshake.example.com` subdomain may be necessary, because this playbook could install the [rageshake](https://github.com/matrix-org/rageshake) bug report server. The installation of Rageshake is disabled by default, it is not a core required component. To learn how to install it, see our [configuring Rageshake guide](configuring-playbook-rageshake.md). If you do not wish to set up Rageshake, feel free to skip the `rageshake.example.com` DNS record. +The `rageshake.example.com` subdomain may be necessary, because this playbook could install the [rageshake](https://github.com/matrix-org/rageshake) bug report server. The installation of rageshake is disabled by default, it is not a core required component. To learn how to install it, see our [configuring rageshake guide](configuring-playbook-rageshake.md). If you do not wish to set up rageshake, feel free to skip the `rageshake.example.com` DNS record. ## `_matrix-identity._tcp` SRV record setup diff --git a/docs/configuring-playbook-rageshake.md b/docs/configuring-playbook-rageshake.md index 154949499..e43114459 100644 --- a/docs/configuring-playbook-rageshake.md +++ b/docs/configuring-playbook-rageshake.md @@ -1,4 +1,4 @@ -# Setting up Rageshake (optional) +# Setting up rageshake (optional) The playbook can install and configure the [rageshake](https://github.com/matrix-org/rageshake) bug report server for you. @@ -6,13 +6,13 @@ This is useful if you're developing your own applications and would like to coll ## Adjusting the playbook configuration -To enable Rageshake, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: +To enable rageshake, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: ```yaml matrix_rageshake_enabled: true ``` -Rageshake has various options which don't have dedicated Ansible variables. You can see the full list of options in the [`rageshake.sample.yaml` file](https://github.com/matrix-org/rageshake/blob/master/rageshake.sample.yaml). +rageshake has various options which don't have dedicated Ansible variables. You can see the full list of options in the [`rageshake.sample.yaml` file](https://github.com/matrix-org/rageshake/blob/master/rageshake.sample.yaml). To set these, you can make use of the `matrix_rageshake_configuration_extension_yaml` variable like this: @@ -24,9 +24,9 @@ matrix_rageshake_configuration_extension_yaml: | my-app: octocat/HelloWorld ``` -### Adjusting the Rageshake URL +### Adjusting the rageshake URL -By default, this playbook installs Rageshake on the `rageshake.` subdomain (`rageshake.example.com`) and requires you to [adjust your DNS records](#adjusting-dns-records). +By default, this playbook installs rageshake on the `rageshake.` subdomain (`rageshake.example.com`) and requires you to [adjust your DNS records](#adjusting-dns-records). By tweaking the `matrix_rageshake_hostname` and `matrix_rageshake_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one. @@ -34,7 +34,7 @@ Example additional configuration for your `inventory/host_vars/matrix.example.co ```yaml # Switch to the domain used for Matrix services (`matrix.example.com`), -# so we won't need to add additional DNS records for Rageshake. +# so we won't need to add additional DNS records for rageshake. matrix_rageshake_hostname: "{{ matrix_server_fqn_matrix }}" # Expose under the /rageshake subpath @@ -43,7 +43,7 @@ matrix_rageshake_path_prefix: /rageshake ## Adjusting DNS records -Once you've decided on the domain and path, **you may need to adjust your DNS** records to point the Rageshake domain to the Matrix server. +Once you've decided on the domain and path, **you may need to adjust your DNS** records to point the rageshake domain to the Matrix server. By default, you will need to create a CNAME record for `rageshake`. See [Configuring DNS](configuring-dns.md) for details about DNS changes. diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index 95817bb4f..f85201e26 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -232,6 +232,6 @@ When you're done with all the configuration you'd like to do, continue with [Ins - [Setting up a Cactus Comments server](configuring-playbook-cactus-comments.md) - a federated comment system built on Matrix (optional) -- [Setting up the Rageshake bug report server](configuring-playbook-rageshake.md) (optional) +- [Setting up the rageshake bug report server](configuring-playbook-rageshake.md) (optional) - [Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver](configuring-playbook-alertmanager-receiver.md) (optional) diff --git a/roles/custom/matrix-rageshake/defaults/main.yml b/roles/custom/matrix-rageshake/defaults/main.yml index bbd271ec0..77caeab1b 100644 --- a/roles/custom/matrix-rageshake/defaults/main.yml +++ b/roles/custom/matrix-rageshake/defaults/main.yml @@ -88,7 +88,7 @@ matrix_rageshake_systemd_wanted_services_list: [] matrix_rageshake_config_api_prefix: "{{ matrix_rageshake_scheme }}://{{ matrix_rageshake_hostname }}{{ matrix_rageshake_path_prefix }}{{ '' if matrix_rageshake_path_prefix == '/' else '/' }}api/" -# Default Rageshake configuration template which covers the generic use case. +# Default rageshake configuration template which covers the generic use case. # You can customize it by controlling the various variables inside it. # # For a more advanced customization, you can extend the default (see `matrix_rageshake_configuration_extension_yaml`) diff --git a/roles/custom/matrix-rageshake/templates/config.yml.j2 b/roles/custom/matrix-rageshake/templates/config.yml.j2 index 6b0c2664d..6790f2938 100644 --- a/roles/custom/matrix-rageshake/templates/config.yml.j2 +++ b/roles/custom/matrix-rageshake/templates/config.yml.j2 @@ -1,4 +1,4 @@ -# Default configuration for Rageshake. +# Default configuration for rageshake. # To extend it, use `matrix_rageshake_configuration_extension_yaml`. api_prefix: {{ matrix_rageshake_config_api_prefix | to_json }} diff --git a/roles/custom/matrix-rageshake/templates/systemd/matrix-rageshake.service.j2 b/roles/custom/matrix-rageshake/templates/systemd/matrix-rageshake.service.j2 index 53857b53c..9abaf3db5 100644 --- a/roles/custom/matrix-rageshake/templates/systemd/matrix-rageshake.service.j2 +++ b/roles/custom/matrix-rageshake/templates/systemd/matrix-rageshake.service.j2 @@ -1,6 +1,6 @@ #jinja2: lstrip_blocks: "True" [Unit] -Description=Matrix Rageshake Service +Description=Matrix rageshake Service {% for service in matrix_rageshake_systemd_required_services_list %} Requires={{ service }} After={{ service }}