ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-12-31 08:46:09 +00:00
Code Issues Projects Releases Wiki Activity

Update docs/configuring-playbook.md and docs/container-images.md: add explanations to each section

Browse Source 
These sentences are copied from README.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara 2024-11-03 14:48:34 +09:00
parent 16104b6e57
commit 68b8f1137f
No known key found for this signature in database
GPG Key ID: E4F9743DAB4B7B75
3 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -160,7 +160,7 @@ Services that help you in administrating and monitoring your Matrix installation
### Misc
Various services that don't fit any other category.
Various services that don't fit any other categories.
| Name | Default? | Description | Documentation |
| ---- | -------- | ----------- | ------------- |

14
docs/configuring-playbook.md
View File

@ -66,6 +66,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins
### Clients
Web clients for Matrix that you can host on your own domains.
- [Configuring Element](configuring-playbook-client-element.md), if you're going with the default/recommended client
- [Setting up Hydrogen](configuring-playbook-client-hydrogen.md), if you've enabled [Hydrogen](https://github.com/element-hq/hydrogen-web), a lightweight Matrix client with legacy and mobile browser support
@ -76,6 +78,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins
### Authentication and user-related
Extend and modify how users are authenticated on your homeserver.
- [Setting up Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md) (Next-generation auth for Matrix, based on OAuth 2.0/OIDC)
- [Setting up Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md)
@ -98,6 +102,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins
### File Storage
Use alternative file storage to the default `media_store` folder.
- [Storing Matrix media files on Amazon S3 with Goofys](docs/configuring-playbook-s3-goofys.md)
- [Storing Synapse media files on Amazon S3 or another compatible Object Storage](configuring-playbook-s3.md)
@ -106,6 +112,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins
### Bridging other networks
Bridges can be used to connect your Matrix installation with third-party communication networks.
- [Setting up Mautrix Discord bridging](configuring-playbook-bridge-mautrix-discord.md)
- [Setting up Mautrix Telegram bridging](configuring-playbook-bridge-mautrix-telegram.md)
@ -167,6 +175,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins
### Bots
Bots provide various additional functionality to your installation.
- [Setting up baibot](configuring-playbook-bot-baibot.md) - a bot through which you can talk to various [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) services ([OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) and [others](https://github.com/etkecc/baibot/blob/main/docs/providers.md))
- [Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) - a bot to remind you about stuff
@ -187,6 +197,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins
### Administration
Services that help you in administrating and monitoring your Matrix installation.
- [Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver](configuring-playbook-alertmanager-receiver.md)
- [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md)
@ -204,6 +216,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins
### Other specialized services
Various services that don't fit any other categories.
- [Setting up the Sliding Sync proxy](configuring-playbook-sliding-sync-proxy.md) for clients which require Sliding Sync support (like Element X)
- [Setting up Synapse Auto Invite Accept](configuring-playbook-synapse-auto-accept-invite.md)

16
docs/container-images.md
View File

@ -15,6 +15,8 @@ We try to stick to official images (provided by their respective projects) as mu
## Clients
Web clients for Matrix that you can host on your own domains.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [Element](configuring-playbook-client-element.md) | [vectorim/element-web](https://hub.docker.com/r/vectorim/element-web/) | ✓ | Web UI, which is configured to connect to your own Synapse server by default |
@ -24,6 +26,8 @@ We try to stick to official images (provided by their respective projects) as mu
## Server Components
Services that run on the server to make the various parts of your installation work.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [PostgreSQL](configuring-playbook-external-postgres.md) | [postgres](https://hub.docker.com/_/postgres/) | ✓ | Database for Synapse. [Using an external PostgreSQL server](configuring-playbook-external-postgres.md) is also possible. |
@ -36,6 +40,8 @@ We try to stick to official images (provided by their respective projects) as mu
## Authentication
Extend and modify how users are authenticated on your homeserver.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [matrix-synapse-rest-auth](configuring-playbook-rest-auth.md) | (N/A) | x | REST authentication password provider module |
@ -47,6 +53,8 @@ We try to stick to official images (provided by their respective projects) as mu
## File Storage
Use alternative file storage to the default `media_store` folder.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [Goofys](configuring-playbook-s3-goofys.md) | [ewoutp/goofys](https://hub.docker.com/r/ewoutp/goofys/) | x | [Amazon S3](https://aws.amazon.com/s3/) (or other S3-compatible object store) storage for Synapse's content repository (`media_store`) files |
@ -55,6 +63,8 @@ We try to stick to official images (provided by their respective projects) as mu
# Bridges
Bridges can be used to connect your Matrix installation with third-party communication networks.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) | [mautrix/discord](https://mau.dev/mautrix/discord/container_registry) | x | Bridge to [Discord](https://discord.com/) |
@ -88,6 +98,8 @@ We try to stick to official images (provided by their respective projects) as mu
## Bots
Bots provide various additional functionality to your installation.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [baibot](configuring-playbook-bot-baibot.md) | [etke.cc/baibot](https://ghcr.io/etkecc/baibot) | x | A bot that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you |
@ -101,6 +113,8 @@ We try to stick to official images (provided by their respective projects) as mu
## Administration
Services that help you in administrating and monitoring your Matrix installation.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [matrix-alertmanager-receiver](configuring-playbook-alertmanager-receiver.md) | [metio/matrix-alertmanager-receiver](https://hub.docker.com/r/metio/matrix-alertmanager-receiver) | x | Prometheus' [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) client |
@ -116,6 +130,8 @@ We try to stick to official images (provided by their respective projects) as mu
## Misc
Various services that don't fit any other categories.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [sliding-sync](configuring-playbook-sliding-sync-proxy.md) | [matrix-org/sliding-sync](https://ghcr.io/matrix-org/sliding-sync) | x | Sliding Sync support for clients which require it (e.g. Element X) |