ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-12-22 12:35:51 +00:00
Code Issues Projects Releases Wiki Activity
5645ec0eda
matrix-docker-ansible-deploy/docs/configuring-playbook.md

254 lines
14 KiB
Markdown
Raw Normal View History

Add hard-coded breadcrumbs to documentation files about installation procedure for easier navigation (#3745) * Add hard-coded breadcrumbs to documentation files about installation procedure for easier navigation Since it is easy to get lost among these files, the breadcrumbs should be helpful to get the whole picture of the procedure. Hopefully they will be replaced with something else generated automatically. Please note that the usage of <sup> HTML tags on this context is not proper as the tag is intended to be used only for typographical reasons. Here <small> tags should rather be used instead as long as we do not use CSS, but since GitHub strips these tags against its spec (https://github.github.com/gfm/#disallowed-raw-html-extension-) (also note: the <small> HTML tags are not stripped on Codeberg for example), this commit intentionally uses <sup> to have those breadcrumbs rendered in small points. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook.md title The file is referred from other files as "Configuring the playbook" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add "Quick start" link with the thunder icon For now docs/README.md is linked 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>
2024-11-05 12:38:26 +00:00
# Configuring the playbook
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Change "Configuring your DNS server" to "Configuring your DNS settings" Essentially it means "configuring your DNS settings or records on the DNS server you use". Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-16 15:34:25 +00:00
<sup>⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS settings](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > Configuring the playbook > [Installing](installing.md)</sup>
Add hard-coded breadcrumbs to documentation files about installation procedure for easier navigation (#3745) * Add hard-coded breadcrumbs to documentation files about installation procedure for easier navigation Since it is easy to get lost among these files, the breadcrumbs should be helpful to get the whole picture of the procedure. Hopefully they will be replaced with something else generated automatically. Please note that the usage of <sup> HTML tags on this context is not proper as the tag is intended to be used only for typographical reasons. Here <small> tags should rather be used instead as long as we do not use CSS, but since GitHub strips these tags against its spec (https://github.github.com/gfm/#disallowed-raw-html-extension-) (also note: the <small> HTML tags are not stripped on Codeberg for example), this commit intentionally uses <sup> to have those breadcrumbs rendered in small points. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook.md title The file is referred from other files as "Configuring the playbook" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add "Quick start" link with the thunder icon For now docs/README.md is linked 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>
2024-11-05 12:38:26 +00:00
Update docs/configuring-playbook.md and docs/installing.md: remove anchor links to other installation procedure pages They are redundant as there are breadcrumbs on each page Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 18:28:27 +00:00
If you've configured your DNS records and retrieved the playbook's source code to your computer, you can start configuring the playbook. To do so, follow these steps inside the playbook directory:
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Update docs/configuring-playbook.md - Mention "base domain" - Fix list numbering - Add a blank line Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 10:06:05 +00:00
1. create a directory to hold your configuration (`mkdir -p inventory/host_vars/matrix.example.com` where `example.com` is your "base domain")
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Update docs/configuring-playbook.md - Mention "base domain" - Fix list numbering - Add a blank line Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 10:06:05 +00:00
2. copy the sample configuration file (`cp examples/vars.yml inventory/host_vars/matrix.example.com/vars.yml`)
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Update docs/configuring-playbook.md - Mention "base domain" - Fix list numbering - Add a blank line Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 10:06:05 +00:00
3. edit the configuration file (`inventory/host_vars/matrix.example.com/vars.yml`) to your liking. You may also take a look at the various `roles/*/ROLE_NAME_HERE/defaults/main.yml` files and see if there's something you'd like to copy over and override in your `vars.yml` configuration file.
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Update docs/configuring-playbook.md - Mention "base domain" - Fix list numbering - Add a blank line Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 10:06:05 +00:00
4. copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`)
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Update docs/configuring-playbook.md - Mention "base domain" - Fix list numbering - Add a blank line Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 10:06:05 +00:00
5. edit the inventory hosts file (`inventory/hosts`) to your liking
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Update docs/configuring-playbook.md - Mention "base domain" - Fix list numbering - Add a blank line Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 10:06:05 +00:00
6. (optional, advanced) you may wish to keep your `inventory` directory under version control with [git](https://git-scm.com/) or any other version-control system.
Remove inventory/ directory tree to allow people to manage it as a git repository (etc.) Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3086
2024-01-09 17:08:43 +00:00
Update docs/configuring-playbook.md - Mention "base domain" - Fix list numbering - Add a blank line Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 10:06:05 +00:00
7. (optional, advanced) to run Ansible against multiple servers with different `sudo` credentials, you can copy the sample inventory hosts yaml file for each of your hosts: (`cp examples/host.yml inventory/my_host1.yml` …) and use the [`ansible-all-hosts.sh`](../bin/ansible-all-hosts.sh) script [in the installation step](installing.md).
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
For a basic Matrix installation, that's all you need.
Update docs/configuring-playbook.md - Mention "base domain" - Fix list numbering - Add a blank line Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-18 10:06:05 +00:00
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
For a more custom setup, see the [Other configuration options](#other-configuration-options) below.
Add U+25B6 (BLACK RIGHT-POINTING TRIANGLE) characters to installation procedure navigation Set anchor links to those characters as well. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 18:51:36 +00:00
[▶️](installing.md) When you're done with all the configuration you'd like to do, continue with [Installing](installing.md).
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
## Other configuration options
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order.
2019-04-19 06:54:18 +00:00
### Core service adjustments
Add email-sending support
2018-08-14 11:11:41 +00:00
Document Conduit installation Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2076
2022-10-27 06:48:49 +00:00
- Homeserver configuration:
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Configuring Synapse](configuring-playbook-synapse.md), if you're going with the default/recommended homeserver implementation
Document Conduit installation Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2076
2022-10-27 06:48:49 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Configuring Conduit](configuring-playbook-conduit.md), if you've switched to the [Conduit](https://conduit.rs) homeserver implementation
Make Synapse configuration extensible
2019-08-22 06:49:22 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Configuring Dendrite](configuring-playbook-dendrite.md), if you've switched to the [Dendrite](https://matrix-org.github.io/dendrite) homeserver implementation
add auto join option to dendrite config (#2255) * add auto join option to dendrite config * added auto_join_rooms: variable * added "configuring dendrite" entry * created dendite configuration documentation * fixed config path * Update docs/configuring-playbook-dendrite.md Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Update docs/configuring-playbook-dendrite.md Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Update docs/configuring-playbook-dendrite.md Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Update docs/configuring-playbook-dendrite.md Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Update docs/configuring-playbook-dendrite.md Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Update roles/custom/matrix-dendrite/defaults/main.yml Co-authored-by: Slavi Pantaleev <slavi@devture.com> * correction Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2022-11-20 08:11:21 +00:00
Update docs/configuring-playbook.md: create a list for server components based on the table on README.md Also: update README.md and docs/container-images.md Move Sygnal and ntfy from "Server Components" to "Misc", following the existing categorization on docs/configuring-playbook.md where they are categorized as "Other specialzed services". This categorization makes more sense as they are not really services which make the components on the server work (per README.md) Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:13:11 +00:00
- Server components:
- [Using an external PostgreSQL server](configuring-playbook-external-postgres.md)
Announce matrix-media-repo Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2783
2023-07-17 19:37:53 +00:00
Update docs/configuring-playbook.md: create a list for server components based on the table on README.md Also: update README.md and docs/container-images.md Move Sygnal and ntfy from "Server Components" to "Misc", following the existing categorization on docs/configuring-playbook.md where they are categorized as "Other specialzed services". This categorization makes more sense as they are not really services which make the components on the server work (per README.md) Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:13:11 +00:00
- [Adjusting TURN server configuration](configuring-playbook-turn.md) (advanced)
Fix anchor links and its title of documents related to Amazon S3 Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-25 07:26:35 +00:00
Update docs/configuring-playbook.md: create a list for server components based on the table on README.md Also: update README.md and docs/container-images.md Move Sygnal and ntfy from "Server Components" to "Misc", following the existing categorization on docs/configuring-playbook.md where they are categorized as "Other specialzed services". This categorization makes more sense as they are not really services which make the components on the server work (per README.md) Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:13:11 +00:00
- [Configuring the Traefik reverse-proxy](configuring-playbook-traefik.md) (advanced)
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Update docs/configuring-playbook.md: create a list for server components based on the table on README.md Also: update README.md and docs/container-images.md Move Sygnal and ntfy from "Server Components" to "Misc", following the existing categorization on docs/configuring-playbook.md where they are categorized as "Other specialzed services". This categorization makes more sense as they are not really services which make the components on the server work (per README.md) Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:13:11 +00:00
- [Using your own webserver, instead of this playbook's Traefik reverse-proxy](configuring-playbook-own-webserver.md) (advanced)
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Update docs/configuring-playbook.md: create a list for server components based on the table on README.md Also: update README.md and docs/container-images.md Move Sygnal and ntfy from "Server Components" to "Misc", following the existing categorization on docs/configuring-playbook.md where they are categorized as "Other specialzed services". This categorization makes more sense as they are not really services which make the components on the server work (per README.md) Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:13:11 +00:00
- [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (advanced)
Add support for 2 more SSL certificate retrieval methods Adds support for managing certificates manually and for having the playbook generate self-signed certificates for you. With this, Let's Encrypt usage is no longer required. Fixes Github issue #50.
2018-12-23 09:00:12 +00:00
Update docs/configuring-playbook.md: create a list for server components based on the table on README.md Also: update README.md and docs/container-images.md Move Sygnal and ntfy from "Server Components" to "Misc", following the existing categorization on docs/configuring-playbook.md where they are categorized as "Other specialzed services". This categorization makes more sense as they are not really services which make the components on the server work (per README.md) Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:13:11 +00:00
- [Adjusting email-sending settings](configuring-playbook-email.md)
- [Setting up ma1sd Identity Server](configuring-playbook-ma1sd.md)
- [Setting up Dynamic DNS](configuring-playbook-dynamic-dns.md)
Update docs/configuring-playbook.md: merge "Server connectivity" section to "Core service adjustments" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:16:31 +00:00
- Server connectivity:
- [Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md)
- [Controlling Matrix federation](configuring-playbook-federation.md)
Update docs/configuring-playbook.md: create a section "Clients" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:59:15 +00:00
### Clients
Update docs/configuring-playbook.md and docs/container-images.md: add explanations to each section These sentences are copied from README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:48:34 +00:00
Web clients for Matrix that you can host on your own domains.
Add "Web" to Element and SchildiChat web application (#3755) * Replace "Element" with "Element Web" - If Element indicates the web application, then it is changed to Element Web. - If it indicates clients branded with Element such as Element desktop, web, mobile clients, then it is changed to Element clients. - If it is combined with location sharing functionality, it is not changed. with other some changes, including: - Change "app.element.io" anchor link to "https://github.com/element-hq/element-web" on README.md, following other documentation files Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Replace "SchildiChat" with "SchildiChat Web" - If SchildiChat indicates the web application, then it is changed to SchildiChat Web. - If it indicates clients branded with SchildiChat such as SchildiChat desktop, web, mobile clients, then it is changed to SchildiChat clients. - If it is combined with location sharing functionality, it is not changed. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Rename configuring-playbook-client-schildichat.md to configuring-playbook-client-schildichat-web.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Rename configuring-playbook-client-element.md to configuring-playbook-client-element-web.md 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>
2024-11-07 14:31:26 +00:00
- [Configuring Element Web](configuring-playbook-client-element-web.md), if you're going with the default/recommended client
Update docs/configuring-playbook.md: create a section "Clients" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:59:15 +00:00
- [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
- [Setting up Cinny](configuring-playbook-client-cinny.md), if you've enabled [Cinny](https://github.com/ajbura/cinny), a web client focusing primarily on simple, elegant and secure interface
Add "Web" to Element and SchildiChat web application (#3755) * Replace "Element" with "Element Web" - If Element indicates the web application, then it is changed to Element Web. - If it indicates clients branded with Element such as Element desktop, web, mobile clients, then it is changed to Element clients. - If it is combined with location sharing functionality, it is not changed. with other some changes, including: - Change "app.element.io" anchor link to "https://github.com/element-hq/element-web" on README.md, following other documentation files Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Replace "SchildiChat" with "SchildiChat Web" - If SchildiChat indicates the web application, then it is changed to SchildiChat Web. - If it indicates clients branded with SchildiChat such as SchildiChat desktop, web, mobile clients, then it is changed to SchildiChat clients. - If it is combined with location sharing functionality, it is not changed. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Rename configuring-playbook-client-schildichat.md to configuring-playbook-client-schildichat-web.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Rename configuring-playbook-client-element.md to configuring-playbook-client-element-web.md 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>
2024-11-07 14:31:26 +00:00
- [Setting up SchildiChat Web](configuring-playbook-client-schildichat-web.md), if you've enabled [SchildiChat Web](https://schildi.chat/), a web client based on [Element Web](https://element.io/) with some extras and tweaks
Update docs/configuring-playbook.md: create a section "Clients" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:59:15 +00:00
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order.
2019-04-19 06:54:18 +00:00
### Authentication and user-related
Update docs/configuring-playbook.md and docs/container-images.md: add explanations to each section These sentences are copied from README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:48:34 +00:00
Extend and modify how users are authenticated on your homeserver.
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md) (Next-generation auth for Matrix, based on OAuth 2.0/OIDC)
Add support for Matrix Authentication Service Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3108 Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3562
2024-10-19 11:31:14 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md)
Add appservice-double-puppet service for better bridge double-puppeting Bridges will be switched to this new method in future patches.
2024-08-17 16:00:16 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Synapse Admin](configuring-playbook-synapse-admin.md)
Add synapse-admin support Fixes #562 (Github Issue)
2020-07-22 05:10:26 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up matrix-registration](configuring-playbook-matrix-registration.md)
Add matrix-registration support
2020-09-01 10:46:05 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up the REST authentication password provider module](configuring-playbook-rest-auth.md) (advanced)
Add support for matrix-synapse-shared-secret-auth
2018-08-20 14:11:55 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up the Shared Secret Auth password provider module](configuring-playbook-shared-secret-auth.md) (advanced)
Add support for matrix-corporal
2018-08-21 10:34:34 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up the LDAP authentication password provider module](configuring-playbook-ldap-auth.md) (advanced)
Add LDAP auth password provider documentation and changelog description
2018-11-28 09:21:03 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up matrix-ldap-registration-proxy](configuring-playbook-matrix-ldap-registration-proxy.md) (advanced)
Add documentation to readme/list of services Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net>
2022-09-16 17:15:33 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Synapse Simple Antispam](configuring-playbook-synapse-simple-antispam.md) (advanced)
Add support for Synapse Simple Antispam Fixes #255 (Github Issue).
2019-09-09 05:13:06 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Matrix User Verification Service](configuring-playbook-user-verification-service.md) (advanced)
Add Pantalaimon support This is actually authored by Julian Foad here (https://lab.trax.im/matrix/matrix-docker-ansible-deploy), but was in need of a rebase and various adjustments caused by huge playbook refactoring that landed in the past months. This rework is completely untested. Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/266
2024-03-24 16:25:19 +00:00
Update docs/configuring-playbook.md: create "File Storage" section under "Authentication and user-related" section This basically follows the order of the tables on README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:19:15 +00:00
### File Storage
Update docs/configuring-playbook.md and docs/container-images.md: add explanations to each section These sentences are copied from README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:48:34 +00:00
Use alternative file storage to the default `media_store` folder.
Fix broken anchor links Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-17 12:30:47 +00:00
- [Storing Matrix media files on Amazon S3 with Goofys](configuring-playbook-s3-goofys.md)
Update docs/configuring-playbook.md: create "File Storage" section under "Authentication and user-related" section This basically follows the order of the tables on README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:19:15 +00:00
- [Storing Synapse media files on Amazon S3 or another compatible Object Storage](configuring-playbook-s3.md)
- [Storing Matrix media files using matrix-media-repo](configuring-playbook-matrix-media-repo.md)
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order.
2019-04-19 06:54:18 +00:00
### Bridging other networks
Update docs/configuring-playbook.md and docs/container-images.md: add explanations to each section These sentences are copied from README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:48:34 +00:00
Bridges can be used to connect your Matrix installation with third-party communication networks.
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Mautrix Discord bridging](configuring-playbook-bridge-mautrix-discord.md)
Add Mautrix Discord Bridge
2022-07-22 14:55:44 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Mautrix Telegram bridging](configuring-playbook-bridge-mautrix-telegram.md)
Update documentation
2018-10-26 16:44:58 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Mautrix Slack bridging](configuring-playbook-bridge-mautrix-slack.md)
Announce maurtix-slack Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2227
2023-01-11 08:38:54 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Mautrix Google Messages bridging](configuring-playbook-bridge-mautrix-gmessages.md)
Added Google Messager Bridge (#2794) * intial commit * changed * Reorderd * merge old changes * added changes to matrix_servers * Remove duplicate discord * Update main.yml * added google message to configuring-playbook.md * Changed docs to add new changes * Changed bug? * Removed problem j2 values * Rename a service files * change how password hash string * Changed port number * Change how the local part works * Revert "Merge pull request #8 from shreyasajj/wsproxy" This reverts commit bb1b8fc67ca39f63ca77e70077be99cb2b32c4de, reversing changes made to cce6ba5f9d74f89172488afc8b1ef124031de8c1. --------- Co-authored-by: Shreyas Ajjarapu <github.tzarina@aleeas.com>
2023-07-21 11:33:52 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Mautrix Whatsapp bridging](configuring-playbook-bridge-mautrix-whatsapp.md)
Add support for matrix-appservice-irc
2019-01-31 05:37:23 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Instagram bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-instagram.md)
Add support for bridging to Facebook Messenger and Instagram via mautrix-meta Related to: https://github.com/mautrix/facebook/issues/332 Fixes: https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3138
2024-02-19 08:13:36 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Messenger bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-messenger.md)
Add support for bridging to Facebook Messenger and Instagram via mautrix-meta Related to: https://github.com/mautrix/facebook/issues/332 Fixes: https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3138
2024-02-19 08:13:36 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Mautrix Google Chat bridging](configuring-playbook-bridge-mautrix-googlechat.md)
Added Mautrix Google Chat
2021-10-12 11:45:04 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Mautrix Twitter bridging](configuring-playbook-bridge-mautrix-twitter.md)
Update documentation to include mautrix-twitter Playbook config copied from mautrix-facebook and altered accordingly.
2021-04-11 06:45:27 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Mautrix Signal bridging](configuring-playbook-bridge-mautrix-signal.md)
added docs
2020-10-25 17:44:19 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Mautrix wsproxy for bridging Android SMS or Apple iMessage](configuring-playbook-bridge-mautrix-wsproxy.md)
Announce mautrix-wsproxy support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2261
2023-08-23 12:11:08 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Appservice IRC bridging](configuring-playbook-bridge-appservice-irc.md)
Add matrix-appservice-discord bridge Bridge is setup to work on the matrix side with this, but the discord invite link is not automatically generated.
2019-03-03 17:22:52 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Appservice Discord bridging](configuring-playbook-bridge-appservice-discord.md)
Added Slack role
2019-06-10 14:52:48 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Appservice Slack bridging](configuring-playbook-bridge-appservice-slack.md)
Merge branch 'master' into master
2019-08-21 04:34:20 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Appservice Kakaotalk bridging](configuring-playbook-bridge-appservice-kakaotalk.md)
Add matrix-appservice-kakaotalk support Adds support for: https://src.miscworks.net/fair/matrix-appservice-kakaotalk This is pretty similar to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1977 which just appeared, but has mostly been done independently. I've taken some inspiration and did some fixups based on that PR. Thanks to https://github.com/hnarjis for taking the time to contribute! Notable differences between this branch compared to that PR: - better naming and documentation around the "configuration" variables - no unnecessary (5 sec.) intentional delay when starting `matrix-appservice-kakaotalk-node.service` - stores configuration in `config/`, not in `data/` - passes configuration as read-only and starts the bridge with (`--no-update`) to ensure no changes are made to it - starts containers more securely - with `matrix:matrix` user:group (not `root`) and reduced capabilities (`--cap-drop=ALL`) - uses `tcp` for communication between the "node" and the appservice (simpler than sharing unix sockets) - `registration.yaml` which is closer to the one generated by `matrix-appservice-kakaotalk` (no `de.sorunome.msc2409.push_ephemeral` stuff, etc.) - `registration.yaml` which is more customizable (customizable bot username and prefix for puppets - see `matrix_appservice_kakaotalk_appservice_bot_username` and `matrix_appservice_kakaotalk_user_prefix`) - less fragile and more extensible bridge permissions configuration via `matrix_appservice_kakaotalk_bridge_permissions`. Doing `{% if matrix_admin %}` in the bridge configuration sometimes causes syntax problems (I hit some myself) and is not ideal. Other bridges should be redone as well. - configurable command prefix for the bridge, instead of hardcoding `!kt` (see `matrix_appservice_kakaotalk_command_prefix`) - logging that is more consistent with the rest of the playbook (console / journald only, no logging to files), as well as configurable log level (via `matrix_appservice_kakaotalk_logging_level`) - somewhat more detailed documentation (`docs/configuring-playbook-bridge-appservice-kakaotalk.md`) - removed some dead code (data relocation tasks from `tasks/setup_install.yml`, as well as likely unnecessary SQLite -> Postgres migration)
2022-07-25 11:34:21 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Beeper LinkedIn bridging](configuring-playbook-bridge-beeper-linkedin.md)
Add matrix-appservice-kakaotalk support Adds support for: https://src.miscworks.net/fair/matrix-appservice-kakaotalk This is pretty similar to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1977 which just appeared, but has mostly been done independently. I've taken some inspiration and did some fixups based on that PR. Thanks to https://github.com/hnarjis for taking the time to contribute! Notable differences between this branch compared to that PR: - better naming and documentation around the "configuration" variables - no unnecessary (5 sec.) intentional delay when starting `matrix-appservice-kakaotalk-node.service` - stores configuration in `config/`, not in `data/` - passes configuration as read-only and starts the bridge with (`--no-update`) to ensure no changes are made to it - starts containers more securely - with `matrix:matrix` user:group (not `root`) and reduced capabilities (`--cap-drop=ALL`) - uses `tcp` for communication between the "node" and the appservice (simpler than sharing unix sockets) - `registration.yaml` which is closer to the one generated by `matrix-appservice-kakaotalk` (no `de.sorunome.msc2409.push_ephemeral` stuff, etc.) - `registration.yaml` which is more customizable (customizable bot username and prefix for puppets - see `matrix_appservice_kakaotalk_appservice_bot_username` and `matrix_appservice_kakaotalk_user_prefix`) - less fragile and more extensible bridge permissions configuration via `matrix_appservice_kakaotalk_bridge_permissions`. Doing `{% if matrix_admin %}` in the bridge configuration sometimes causes syntax problems (I hit some myself) and is not ideal. Other bridges should be redone as well. - configurable command prefix for the bridge, instead of hardcoding `!kt` (see `matrix_appservice_kakaotalk_command_prefix`) - logging that is more consistent with the rest of the playbook (console / journald only, no logging to files), as well as configurable log level (via `matrix_appservice_kakaotalk_logging_level`) - somewhat more detailed documentation (`docs/configuring-playbook-bridge-appservice-kakaotalk.md`) - removed some dead code (data relocation tasks from `tasks/setup_install.yml`, as well as likely unnecessary SQLite -> Postgres migration)
2022-07-25 11:34:21 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up matrix-hookshot](configuring-playbook-bridge-hookshot.md) - a bridge between Matrix and multiple project management services, such as [GitHub](https://github.com), [GitLab](https://about.gitlab.com) and [JIRA](https://www.atlassian.com/software/jira).
Update changelog and configuring-playbook.md This announces matrix-hookshot support that got added in https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1505
2022-02-01 12:07:43 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up MX Puppet Slack bridging](configuring-playbook-bridge-mx-puppet-slack.md)
Announce mx-puppet-slack support Related to #454 (Github Pull Request).
2020-04-23 15:03:36 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up MX Puppet Instagram bridging](configuring-playbook-bridge-mx-puppet-instagram.md)
Announce mx-puppet-instagram and mx-puppet-twitter support Related to #551 and #555 (Github Pull Requests).
2020-06-30 14:51:56 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up MX Puppet Twitter bridging](configuring-playbook-bridge-mx-puppet-twitter.md)
Announce mx-puppet-instagram and mx-puppet-twitter support Related to #551 and #555 (Github Pull Requests).
2020-06-30 14:51:56 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md)
Announce mx-puppet-discord bridging support Related to #540 (Github Pull Request).
2020-07-01 16:01:14 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up MX Puppet GroupMe bridging](configuring-playbook-bridge-mx-puppet-groupme.md)
Add docs
2021-02-13 15:55:54 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up MX Puppet Steam bridging](configuring-playbook-bridge-mx-puppet-steam.md)
Announce mx-puppet-steam bridging support Related to #557 (Github Pull Request).
2020-07-03 09:10:57 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md)
Add Go Skype Bridge Based on mautrix-whatsapp, as that's what the bridge software is based on.
2022-06-12 21:29:43 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Email2Matrix](configuring-playbook-email2matrix.md)
matrix-sms-bridge: added docs, added seperate service for database, pr comments
2020-05-23 11:14:24 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Postmoogle email bridging](configuring-playbook-bridge-postmoogle.md)
Announce Postmoogle email bridge bot Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2043
2022-08-23 11:16:07 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Matrix SMS bridging](configuring-playbook-bridge-matrix-bridge-sms.md)
Add support for matrix-reminder-bot
2020-07-20 11:13:08 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Heisenbridge bouncer-style IRC bridging](configuring-playbook-bridge-heisenbridge.md)
Add Heisenbridge
2021-05-12 12:24:39 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up WeChat bridging](configuring-playbook-bridge-wechat.md)
Add support for WeChat bridging This is based on the PR (https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3241) by Tobias Diez (https://github.com/tobiasdiez). I've refactored some parts, made it more configurable, polished it up, and it's integrated into the playbook now. Both the WeChat bridge and WeChat agent appear to be working. The WeChat bridge joins rooms and responds as expected. That said, end-to-end testing (actually bridging to a WeChat account) has not been done yet. Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/701 Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3092 This is sponsored https://etke.cc/ work related to https://gitlab.com/etke.cc/ansible/-/issues/2 Squashed commit of the following: commit fdd37f02472a0b83d61b4fac80650442f90e7629 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 21:05:53 2024 +0300 Add documentation for WeChat bridge commit 8426fc8b95bb160ea7f9659bd45bc59cf1326614 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:59:42 2024 +0300 Rename directory for matrix_wechat_agent_container_src_files_path commit da200df82bbc9153d307095dd90e4769c400ea1e Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:58:26 2024 +0300 Make WeChat listen_secret configurable and auto-configured via matrix_homeserver_generic_secret_key commit 4022cb1355828ac16af7d9228cb1066962bb35f5 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:54:56 2024 +0300 Refactor install.yml for WeChat a bit (using blocks, etc.) commit d07a39b4c4f6b93d04204e13e384086d5a242d52 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:52:35 2024 +0300 Rename WeChat Agent configuration file This makes it more clear that it belongs to the agent. Otherwise, `config.yaml` and `configure.yaml` make you wonder. commit ccca72f8d1e602f7c42f4bd552193afa153c9b9d Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:49:06 2024 +0300 Move WeChat agent configuration to a template commit a4047d94d8877b4095712dfc76ac3082a1edca28 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:47:17 2024 +0300 Mount WeChat config as readonly and instruct bridge to not update it commit bc0e89f345bf14bbdbfd574bb60d93918c2ac053 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:46:33 2024 +0300 Sync WeChat config with upstream Brings up-to-date with: https://github.com/duo/matrix-wechat/commits/0.2.4/example-config.yaml commit a46f5b9cbc8bf16042685a18c77d25a606bc8232 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 19:48:17 2024 +0300 Rename some files commit 3877679040cffc4ca6cccfa21a7335f8f796f06e Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 19:47:10 2024 +0300 Update WeChat logging config This brings it up-to-date with what mautrix-go uses. Otherwise, on startup we see: > Migrating legacy log config .. and it gets migrated to what we've done here. commit e3e95ab234651867c7a975a08455549b31db4172 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 19:43:37 2024 +0300 Make sure matrix-wechat-agent runs as 1000:1000 It needs to write stuff to `/home/user/.vnc`. `/home/user` is owned by `user:group` (`1000:1000`), so it cannot run any other way. Previously, if the `matrix` user was uid=1000 by chance, it would work, but that's pure luck. commit 4d5748ae9b84c81d6b48b0a41b790339d9ac4724 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 18:57:09 2024 +0300 Pin wechat and wechat-agent versions commit 40d40009f19ebceed4126146cbb510a2c95af671 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 18:53:58 2024 +0300 docker_image -> container_image for WeChat bridge commit cc33aff592541913070d13288d17b04ed6243176 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 18:00:25 2024 +0300 docker_src -> container_src in WeChat bridge commit 42e6ae9a6483c8ca6d53b8052058d41d90d93797 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 17:54:24 2024 +0300 matrix_go_wechat_ -> matrix_wechat_ The bridge is written in Go, but does not include Go anywhere in its name. As such, it's mostly useless to use `matrix_go_wechat` as the prefix. commit d6662a69d1916d215d5184320c36d2ef73afd3e9 Author: Tobias Diez <code@tobiasdiez.de> Date: Mon Mar 25 10:55:16 2024 +0800 Add wechat bridge
2024-06-03 18:06:19 +00:00
Add support for matrix-reminder-bot
2020-07-20 11:13:08 +00:00
### Bots
Update docs/configuring-playbook.md and docs/container-images.md: add explanations to each section These sentences are copied from README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:48:34 +00:00
Bots provide various additional functionality to your installation.
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [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))
Add support for baibot Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3369
2024-09-12 12:19:40 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) - a bot to remind you about stuff
Announce Go-NEB support
2021-03-16 05:54:26 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up matrix-registration-bot](configuring-playbook-bot-matrix-registration-bot.md) - a bot to create and manage registration tokens to invite users
Link to Buscarron bot from configuring docs page Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1782
2022-04-25 07:37:35 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up maubot](configuring-playbook-bot-maubot.md) - a plugin-based Matrix bot system
Add docs Unrelated to the original branch I added the matrix-registration bot as it was missing in the readme
2022-07-11 11:28:23 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Honoroit](configuring-playbook-bot-honoroit.md) - a helpdesk bot
added honoroit
2022-01-06 18:30:10 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Mjolnir](configuring-playbook-bot-mjolnir.md) - a moderation tool/bot
Add Sygnal support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/683
2021-03-20 11:31:34 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Draupnir](configuring-playbook-bot-draupnir.md) - a moderation tool/bot, forked from Mjolnir and maintained by its former leader developer
Announce Draupnir support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2451
2023-02-10 09:52:25 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Draupnir for all/D4A](configuring-playbook-appservice-draupnir-for-all.md) - like the [Draupnir bot](configuring-playbook-bot-draupnir.md) mentioned above, but running in appservice mode and supporting multiple instances
Add support for D4A/Draupnir For All to the playbook. (#3204) * Draupnir for all Role * Draupnir for all Documentation * Pin D4A to Develop until D4A patches are in a release. * Update D4A Docs to mention pros and cons of D4A mode compared to normal * Change Documentation to mention a fixed simpler provisioning flow. Use of /plain allows us to bypass the bugs encountered during the development of this role with clients attempting to escape our wildcards causing the grief that led to using curl. This reworded commit does still explain you can automatically inject stuff into the room if you wanted to. * Emphasise the State of D4A mode * Link to Draupnir-for-all docs and tweak the docs some * Link to Draupnir-for-all from Draupnir documentation page * Announce Draupnir-for-all --------- Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-03-05 14:09:52 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up Buscarron](configuring-playbook-bot-buscarron.md) - a bot you can use to send any form (HTTP POST, HTML) to a (encrypted) Matrix room
Link to Buscarron bot from configuring docs page Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1782
2022-04-25 07:37:35 +00:00
Update docs/configuring-playbook.md: create "Administration" section Reorganize "Additional useful services" section and "Other specialized services" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:24:41 +00:00
### Administration
Update docs/configuring-playbook.md: move "Additional useful services" section down under "Bots" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:21:11 +00:00
Update docs/configuring-playbook.md and docs/container-images.md: add explanations to each section These sentences are copied from README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:48:34 +00:00
Services that help you in administrating and monitoring your Matrix installation.
Update docs/configuring-playbook.md: create "Administration" section Reorganize "Additional useful services" section and "Other specialized services" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:24:41 +00:00
- [Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver](configuring-playbook-alertmanager-receiver.md)
Update docs/configuring-playbook.md: move "Additional useful services" section down under "Bots" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:21:11 +00:00
- [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md)
Fix broken anchor links Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-17 12:30:47 +00:00
- [Enabling metrics and graphs for NginX logs](configuring-playbook-prometheus-nginxlog.md)
Update docs/configuring-playbook.md: move "Additional useful services" section down under "Bots" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:21:11 +00:00
Update docs/configuring-playbook.md: create "Administration" section Reorganize "Additional useful services" section and "Other specialized services" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:24:41 +00:00
- [Setting up the rageshake bug report server](configuring-playbook-rageshake.md)
Update docs/configuring-playbook.md: move "Additional useful services" section down under "Bots" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:21:11 +00:00
- [Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md)
Add Sygnal support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/683
2021-03-20 11:31:34 +00:00
Update docs/configuring-playbook.md: create "Administration" section Reorganize "Additional useful services" section and "Other specialized services" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:24:41 +00:00
- Backups:
- [Setting up BorgBackup](configuring-playbook-backup-borg.md) - a full Matrix server backup solution, including the Postgres database
Announce borg backup support Related to: - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1727 - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1754 - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1755 - https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/467
2022-04-19 16:29:41 +00:00
Update docs/configuring-playbook.md: create "Administration" section Reorganize "Additional useful services" section and "Other specialized services" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:24:41 +00:00
- [Setting up postgres backup](configuring-playbook-postgres-backup.md) - a Postgres-database backup solution (note: does not include other files)
Announce borg backup support Related to: - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1727 - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1754 - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1755 - https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/467
2022-04-19 16:29:41 +00:00
Update docs/configuring-playbook.md: create "Administration" section Reorganize "Additional useful services" section and "Other specialized services" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:24:41 +00:00
### Other specialized services
Announce borg backup support Related to: - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1727 - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1754 - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1755 - https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/467
2022-04-19 16:29:41 +00:00
Update docs/configuring-playbook.md and docs/container-images.md: add explanations to each section These sentences are copied from README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:48:34 +00:00
Various services that don't fit any other categories.
Update docs/configuring-playbook.md: move entries to "Other specialized services" section These entries are ones categorized under "Misc" section on README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:34:26 +00:00
- [Setting up Synapse Auto Invite Accept](configuring-playbook-synapse-auto-accept-invite.md)
Add Sygnal support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/683
2021-03-20 11:31:34 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up synapse-auto-compressor](configuring-playbook-synapse-auto-compressor.md) for compressing the database on Synapse homeservers
Announce matrix-synapse-auto-compressor
2023-03-12 08:55:08 +00:00
Update docs/configuring-playbook.md: move entries to "Other specialized services" section These entries are ones categorized under "Misc" section on README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:34:26 +00:00
- [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (advanced)
Update docs/configuring-playbook.md: add link to configuring-playbook-synapse-auto-accept-invite.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-27 11:36:54 +00:00
Update docs/configuring-playbook.md: move entries to "Other specialized services" section These entries are ones categorized under "Misc" section on README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 05:34:26 +00:00
- [Setting up Etherpad](configuring-playbook-etherpad.md)
- [Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md)
- [Setting up Cactus Comments](configuring-playbook-cactus-comments.md) - a federated comment system built on Matrix
- [Setting up Pantalaimon (E2EE aware proxy daemon)](configuring-playbook-pantalaimon.md) (advanced)
Announce sliding-sync support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2515
2023-03-07 10:22:04 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up the Sygnal push gateway](configuring-playbook-sygnal.md)
matrix-ntfy: documentation
2022-06-27 21:20:02 +00:00
Update docs/configuring-playbook.md: remove "optional" from links Setting "optional" is redundant for those entries, as all of them are under the heading "Other configuration options" and it is obvious that those settings are optional. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-03 04:45:55 +00:00
- [Setting up the ntfy push notifications server](configuring-playbook-ntfy.md)
Add documentation to readme/list of services Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net>
2022-09-16 17:15:33 +00:00
Update docs/configuring-playbook.md: create "Deprecated / unmaintained / removed services" section Create a dedicated section for deprecated, unmaintained, or removed services such as: - Appservice Webhooks - Dimension - Go-NEB - matrix-bot-chatgpt - Mautrix Facebook - Mautrix Hangouts - Mautrix Instagram - MX Puppet Skype Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-26 13:58:58 +00:00
### Deprecated / unmaintained / removed services
Add disclaimer to the deprecated services section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-26 16:11:06 +00:00
**Note**: since a deprecated or unmaintained service will not be updated, its bug or vulnerability will be unlikely to get patched. It is recommended to migrate from the service to an alternative if any, and make sure to do your own research before you decide to keep it running nonetheless.
De-emphasize the old sliding-sync proxy further Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3735
2024-11-05 07:41:16 +00:00
- [Setting up the Sliding Sync proxy](configuring-playbook-sliding-sync-proxy.md) for clients which require Sliding Sync support (like old Element X versions, before it got switched to Simplified Sliding Sync)
Update docs/configuring-playbook.md: create "Deprecated / unmaintained / removed services" section Create a dedicated section for deprecated, unmaintained, or removed services such as: - Appservice Webhooks - Dimension - Go-NEB - matrix-bot-chatgpt - Mautrix Facebook - Mautrix Hangouts - Mautrix Instagram - MX Puppet Skype Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-26 13:58:58 +00:00
- [Setting up Appservice Webhooks bridging](configuring-playbook-bridge-appservice-webhooks.md) (deprecated; the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md))
- [Setting up the Dimension integration manager](configuring-playbook-dimension.md) ([unmaintained](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2806#issuecomment-1673559299); after [installing](installing.md))
- [Setting up Go-NEB](configuring-playbook-bot-go-neb.md) (unmaintained; the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md))
- [Setting up matrix-bot-chatgpt](configuring-playbook-bot-chatgpt.md) (unmaintained; the bridge's author suggests taking a look at [baibot](https://github.com/etkecc/baibot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bot-baibot.md))
- [Setting up Mautrix Facebook bridging](configuring-playbook-bridge-mautrix-facebook.md) (deprecated in favor of the Messenger/Instagram bridge with [mautrix-meta-messenger](configuring-playbook-bridge-mautrix-meta-messenger.md))
- [Setting up Mautrix Hangouts bridging](configuring-playbook-bridge-mautrix-hangouts.md) (deprecated in favor of the Google Chat bridge with [mautrix-googlechat](configuring-playbook-bridge-mautrix-googlechat.md))
- [Setting up Mautrix Instagram bridging](configuring-playbook-bridge-mautrix-instagram.md) (deprecated in favor of the Messenger/Instagram bridge with [mautrix-meta-instagram](configuring-playbook-bridge-mautrix-meta-instagram.md))
- [Setting up MX Puppet Skype bridging](configuring-playbook-bridge-mx-puppet-skype.md) (removed; this component has been broken for a long time, so it has been removed from the playbook. Consider [setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md))
Reference in New Issue Copy Permalink