mirrors/matrix-docker-ansible-deploy
1
0
Fork 1
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-11-01 02:05:03 +00:00
Code Issues Releases Wiki Activity
9f372d9058
matrix-docker-ansible-deploy/docs/configuring-playbook.md
Suguru Hirahara 9f372d9058
Consistent usage of the words related to BorgBackup (Borg) 
In order to avoid confusions between the name of the program itself (BorgBackup and Borg in short) and the backups managed by BorgBackup, the official full name should be preferred where possible, minding capitalization.

- Borg or borg → BorgBackup
- Borg backup(s) → BorgBackup (if it means the program) / backups with BorgBackup (if it means the backups managed by the program)

Based on https://www.borgbackup.org/

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-24 16:30:00 +09:00

13 KiB
Raw Blame History

Configuring the Ansible playbook

To configure the 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

Additional useful services

Core service adjustments

Server connectivity

Authentication and user-related

Bridging other networks

Bots

Backups

Other specialized services