bc1849d7ff
* Replace "just run-tags install-all/setup-all,start" with "just install-all/setup-all" Thanks to the tip by Slavi that the overhead of ensure-matrix-users-created is negligible. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit installing instructions - Move the anchor links to docs/just.md - Add note about running "ensure-matrix-users-created" tags, if ansible-playbook's tags not "setup-all,ensure-matrix-users-created,start", ie. either "setup-all,start", "setup-email2matrix,start", "setup-aux-files,setup-corporal,start", or "setup-matrix-user-verification-service,start" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update descriptions about installation - Introduce the most conservative and stable raw ansible-playbook command. - Introduce the just commands on installing.md and maintenance-upgrading-services.md, not on quick-start.md, since it is too early for quick start guide readers who are just starting to climb learning curve to use the shortcuts. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-etherpad.md: remove the note about ensure-matrix-users-created Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> --------- Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
3.1 KiB
Setting up the rageshake bug report server (optional)
The playbook can install and configure the rageshake bug report server for you.
This is useful if you're developing your own applications and would like to collect bug reports for them.
Adjusting the playbook configuration
To enable rageshake, add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file:
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.
To set these, you can make use of the matrix_rageshake_configuration_extension_yaml variable like this:
matrix_rageshake_configuration_extension_yaml: |
github_token: secrettoken
github_project_mappings:
my-app: octocat/HelloWorld
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.
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.
Example additional configuration for your inventory/host_vars/matrix.example.com/vars.yml file:
# Switch to the domain used for Matrix services (`matrix.example.com`),
# so we won't need to add additional DNS records for rageshake.
matrix_rageshake_hostname: "{{ matrix_server_fqn_matrix }}"
# Expose under the /rageshake subpath
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.
By default, you will need to create a CNAME record for rageshake. See Configuring DNS for details about DNS changes.
If you've decided to reuse the matrix. domain, you won't need to do any extra DNS configuration.
Installing
After configuring the playbook and potentially adjusting your DNS records, run the playbook with playbook tags as below:
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
The shortcut commands with the just program are also available: just install-all or just setup-all
just install-all is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your vars.yml to remove other components, you'd need to run just setup-all, or these components will still remain installed. Note these shortcuts run the ensure-matrix-users-created tag too.
Usage
Refer to the rageshake documentation for available APIs, etc.