mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2025-02-06 07:15:13 +01:00
a8372f3613
* Edit docs/configuring-playbook-bridge-hookshot.md: fix anchor links to "main.yml" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: create "Adjusting the playbook configuration" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: split "End-to-bridge encryption" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: remove two items from the list Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: move "matrix_hookshot_github_private_key" to the playbook configuration adjustment section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: create the "Installing" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: create the "extending the configuration" section This follows fea8df5ca2d5db2208370c891b1e0b5919b09324. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: add a blank line Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: clarify when it is needed to download the private key file of a GitHub app Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: edit the instruction to add configuration to vars.yml file Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: replace "Important" with "Note" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: capitalization Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: use the common instruction for sending a message for the help menu Follow docs/configuring-playbook-bridge-postmoogle.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: small edits Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit installing instructions: replace setup-SERVICE with setup-all along with just shortcuts with "install-service" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit docs/configuring-playbook-bridge-hookshot.md: add optional label to GitHub private key instruction 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>
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.
🛠️ 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