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>
If you are using [your own webserver](./docs/configuring-playbook-own-webserver.md) (in front of Traefik), port binding on UDP port `8448` by default due to HTTP/3 is either unnecessary or [may get in the way](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3402). If it does, you can disable it:
```yml
```yaml
# Disable HTTP/3 for the federation entrypoint.
# If you'd like HTTP/3, consider configuring it for your other reverse-proxy.
#
@@ -322,7 +322,7 @@ The playbook has just started making use of this feature. **From now on, your sy
If you'd like **to go back to the old unrestricted behavior**, use the following configuration:
```yml
```yaml
# Use this configuration to allow synapse-admin to manage any homeserver instance.
matrix_synapse_admin_config_restrictBaseUrl: []
```
@@ -387,7 +387,7 @@ Users on `arm32` should be aware that there's **neither a prebuilt `arm32` conta
**The playbook still supports Redis** and you can keep using Redis (for now) if you'd like, by adding this additional configuration to your `vars.yml` file:
```yml
```yaml
# Explicitly disable KeyDB, which will auto-enable Redis
# if the playbook requires it as a dependency for its operation.
keydb_enabled: false
@@ -2800,7 +2800,7 @@ You can now customize the server name string that Riot-web displays in its login
These playbook variables, with these default values, have been added:
@@ -3628,7 +3628,7 @@ The playbook now allows you to set the log levels used by Synapse. The default l
You can now override following variables with any of the supported log levels listed here: https://docs.python.org/3/library/logging.html#logging-levels
This now allows you use a custom integration manager like [Dimension](https://dimension.t2bot.io). For example, if you wish to use the Dimension instance hosted at dimension.t2bot.io, you can set the following in your vars.yml 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.
@@ -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
@@ -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:
@@ -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:
@@ -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.
@@ -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 ;
@@ -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:
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.
@@ -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:
@@ -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):
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):