matrix-docker-ansible-deploy/docs/README.md

Table of Contents

⬇️ Installaton guides

There are two installation guides available for beginners and advanced users.

• ⚡ Quick start (for beginners): this is recommended for those who do not have an existing Matrix server and want to start quickly with "opinionated defaults".

• Full installation guide (for advanced users): if you need to import an existing Matrix server's data into the new server or want to learn more while setting up the server, follow this guide.

  • Prerequisites

  • Configuring your DNS settings

  • Getting the playbook

  • Configuring the playbook

  • Installing

🛠️ Configuration options

You can check useful documentation for configuring components here: Configuring the playbook

• Administration — services that help you in administrating and monitoring your Matrix installation

• Authentication and user-related — extend and modify how users are authenticated on your homeserver

• Bots — bots provide various additional functionality to your installation

• Bridges — bridges can be used to connect your Matrix installation with third-party communication networks

• Clients — web clients for Matrix that you can host on your own domains

• Core service adjustments — backbone of your Matrix system

• File Storage — use alternative file storage to the default media_store folder

• Other specialized services — various services that don't fit any other categories

👨‍🔧 Maintenance

If your server and services experience issues, feel free to come to our support room and ask for help.

• Maintenance and Troubleshooting

• PostgreSQL maintenance

• Synapse maintenance

• Upgrading services

Other documentation pages

• ℹ️ FAQ — various Frequently Asked Questions about Matrix, with a focus on this Ansible playbook

• Alternative architectures

• Container images used by the playbook

• Obtaining an Access Token

• Playbook tags

• Registering users

• Running just commands

• Self-building

• Uninstalling

• Updating users passwords