finallycoffee/matrix-docker-ansible-deploy
5
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix capitalization: Rageshake → rageshake

Browse Source 
Based on https://github.com/matrix-org/rageshake

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara
2024-10-23 03:28:18 +09:00
parent 70e4320eda
commit 6dff60e7a4
9 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/configuring-playbook-rageshake.md
View File

@ -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.