2024-11-05 13:38:26 +01:00
# Configuring the playbook
2018-08-08 09:07:02 +02:00
Add "Quick start" guide (#3801)
* Add docs/quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add description about keeping the playbook and services up-to-date
Also: move descriptions about difference between the playbook tags (setup-all and install-all) and about the just "recipe" from installing.md to maintenance-upgrading-services.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace <your-username> with YOUR_USERNAME_HERE
This is a common expression and should avoid misunderstanding that `<` and `>` would need to be included
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace <your-password> with YOUR_PASSWORD_HERE
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Change the link to 'Quick start' on the breadcrumbs from README.md to quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add a link to quick-start.md on the "Getting started" section
Since I am not quite sure whether the link to prerequisites.md should be replaced in favor of this link, this commit leaves it as it is for now.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add a link to quick-start.md on docs/README.md
Since I am not quite sure whether the link to prerequisites.md should be replaced in favor of this link, this commit leaves it as it is for now.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add note about using "example.com" as an example domain
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Remove backticks from command examples to register a user
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Apply suggestions from code review
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
* Improve notes for instruction to create a user account
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add details about delegation to installing.md and quick-start.md
Some information is omitted on quick-start.md in favor of installing.md to keep the quick start guide simple.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/quick-start.md: add the breadcrumb header
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Edit docs/quick-start.md: run the setup command with install-all by default
Refer docs/maintenance-upgrading-services.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Revert "Update docs/quick-start.md: add the breadcrumb header"
This reverts commit 9a6e1cf14c7638953fc8fbb8b487ea0afd0a41ad.
As the quick start guide is standalone.
* Update docs/quick-start.md: add headers inside the install section
These headers should make it perfectly clear that there are two steps to be done to install with the playbook
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update quick-start.md
* Update docs/registering-users.md: notes for manual user registeration
Copy the same notes from quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Reword some things in quick start
* Add alternative to `just roles`
* Update docs/configuring-dns.md: sync with docs/quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/quick-start.md: add a link to docs/registering-users.md for an instruction to add user accounts
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/registering-users.md and docs/updating-users-passwords.md: remove "your" from username and password placeholders
These documentations, unlike docs/installing.md and docs/quick-start.md, describe how to handle users (registering them or changing their passwords), some of whom are yours, while others are not.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/installing.md: add "your" to make it clear that it is "your" account that is going to be created
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/installing.md and docs/quick-start.md: mention "make roles"
This commit adds mentions to "make roles" and a note about the preference of ansible-playbook commands over the just "recipes".
quick-start.md intends to be referred by those who have never used the playbook to set up a server, so it is safer to regard that it is not clear to them what exactly the just "recipes" are made of, ie. it takes some time and experience until someone understands simplicity of them. For beginners, I believe that we should prefer the basics over simplicity, from the educational point of view.
If someone feels tired of using the same command repetitively, then the person will have been already well accustomed to the way how the playbook works and how the server is supposed to be maintained, and the person is "qualified" to use the just "recipes", and should be able to use them with confidence, distinguishing the playbook tags from the "recipes", for example, from "just install-all" and "ansible-playbook -i inventory/hosts setup.yml --tags=install-all". Such level of familiarity and experience should not be expected on the quick start guide.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update instructions to update Ansible roles
Also: move the detailed explanation about "just roles" from installing.md to maintenance-upgrading-services.md
TBD: create a dedicated documentation for the "just" program and the concept of its "recipe" (shortcut of commands)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add a note about cases to create multiple accounts/users
Since one of the quick start guide's goals is to set up an own user account, this commit adds the note about creating multiple accounts/users to installing.md and registering-users.md only. It should be fine as registering-users.md is linked from quick-start.md
Also:
- On installing.md and quick-start.md, change instruction from what encourages to select "admin=yes" or "admin=no" to what encourages to use "admin=yes", since your user account will be the sole user on the server, as long as you set up the server by following the documentation
- Remove the link to registering-users.md from quick-start.md as the documentation is already linked above, under the header of the section
- Sync docs/installing.md with other documentation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Remove a line about setting "admin=yes" to reduce the amount of information
Because quick-start.md is getting longer with much information, it removes the note in favor of the linked registering-users.md documentation. The note is available on installing.md as well, and details about adding user accounts for other people can (and should) be checked on those documentations.
Also, this commit edits lines above these notes to make it clear that your user account will be an administrator of the server.
With this commit, the amount of the information about adding user accounts will be: registering-users.md > installing.md > quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Fix a broken anchor link on docs/installing.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace repetitive information about upgrading with an anchor link to docs/maintenance-upgrading-services.md
Because details to update/upgrade the Matrix services is not necessary for quick start and the amount of information should be reduced from the viewpoint of maintainability, this commit removes details to update/upgrade from quick-start.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/quick-start.md: add a note about keeping it tidy and simple
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/maintenance-checking-services.md and docs/quick-start.md: add instruction to use federation tester against the base domain
Per Slavi's suggestion.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/installing.md and docs/quick-start.md: replace commands to finalize the installation
Per Slavi's suggestion.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Clarify install-matrix-static-files to avoid confusion with install-all; Minor consistency improvements
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-11-23 08:59:29 +01:00
< sup > ⚡️[Quick start](quick-start.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 >
2024-11-05 13:38:26 +01:00
2024-11-09 19:28:27 +01: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:
2018-08-08 09:07:02 +02:00
2024-10-18 12:06:05 +02:00
1. create a directory to hold your configuration (`mkdir -p inventory/host_vars/matrix.example.com` where `example.com` is your "base domain")
2018-08-08 09:07:02 +02:00
2024-10-18 12:06:05 +02:00
2. copy the sample configuration file (`cp examples/vars.yml inventory/host_vars/matrix.example.com/vars.yml`)
2018-08-08 09:07:02 +02:00
2024-10-18 12:06:05 +02: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.
2018-08-08 09:07:02 +02:00
2024-10-18 12:06:05 +02:00
4. copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`)
2018-08-08 09:07:02 +02:00
2024-10-18 12:06:05 +02:00
5. edit the inventory hosts file (`inventory/hosts`) to your liking
2018-08-08 09:07:02 +02:00
2024-10-18 12:06:05 +02: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.
2024-01-09 18:08:43 +01:00
2024-10-18 12:06:05 +02: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 ).
2018-08-08 09:07:02 +02:00
For a basic Matrix installation, that's all you need.
2024-10-18 12:06:05 +02:00
2018-08-08 09:07:02 +02:00
For a more custom setup, see the [Other configuration options ](#other-configuration-options ) below.
2024-11-09 19:51:36 +01:00
[▶️ ](installing.md ) When you're done with all the configuration you'd like to do, continue with [Installing ](installing.md ).
2018-08-08 09:07:02 +02:00
## Other configuration options
2019-04-19 08:54:18 +02:00
### Core service adjustments
2018-08-14 13:11:41 +02:00
2022-10-27 08:48:49 +02:00
- Homeserver configuration:
2024-11-03 05:45:55 +01:00
- [Configuring Synapse ](configuring-playbook-synapse.md ), if you're going with the default/recommended homeserver implementation
2022-10-27 08:48:49 +02:00
2024-11-03 05:45:55 +01:00
- [Configuring Conduit ](configuring-playbook-conduit.md ), if you've switched to the [Conduit ](https://conduit.rs ) homeserver implementation
2019-08-22 08:49:22 +02:00
2024-11-03 05:45:55 +01:00
- [Configuring Dendrite ](configuring-playbook-dendrite.md ), if you've switched to the [Dendrite ](https://matrix-org.github.io/dendrite ) homeserver implementation
2022-11-20 09:11:21 +01:00
2024-11-03 06:13:11 +01:00
- Server components:
- [Using an external PostgreSQL server ](configuring-playbook-external-postgres.md )
2023-07-17 21:37:53 +02:00
2024-11-03 06:13:11 +01:00
- [Adjusting TURN server configuration ](configuring-playbook-turn.md ) (advanced)
2024-10-25 09:26:35 +02:00
2024-11-03 06:13:11 +01:00
- [Configuring the Traefik reverse-proxy ](configuring-playbook-traefik.md ) (advanced)
2018-08-08 09:07:02 +02:00
2024-11-03 06:13:11 +01:00
- [Using your own webserver, instead of this playbook's Traefik reverse-proxy ](configuring-playbook-own-webserver.md ) (advanced)
2018-08-08 09:07:02 +02:00
2024-11-03 06:13:11 +01:00
- [Adjusting SSL certificate retrieval ](configuring-playbook-ssl-certificates.md ) (advanced)
2018-12-23 10:00:12 +01:00
2024-11-03 06:13:11 +01: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 )
2024-11-03 06:16:31 +01:00
- Server connectivity:
- [Enabling Telemetry for your Matrix server ](configuring-playbook-telemetry.md )
- [Controlling Matrix federation ](configuring-playbook-federation.md )
2024-11-03 05:59:15 +01:00
### Clients
2024-11-03 06:48:34 +01: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 15:31:26 +01:00
- [Configuring Element Web ](configuring-playbook-client-element-web.md ), if you're going with the default/recommended client
2024-11-03 05:59:15 +01: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 15:31:26 +01: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
2024-11-03 05:59:15 +01:00
2019-04-19 08:54:18 +02:00
### Authentication and user-related
2024-11-03 06:48:34 +01:00
Extend and modify how users are authenticated on your homeserver.
2024-11-03 05:45:55 +01:00
- [Setting up Matrix Authentication Service ](configuring-playbook-matrix-authentication-service.md ) (Next-generation auth for Matrix, based on OAuth 2.0/OIDC)
2024-10-19 13:31:14 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Appservice Double Puppet ](configuring-playbook-appservice-double-puppet.md )
2024-08-17 18:00:16 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Synapse Admin ](configuring-playbook-synapse-admin.md )
2020-07-22 07:10:26 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up matrix-registration ](configuring-playbook-matrix-registration.md )
2020-09-01 12:46:05 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up the REST authentication password provider module ](configuring-playbook-rest-auth.md ) (advanced)
2018-08-20 16:11:55 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up the Shared Secret Auth password provider module ](configuring-playbook-shared-secret-auth.md ) (advanced)
2018-08-21 12:34:34 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up the LDAP authentication password provider module ](configuring-playbook-ldap-auth.md ) (advanced)
2018-11-28 10:21:03 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up matrix-ldap-registration-proxy ](configuring-playbook-matrix-ldap-registration-proxy.md ) (advanced)
2022-09-16 19:15:33 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Synapse Simple Antispam ](configuring-playbook-synapse-simple-antispam.md ) (advanced)
2019-09-09 07:13:06 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Matrix User Verification Service ](configuring-playbook-user-verification-service.md ) (advanced)
2024-03-24 17:25:19 +01:00
2024-11-03 06:19:15 +01:00
### File Storage
2024-11-03 06:48:34 +01:00
Use alternative file storage to the default `media_store` folder.
2024-11-17 13:30:47 +01:00
- [Storing Matrix media files on Amazon S3 with Goofys ](configuring-playbook-s3-goofys.md )
2024-11-03 06:19:15 +01: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 )
2019-04-19 08:54:18 +02:00
### Bridging other networks
2024-11-03 06:48:34 +01:00
Bridges can be used to connect your Matrix installation with third-party communication networks.
2024-11-03 05:45:55 +01:00
- [Setting up Mautrix Discord bridging ](configuring-playbook-bridge-mautrix-discord.md )
2022-07-22 16:55:44 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Mautrix Telegram bridging ](configuring-playbook-bridge-mautrix-telegram.md )
2018-10-26 18:44:58 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Mautrix Slack bridging ](configuring-playbook-bridge-mautrix-slack.md )
2023-01-11 09:38:54 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up Mautrix Google Messages bridging ](configuring-playbook-bridge-mautrix-gmessages.md )
2023-07-21 13:33:52 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Mautrix Whatsapp bridging ](configuring-playbook-bridge-mautrix-whatsapp.md )
2019-01-31 06:37:23 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up Instagram bridging via Mautrix Meta ](configuring-playbook-bridge-mautrix-meta-instagram.md )
2024-02-19 09:13:36 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up Messenger bridging via Mautrix Meta ](configuring-playbook-bridge-mautrix-meta-messenger.md )
2024-02-19 09:13:36 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up Mautrix Google Chat bridging ](configuring-playbook-bridge-mautrix-googlechat.md )
2021-10-12 13:45:04 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Mautrix Twitter bridging ](configuring-playbook-bridge-mautrix-twitter.md )
2021-04-11 08:45:27 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Mautrix Signal bridging ](configuring-playbook-bridge-mautrix-signal.md )
2020-10-25 18:44:19 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up Mautrix wsproxy for bridging Android SMS or Apple iMessage ](configuring-playbook-bridge-mautrix-wsproxy.md )
2023-08-23 14:11:08 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Appservice IRC bridging ](configuring-playbook-bridge-appservice-irc.md )
2019-03-03 18:22:52 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up Appservice Discord bridging ](configuring-playbook-bridge-appservice-discord.md )
2019-06-10 16:52:48 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Appservice Slack bridging ](configuring-playbook-bridge-appservice-slack.md )
2019-08-21 06:34:20 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Appservice Kakaotalk bridging ](configuring-playbook-bridge-appservice-kakaotalk.md )
2022-07-25 13:34:21 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Beeper LinkedIn bridging ](configuring-playbook-bridge-beeper-linkedin.md )
2022-07-25 13:34:21 +02:00
2024-11-03 05:45:55 +01: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 ).
2022-02-01 13:07:43 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up MX Puppet Slack bridging ](configuring-playbook-bridge-mx-puppet-slack.md )
2020-04-23 17:03:36 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up MX Puppet Instagram bridging ](configuring-playbook-bridge-mx-puppet-instagram.md )
2020-06-30 16:51:56 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up MX Puppet Twitter bridging ](configuring-playbook-bridge-mx-puppet-twitter.md )
2020-06-30 16:51:56 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up MX Puppet Discord bridging ](configuring-playbook-bridge-mx-puppet-discord.md )
2020-07-01 18:01:14 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up MX Puppet GroupMe bridging ](configuring-playbook-bridge-mx-puppet-groupme.md )
2021-02-13 16:55:54 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up MX Puppet Steam bridging ](configuring-playbook-bridge-mx-puppet-steam.md )
2020-07-03 11:10:57 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Go Skype Bridge bridging ](configuring-playbook-bridge-go-skype-bridge.md )
2022-06-12 23:29:43 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Email2Matrix ](configuring-playbook-email2matrix.md )
2020-05-23 13:14:24 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Postmoogle email bridging ](configuring-playbook-bridge-postmoogle.md )
2022-08-23 13:16:07 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Matrix SMS bridging ](configuring-playbook-bridge-matrix-bridge-sms.md )
2020-07-20 13:13:08 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Heisenbridge bouncer-style IRC bridging ](configuring-playbook-bridge-heisenbridge.md )
2021-05-12 14:24:39 +02:00
2024-11-03 05:45:55 +01: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 20:06:19 +02:00
2020-07-20 13:13:08 +02:00
### Bots
2024-11-03 06:48:34 +01:00
Bots provide various additional functionality to your installation.
2024-11-03 05:45:55 +01: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 ))
2024-09-12 14:19:40 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up matrix-reminder-bot ](configuring-playbook-bot-matrix-reminder-bot.md ) - a bot to remind you about stuff
2021-03-16 06:54:26 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up matrix-registration-bot ](configuring-playbook-bot-matrix-registration-bot.md ) - a bot to create and manage registration tokens to invite users
2022-04-25 09:37:35 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up maubot ](configuring-playbook-bot-maubot.md ) - a plugin-based Matrix bot system
2022-07-11 13:28:23 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up Honoroit ](configuring-playbook-bot-honoroit.md ) - a helpdesk bot
2022-01-06 19:30:10 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up Mjolnir ](configuring-playbook-bot-mjolnir.md ) - a moderation tool/bot
2021-03-20 12:31:34 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up Draupnir ](configuring-playbook-bot-draupnir.md ) - a moderation tool/bot, forked from Mjolnir and maintained by its former leader developer
2023-02-10 10:52:25 +01:00
2024-11-03 05:45:55 +01: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
2024-03-05 15:09:52 +01:00
2024-11-03 05:45:55 +01: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
2022-04-25 09:37:35 +02:00
2024-11-03 06:24:41 +01:00
### Administration
2024-11-03 06:21:11 +01:00
2024-11-03 06:48:34 +01:00
Services that help you in administrating and monitoring your Matrix installation.
2024-11-03 06:24:41 +01:00
- [Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver ](configuring-playbook-alertmanager-receiver.md )
2024-11-03 06:21:11 +01:00
- [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server ](configuring-playbook-prometheus-grafana.md )
2024-11-17 13:30:47 +01:00
- [Enabling metrics and graphs for NginX logs ](configuring-playbook-prometheus-nginxlog.md )
2024-11-03 06:21:11 +01:00
2024-11-03 06:24:41 +01:00
- [Setting up the rageshake bug report server ](configuring-playbook-rageshake.md )
2024-11-03 06:21:11 +01:00
- [Enabling synapse-usage-exporter for Synapse usage statistics ](configuring-playbook-synapse-usage-exporter.md )
2021-03-20 12:31:34 +01:00
2024-11-03 06:24:41 +01:00
- Backups:
- [Setting up BorgBackup ](configuring-playbook-backup-borg.md ) - a full Matrix server backup solution, including the Postgres database
2022-04-19 18:29:41 +02:00
2024-11-03 06:24:41 +01:00
- [Setting up postgres backup ](configuring-playbook-postgres-backup.md ) - a Postgres-database backup solution (note: does not include other files)
2022-04-19 18:29:41 +02:00
2024-11-03 06:24:41 +01:00
### Other specialized services
2022-04-19 18:29:41 +02:00
2024-11-03 06:48:34 +01:00
Various services that don't fit any other categories.
2024-11-03 06:34:26 +01:00
- [Setting up Synapse Auto Invite Accept ](configuring-playbook-synapse-auto-accept-invite.md )
2021-03-20 12:31:34 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up synapse-auto-compressor ](configuring-playbook-synapse-auto-compressor.md ) for compressing the database on Synapse homeservers
2023-03-12 09:55:08 +01:00
2024-11-03 06:34:26 +01:00
- [Setting up Matrix Corporal ](configuring-playbook-matrix-corporal.md ) (advanced)
2024-10-27 12:36:54 +01:00
2024-11-03 06:34:26 +01: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)
2023-03-07 11:22:04 +01:00
2024-11-03 05:45:55 +01:00
- [Setting up the Sygnal push gateway ](configuring-playbook-sygnal.md )
2022-06-27 23:20:02 +02:00
2024-11-03 05:45:55 +01:00
- [Setting up the ntfy push notifications server ](configuring-playbook-ntfy.md )
2022-09-16 19:15:33 +02:00
2024-10-26 15:58:58 +02:00
### Deprecated / unmaintained / removed services
2024-10-26 18:11:06 +02: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.
2024-11-05 08:41:16 +01: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)
2024-10-26 15:58:58 +02: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 ))
