ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-11-17 20:54:57 +00:00
Code Issues Projects Releases Wiki Activity
f62bdcc697
matrix-docker-ansible-deploy/docs/configuring-playbook.md
Suguru Hirahara b94d4d1862
Establish a hierarchy among documentation pages related to installation; ones about importing data and configuring server delegation 
This commit clarifies the hierarchy among pages for installation by moving articles for importing data and server delegation under the "installation" section, as there are multiple documentation pages which discuss a similar topic and you can easily get lost in those pages.

Also: remove the anchor link to configuring-playbook-base-domain-serving.md from configuring-playbook.md, since that procedure is not required on configuring options but on finalizing the installation, which is discussed on installing.md after that page.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-15 16:11:44 +09:00

15 KiB
Raw Blame History

Configuring the playbook

⚡️Quick start | Prerequisites > Configuring your DNS server > Getting the playbook > Configuring the playbook > Installing

To configure the Ansible playbook, you need to have done the following things:

You can then follow these steps inside the playbook directory:

  1. create a directory to hold your configuration (mkdir -p inventory/host_vars/matrix.example.com where example.com is your "base domain")

  2. copy the sample configuration file (cp examples/vars.yml inventory/host_vars/matrix.example.com/vars.yml)

  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.

  4. copy the sample inventory hosts file (cp examples/hosts inventory/hosts)

  5. edit the inventory hosts file (inventory/hosts) to your liking

  6. (optional, advanced) you may wish to keep your inventory directory under version control with git or any other version-control system.

  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 script in the installation step.

For a basic Matrix installation, that's all you need.

For a more custom setup, see the Other configuration options below.

When you're done with all the configuration you'd like to do, continue with Installing.

Other configuration options

Core service adjustments

Clients

Web clients for Matrix that you can host on your own domains.

Authentication and user-related

Extend and modify how users are authenticated on your homeserver.

File Storage

Use alternative file storage to the default media_store folder.

Bridging other networks

Bridges can be used to connect your Matrix installation with third-party communication networks.

Bots

Bots provide various additional functionality to your installation.

Administration

Services that help you in administrating and monitoring your Matrix installation.

Other specialized services

Various services that don't fit any other categories.

Deprecated / unmaintained / removed services

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.