ソースを参照

Update docs/configuring-playbook-rageshake: add the common section "Extending the configuration"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/4036/head
Suguru Hirahara 1年前
コミット
f01d95f2dd
この署名に対応する既知のキーがデータベースに存在しません GPGキーID: E4F9743DAB4B7B75
1個のファイルの変更25行の追加12行の削除
  1. +25
    -12
      docs/configuring-playbook-rageshake.md

+ 25
- 12
docs/configuring-playbook-rageshake.md ファイルの表示

@@ -20,18 +20,6 @@ To enable rageshake, add the following configuration to your `inventory/host_var
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).

To set these, you can make use of the `matrix_rageshake_configuration_extension_yaml` variable like this:

```yaml
matrix_rageshake_configuration_extension_yaml: |
github_token: secrettoken

github_project_mappings:
my-app: octocat/HelloWorld
```

### Adjusting the rageshake URL (optional)

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.
@@ -51,6 +39,31 @@ After changing the domain, **you may need to adjust your DNS** records to point

If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration.

### Extending the configuration

There are some additional things you may wish to configure about the server.

Take a look at:

- `roles/custom/matrix-rageshake/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
- `roles/custom/matrix-rageshake/templates/config.yaml.j2` for the server's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_rageshake_configuration_extension_yaml` variable

```yaml
matrix_rageshake_configuration_extension_yaml: |
# Your custom YAML configuration goes here.
# This configuration extends the default starting configuration (`matrix_rageshake_configuration_extension_yaml`).
#
# You can override individual variables from the default configuration, or introduce new ones.
#
# If you need something more special, you can take full control by
# completely redefining `matrix_rageshake_configuration_extension_yaml`.

github_token: secrettoken

github_project_mappings:
my-app: octocat/HelloWorld
```

## Installing

After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:


読み込み中…
キャンセル
保存