ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-01-22 10:49:35 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #3942 from luixxiul/fix

Browse Source 
Update docs: adopt the common instruction
This commit is contained in:
Slavi Pantaleev 2025-01-16 08:50:36 +02:00 committed by GitHub
commit a2db85cdf4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/configuring-playbook-bot-draupnir.md
View File

@ -125,7 +125,7 @@ matrix_bot_draupnir_access_token: "ACCESS_TOKEN_HERE"
Draupnir supports two methods to receive reports in the management room. Draupnir supports two methods to receive reports in the management room.
The first method intercepts the report API endpoint of the client-server API, which requires integration with the reverse proxy in front of the homeserver. If you are using traefik, this playbook can set this up for you: The first method intercepts the report API endpoint of the client-server API, which requires integration with the reverse proxy in front of the homeserver. If you are using traefik, the playbook can set this up for you:
```yaml ```yaml
matrix_bot_draupnir_abuse_reporting_enabled: true matrix_bot_draupnir_abuse_reporting_enabled: true

2
docs/configuring-playbook-client-cinny.md
View File

@ -1,6 +1,6 @@
# Setting up Cinny (optional) # Setting up Cinny (optional)
This playbook can install the [Cinny](https://github.com/ajbura/cinny) Matrix web client for you. The playbook can install and configure the [Cinny](https://github.com/ajbura/cinny) Matrix web client for you.
Cinny is a web client focusing primarily on simple, elegant and secure interface. It can be installed alongside or instead of [Element Web](./configuring-playbook-client-element-web.md). Cinny is a web client focusing primarily on simple, elegant and secure interface. It can be installed alongside or instead of [Element Web](./configuring-playbook-client-element-web.md).

2
docs/configuring-playbook-client-hydrogen.md
View File

@ -1,6 +1,6 @@
# Setting up Hydrogen (optional) # Setting up Hydrogen (optional)
This playbook can install the [Hydrogen](https://github.com/element-hq/hydrogen-web) Matrix web client for you. The playbook can install and configure the [Hydrogen](https://github.com/element-hq/hydrogen-web) Matrix web client for you.
Hydrogen is a lightweight web client that supports mobile and legacy web browsers. It can be installed alongside or instead of Element Web. Hydrogen is a lightweight web client that supports mobile and legacy web browsers. It can be installed alongside or instead of Element Web.

2
docs/configuring-playbook-client-schildichat-web.md
View File

@ -1,6 +1,6 @@
# Setting up SchildiChat Web (optional) # Setting up SchildiChat Web (optional)
This playbook can install the [SchildiChat Web](https://github.com/SchildiChat/schildichat-desktop) Matrix client for you. The playbook can install and configure the [SchildiChat Web](https://github.com/SchildiChat/schildichat-desktop) Matrix client for you.
SchildiChat Web is a feature-rich messenger for Matrix based on Element Web with some extras and tweaks. It can be installed alongside or instead of Element Web. SchildiChat Web is a feature-rich messenger for Matrix based on Element Web with some extras and tweaks. It can be installed alongside or instead of Element Web.

2
docs/configuring-playbook-matrix-authentication-service.md
View File

@ -1,6 +1,6 @@
# Setting up Matrix Authentication Service (optional) # Setting up Matrix Authentication Service (optional)
This playbook can install and configure [Matrix Authentication Service](https://github.com/element-hq/matrix-authentication-service/) (MAS) - a service operating alongside your existing [Synapse](./configuring-playbook-synapse.md) homeserver and providing [better authentication, session management and permissions in Matrix](https://matrix.org/blog/2023/09/better-auth/). The playbook can install and configure [Matrix Authentication Service](https://github.com/element-hq/matrix-authentication-service/) (MAS) - a service operating alongside your existing [Synapse](./configuring-playbook-synapse.md) homeserver and providing [better authentication, session management and permissions in Matrix](https://matrix.org/blog/2023/09/better-auth/).
Matrix Authentication Service is an implementation of [MSC3861: Next-generation auth for Matrix, based on OAuth 2.0/OIDC](https://github.com/matrix-org/matrix-spec-proposals/pull/3861) and still work in progress, tracked at the [areweoidcyet.com](https://areweoidcyet.com/) website. Matrix Authentication Service is an implementation of [MSC3861: Next-generation auth for Matrix, based on OAuth 2.0/OIDC](https://github.com/matrix-org/matrix-spec-proposals/pull/3861) and still work in progress, tracked at the [areweoidcyet.com](https://areweoidcyet.com/) website.

2
docs/maintenance-checking-services.md
View File

@ -1,6 +1,6 @@
# Checking if services work # Checking if services work
This playbook can perform a check to ensure that you've configured things correctly and that services are running. The playbook can perform a check to ensure that you've configured things correctly and that services are running.
To perform the check, run: To perform the check, run:

2
docs/maintenance-postgres.md
View File

@ -76,7 +76,7 @@ Once installed, the playbook attempts to preserve the Postgres version it starts
Upgrades must be performed manually. Upgrades must be performed manually.
This playbook can upgrade your existing Postgres setup with the following command: The playbook can upgrade your existing Postgres setup with the following command:
```sh ```sh
just run-tags upgrade-postgres just run-tags upgrade-postgres

2
docs/prerequisites.md
View File

@ -28,7 +28,7 @@ We will be using `example.com` as the domain in the following instruction. Pleas
- **Debian** (10/Buster or newer) - **Debian** (10/Buster or newer)
- **Ubuntu** (18.04 or newer, although [20.04 may be problematic](ansible.md#supported-ansible-versions) if you run the Ansible playbook on it) - **Ubuntu** (18.04 or newer, although [20.04 may be problematic](ansible.md#supported-ansible-versions) if you run the Ansible playbook on it)
Generally, newer is better. We only strive to support released stable versions of distributions, not betas or pre-releases. This playbook can take over your whole server or co-exist with other services that you have there. Generally, newer is better. We only strive to support released stable versions of distributions, not betas or pre-releases. The playbook can take over your whole server or co-exist with other services that you have there.
This playbook somewhat supports running on non-`amd64` architectures like ARM. See [Alternative Architectures](alternative-architectures.md). This playbook somewhat supports running on non-`amd64` architectures like ARM. See [Alternative Architectures](alternative-architectures.md).