* Use `ansible-role-cinny` Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Replace `matrix-client-cinny` and `matrix_client_cinny` with `cinny` Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Set `matrix-client-cinny` to `cinny_identifier` Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Set `cinny_container_image_*` Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Remove `cinny_container_image_registry_prefix_*` Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Replace `cinny_data_path` with `cinny_base_path` Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Move `cinny_hostname` to `matrix_servers` Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Add `cinny_uid` and `cinny_gid` Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Remove `matrix-client-cinny` in favor of ansible-role-cinny Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> * Update CHANGELOG.md Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> --------- Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5> Co-authored-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>
Table of Contents
⬇️ Installation 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.
🛠️ 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_storefolder
- 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.
Other documentation pages
- ℹ️ FAQ — various Frequently Asked Questions about Matrix, with a focus on this Ansible playbook