self-hosted/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-10-06 21:57:05 +02:00
Code Issues Releases Activity
Files
edad6a17bddc5d5b6d81305100a7faaccdeb221c
matrix-docker-ansible-deploy/docs/configuring-playbook.md
Jason LaGuidice 40813784c1 Add matrix-steam-bridge (#4572) 
* Documentation update

* New files for role

* Update existing files to add support for matrix-steam-bridge

* Typos and misc fixes

* Change docker tag to latest until version # is stable

* Align bridge permissions

* Correct user localpart

* Remove trailing +

* Fix syslog identifier

* Actually enable the service correctly

* One more typo fix

* Third time's the charm

* Fix config file paths

* Fix config after bridge repo changes

* Add default appservice public address - set public_media to false by default for testing

* Fix default config for steamkit-service path

* Fix bluesky reference

* Fix default container path

* Fix appservice connection to http for internal, change port to standard 8080

* Fix appservice port

* Enable public_media by default, add labels

* Enable public_media by default, add labels

* Allow bridge to update its own config and generate public_media signing key

* Add deterministic public_media_signing_key, expose portal cleanup

* Change default public_media path to omit `matrix.` from the path as it has been found that URLs generated by the bridge will only match {{ matrix_domain }}

* Remove domain re-write

* Revert "Change default public_media path to omit `matrix.` from the path as it has been found that URLs generated by the bridge will only match {{ matrix_domain }}"

This reverts commit 5f399effb9.

* Fix TLS label if playbook TLS is disabled

* Match default bridge TLS config

* Related to 3daf14d69 and 60ab08014 which enable async media by default for mautrix-go bridges

* Adjust matrix-bridge-steam files to add new line at the end of files

* Pin matrix-bridge-steam (latest -> 1.0.3)

---------

Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2025-09-12 09:13:09 +03:00

17 KiB
Raw Blame History

Configuring the playbook

Prerequisites > Configuring DNS settings > Getting the playbook > Configuring the playbook > Installing

If you've configured your DNS records and retrieved the playbook's source code to your computer, you can start configuring the playbook. To do so, 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 (after importing external roles with just update into roles/galaxy) 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. The inventory directory path is ignored via .gitignore, so it won't be part of the playbook repository. You can safely create a new git repository inside that directory with git init, etc.

  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

Note: some of the roles like one for integrating Etherpad or Jitsi are managed by their own repositories, and the configuration files for them cannot be found locally (in roles/galaxy) until those roles are fetched from the upstream projects. Check requirements.yml for the URLs of those roles.

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.