Update triple backticks with syntax highlighting (#3832)

* Triple backticks with syntax highlighting: yml → yaml

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Triple backticks with syntax highlighting: yaml and sh

The strings "yml" were replaced with "yaml" as the latter is used more than the former.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Triple backticks with syntax highlighting: INI

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-jitsi.md: remove redundant white space characters after triple backticks

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>
This commit is contained in:
Suguru Hirahara
2024-11-28 18:33:56 +09:00
committed by GitHub
parent 85b00f298e
commit cd1905f576
41 changed files with 79 additions and 79 deletions

View File

@ -55,7 +55,7 @@ Alternatively, you can leave your `inventory/hosts` as is and specify the connec
Run this from the playbook's directory:
```bash
```sh
docker run -it --rm \
--privileged \
--pid=host \
@ -76,7 +76,7 @@ Finally, you can execute `ansible-playbook ...` (or `ansible-playbook --connecti
Run this from the playbook's directory:
```bash
```sh
docker run -it --rm \
-w /work \
-v `pwd`:/work \
@ -99,7 +99,7 @@ Finally, you execute `ansible-playbook ...` commands as per normal now.
If you don't use SSH keys for authentication, simply remove that whole line (`-v $HOME/.ssh/id_rsa:/root/.ssh/id_rsa:ro`).
To authenticate at your server using a password, you need to add a package. So, when you are in the shell of the ansible docker container (the previously used `docker run -it ...` command), run:
```bash
```sh
apk add sshpass
```
Then, to be asked for the password whenever running an `ansible-playbook` command add `--ask-pass` to the arguments of the command.

View File

@ -12,7 +12,7 @@ This service is meant to be used with an external [Alertmanager](https://prometh
To enable matrix-alertmanager-receiver, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
```yml
```yaml
matrix_alertmanager_receiver_enabled: true
# If you'd like to change the username for this bot, uncomment and adjust. Otherwise, remove.
@ -85,7 +85,7 @@ Then, you can proceed to [Usage](#usage).
Configure your Prometheus Alertmanager with configuration like this:
```yml
```yaml
receivers:
- name: matrix
webhook_configs:

View File

@ -10,7 +10,7 @@ Previously, bridges supported performing [double-puppeting](https://docs.mau.fi/
To enable the Appservice Double Puppet service, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
```yml
```yaml
matrix_appservice_double_puppet_enabled: true
```

View File

@ -51,7 +51,7 @@ matrix_appservice_draupnir_for_all_master_control_room_alias: "ALIAS_FROM_STEP_2
After configuring the playbook, run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -18,7 +18,7 @@ By default, if you're using the integrated Postgres database server (as opposed
2. Create a new SSH key:
```bash
```sh
ssh-keygen -t ed25519 -N '' -f matrix-borg-backup -C matrix
```
@ -28,7 +28,7 @@ By default, if you're using the integrated Postgres database server (as opposed
If you plan to use a hosted solution, follow their instructions. If you have your own server, copy the key over:
```bash
```sh
# example to append the new PUBKEY contents, where:
# PUBKEY is path to the public key,
# USER is a ssh user on a provider / server
@ -73,7 +73,7 @@ Check the [backup_borg role](https://github.com/mother-of-all-self-hosting/ansib
After configuring the playbook, run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -84,7 +84,7 @@ If `matrix_admin` is already configured in your `vars.yml` configuration, you ca
**If necessary**, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
```yml
```yaml
# Uncomment to add one or more admins to this bridge:
#
# matrix_bot_baibot_config_access_admin_patterns:
@ -113,7 +113,7 @@ Configuring `matrix_bot_baibot_config_initial_global_config_user_patterns` is op
**If necessary**, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
```yml
```yaml
# Uncomment and adjust the bot users if necessary:
#
# Subsequent changes to `matrix_bot_baibot_config_initial_global_config_user_patterns` do not affect the bot's behavior.
@ -146,7 +146,7 @@ You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot
Here's an example **addition** to your `vars.yml` file:
```yml
```yaml
matrix_bot_baibot_config_agents_static_definitions_anthropic_enabled: true
matrix_bot_baibot_config_agents_static_definitions_anthropic_config_api_key: "YOUR_API_KEY_HERE"
@ -173,7 +173,7 @@ You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot
Here's an example **addition** to your `vars.yml` file:
```yml
```yaml
matrix_bot_baibot_config_agents_static_definitions_groq_enabled: true
matrix_bot_baibot_config_agents_static_definitions_groq_config_api_key: "YOUR_API_KEY_HERE"
@ -207,7 +207,7 @@ You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot
Here's an example **addition** to your `vars.yml` file:
```yml
```yaml
matrix_bot_baibot_config_agents_static_definitions_mistral_enabled: true
matrix_bot_baibot_config_agents_static_definitions_mistral_config_api_key: "YOUR_API_KEY_HERE"
@ -238,7 +238,7 @@ The OpenAI provider is **only meant to be used with OpenAI's official API** and
Here's an example **addition** to your `vars.yml` file:
```yml
```yaml
matrix_bot_baibot_config_agents_static_definitions_openai_enabled: true
matrix_bot_baibot_config_agents_static_definitions_openai_config_api_key: "YOUR_API_KEY_HERE"
@ -282,7 +282,7 @@ You can also define providers at runtime, by chatting with the bot, so using Ans
Below is an an **example** demonstrating **statically-defining agents via Ansible without using presets**:
```yml
```yaml
matrix_bot_baibot_config_agents_static_definitions_custom:
# This agent will use the GPT 3.5 model and will only support text-generation,
# even though the `openai` provider could support other features (e.g. image-generation).
@ -356,7 +356,7 @@ You can configure the **initial values** for these via Ansible, via the `matrix_
Example **additional** `vars.yml` configuration:
```yml
```yaml
# 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.
# Once initially configured, the global configuration is managed via bot commands, not via Ansible.

View File

@ -16,7 +16,7 @@ Choose a strong password for the bot. You can generate a good password with a co
You can use the playbook to [register a new user](registering-users.md):
```
```sh
ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.chatgpt password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user
```

View File

@ -19,7 +19,7 @@ Choose a strong password for the bot. You can generate a good password with a co
You can use the playbook to [register a new user](registering-users.md):
```
```sh
ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.draupnir password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user
```
@ -117,7 +117,7 @@ That is all you need to do due to that Draupnir can complete migration on its ow
After configuring the playbook, run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -19,7 +19,7 @@ Choose a strong password for the bot. You can generate a good password with a co
You can use the playbook to [register a new user](registering-users.md):
```
```sh
ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.go-neb password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user
```
@ -221,7 +221,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -46,6 +46,6 @@ If you have any questions, or if you need help setting it up, read the [troublsh
To clean the cache (session & encryption data) after you changed the bot's username, changed the login method from access_token to password etc... you can use:
```bash
```sh
just run-tags bot-matrix-registration-bot-clean-cache
```

View File

@ -15,7 +15,7 @@ Choose a strong password for the bot. You can generate a good password with a co
You can use the playbook to [register a new user](registering-users.md):
```
```sh
ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.mjolnir password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user
```
@ -119,7 +119,7 @@ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_ban_lists: []
After configuring the playbook, run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -21,7 +21,7 @@ You may optionally wish to add some [Additional configuration](#additional-confi
After configuring the playbook, run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -29,7 +29,7 @@ You may optionally wish to add some [Additional configuration](#additional-confi
After configuring the playbook, run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -97,7 +97,7 @@ The easiest way to do this may be to use [sshuttle](https://sshuttle.readthedocs
Example command for proxying your traffic through the Matrix server:
```
```sh
sshuttle -r root@matrix.example.com:22 0/0
```

View File

@ -32,7 +32,7 @@ You may optionally wish to add some [Additional configuration](#additional-confi
After configuring the playbook, run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -25,7 +25,7 @@ matrix_mx_puppet_slack_oauth_client_secret: "<SLACK_APP_CLIENT_SECRET>"
After configuring the playbook, run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -71,7 +71,7 @@ By default, you will need to create a CNAME record for `dimension`. See [Configu
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -57,7 +57,7 @@ Why? This change could be useful for people running small Synapse instances on s
The following changes in the configuration file (`inventory/host_vars/matrix.example.com/vars.yml`) will allow this and make it possible to proxy the federation through a CDN such as CloudFlare or any other:
```
```yaml
matrix_synapse_http_listener_resource_names: ["client","federation"]
# Any port can be used but in this case we use 443
matrix_federation_public_port: 443

View File

@ -172,18 +172,18 @@ By default, a single JVB ([Jitsi VideoBridge](https://github.com/jitsi/jitsi-vid
There is an ansible playbook that can be run with the following tag: `ansible-playbook -i inventory/hosts --limit jitsi_jvb_servers jitsi_jvb.yml --tags=common,setup-additional-jitsi-jvb,start`
For this role to work you will need an additional section in the ansible hosts file with the details of the JVB hosts, for example:
```
```INI
[jitsi_jvb_servers]
<your jvb hosts> ansible_host=<ip address of the jvb host>
```
Each JVB will require a server ID to be set so that it can be uniquely identified and this allows Jitsi to keep track of which conferences are on which JVB. The server ID is set with the variable `jitsi_jvb_server_id` which ends up as the JVB_WS_SERVER_ID environment variables in the JVB docker container. This variable can be set via the host file, a parameter to the ansible command or in the `vars.yaml` for the host which will have the additional JVB. For example:
``` yaml
```yaml
jitsi_jvb_server_id: 'jvb-2'
```
``` INI
```INI
[jitsi_jvb_servers]
jvb-2.example.com ansible_host=192.168.0.2 jitsi_jvb_server_id=jvb-2
jvb-3.example.com ansible_host=192.168.0.3 jitsi_jvb_server_id=jvb-2
@ -271,7 +271,7 @@ jitsi_disable_gravatar: false
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -364,7 +364,7 @@ The same OIDC provider may have an `id` of `01HFVBY12TMNTYTBV8W921M5FA` on the M
To tell `syn2mas` how the Synapse-configured OIDC provider maps to the new MAS-configured OIDC provider, add this additional configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
```yml
```yaml
# Adjust the mapping below to match your provider IDs on the Synapse side and the MAS side.
# Don't forget that Synapse automatically adds an `oidc-` prefix to provider ids defined in its configuration.
matrix_authentication_service_syn2mas_process_extra_arguments:

View File

@ -54,7 +54,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```
@ -72,7 +72,7 @@ We make the most common APIs easy to use via the playbook (see below).
To **create a new user registration token (link)**, use this command:
```bash
```sh
ansible-playbook -i inventory/hosts setup.yml \
--tags=generate-matrix-registration-token \
--extra-vars="one_time=yes ex_date=2021-12-31"
@ -87,7 +87,7 @@ Share the unique registration link (generated by the command above) with users t
To **list the existing user registration tokens**, use this command:
```bash
```sh
ansible-playbook -i inventory/hosts setup.yml \
--tags=list-matrix-registration-tokens
```

View File

@ -52,7 +52,7 @@ By default, you will need to create a CNAME record for `ntfy`. See [Configuring
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -31,6 +31,6 @@ Refer to the table below for additional configuration variables and their defaul
After configuring the playbook, run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -53,7 +53,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -79,7 +79,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -34,7 +34,7 @@ Since Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.1
Here's example configuration for using the **native** Synapse feature:
```yml
```yaml
matrix_synapse_auto_accept_invites_enabled: true
# Default settings below. Uncomment and adjust this part if necessary.

View File

@ -20,7 +20,7 @@ matrix_synapse_auto_compressor_enabled: true
After configuring the playbook, run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -98,7 +98,7 @@ For more detailed documentation on available options and how to setup keycloak,
In case you encounter errors regarding the parsing of the variables, you can try to add `{% raw %}` and `{% endraw %}` blocks around them. For example ;
```yml
```yaml
matrix_synapse_oidc_enabled: true
matrix_synapse_oidc_providers:

View File

@ -40,7 +40,7 @@ The playbook uses the [`auth-secret` authentication method](https://github.com/c
To do so, add this override to your configuration:
```yml
```yaml
matrix_coturn_authentication_method: lt-cred-mech
```

View File

@ -92,7 +92,7 @@ This will instruct UVS to verify the OpenID token against any domain given in a
After these variables have been set, run the [installation](installing.md) command to restart UVS:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-matrix-user-verification-service,start
```

View File

@ -267,7 +267,7 @@ matrix_server_fqn_etherpad: "etherpad.example.com"
After configuring the playbook, run the [installation](installing.md) command:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

View File

@ -19,7 +19,7 @@ We recommend using the [git](https://git-scm.com/) tool to get the playbook's so
Once you've installed git on your computer, you can go to any directory of your choosing and run the following command to retrieve the playbook's source code:
```bash
```sh
git clone https://github.com/spantaleev/matrix-docker-ansible-deploy.git
```

View File

@ -94,7 +94,7 @@ Once the database is clear and the ownership of the tables has been fixed in the
Check, if `--dbname` is set to `synapse` (not `matrix`) and replace paths (or even better, copy this line from your terminal)
```
```sh
/usr/bin/env docker run --rm --name matrix-postgres-import --log-driver=none --user=998:1001 --cap-drop=ALL --network=matrix --env-file=/matrix/postgres/env-postgres-psql --mount type=bind,src=/migration/synapse_dump.sql,dst=/synapse_dump.sql,ro --entrypoint=/bin/sh docker.io/postgres:15.0-alpine -c "cat /synapse_dump.sql | grep -vE '^(CREATE|ALTER) ROLE (matrix)(;| WITH)' | grep -vE '^CREATE DATABASE (matrix)\s' | psql -v ON_ERROR_STOP=1 -h matrix-postgres --dbname=synapse"
```

View File

@ -3,7 +3,7 @@
## How to see the current status of your services
You can check the status of your services by using `systemctl status`. Example:
```
```sh
sudo systemctl status matrix-synapse
● matrix-synapse.service - Synapse server
@ -41,7 +41,7 @@ Re-run the playbook after making these configuration changes.
## Remove unused Docker data
You can free some disk space from Docker, see [docker system prune](https://docs.docker.com/engine/reference/commandline/system_prune/) for more information.
```bash
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=run-docker-prune
```

View File

@ -4,7 +4,7 @@ This playbook can perform a check to ensure that you've configured things correc
To perform the check, run:
```bash
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=self-check
```

View File

@ -57,7 +57,7 @@ To automatically make Postgres database backups on a fixed schedule, see [Settin
To make a one off back up of the current PostgreSQL database, make sure it's running and then execute a command like this on the server:
```bash
```sh
/usr/bin/docker exec \
--env-file=/matrix/postgres/env-postgres-psql \
matrix-postgres \

View File

@ -35,7 +35,7 @@ After deleting data, you may wish to run a [`FULL` Postgres `VACUUM`](./maintena
To ask the playbook to run rust-synapse-compress-state, execute:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=rust-synapse-compress-state
```
@ -52,14 +52,14 @@ Editing the database manually is not recommended or supported by the Synapse dev
First, set up an SSH tunnel to your Matrix server (skip if it is your local machine):
```
```sh
# you may replace 1799 with an arbitrary port unbound on both machines
ssh -L 1799:localhost:1799 matrix.example.com
```
Then start up an ephemeral [adminer](https://www.adminer.org/) container on the Matrix server, connecting it to the `matrix` network and linking the postgresql container:
```
```sh
docker run --rm --publish 1799:8080 --link matrix-postgres --net matrix adminer
```
@ -93,7 +93,7 @@ You can **learn more about cache-autotuning and the global cache factor settings
To **disable cache auto-tuning**, unset all values:
```yml
```yaml
matrix_synapse_cache_autotuning_max_cache_memory_usage: ''
matrix_synapse_cache_autotuning_target_cache_memory_usage: ''
matrix_synapse_cache_autotuning_min_cache_ttl: ''

View File

@ -25,7 +25,7 @@ Below, we describe 2 ways to generate an access token for a user - using [Elemen
You can use the following command to get an access token for your user directly from the [Matrix Client-Server API](https://www.matrix.org/docs/guides/client-server-api#login):
```
```sh
curl -XPOST -d '{
"identifier": { "type": "m.id.user", "user": "USERNAME" },
"password": "PASSWORD",

View File

@ -8,7 +8,7 @@
You can reset a user's password via the Ansible playbook:
```
```sh
ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=USERNAME_HERE password=PASSWORD_HERE' --tags=update-user-password
```
@ -19,7 +19,7 @@ ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=USERNAME_HE
You can manually generate the password hash by using the command-line after **SSH**-ing to your server (requires that [all services have been started](installing.md#finalize-the-installation):
```
```sh
docker exec -it matrix-synapse /usr/local/bin/hash_password -c /data/homeserver.yaml
```
@ -42,6 +42,6 @@ If you didn't make your account a server admin when you created it, you can lear
### Example:
To set @user:example.com's password to `correct_horse_battery_staple` you could use this curl command:
```
```sh
curl -XPOST -d '{ "new_password": "correct_horse_battery_staple" }' "https://matrix.example.com/_matrix/client/r0/admin/reset_password/@user:example.com?access_token=MDA...this_is_my_access_token
```