self-hosted/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-12-12 08:43:55 +02:00
Code Issues Releases Activity
958d089b68
matrix-docker-ansible-deploy/docs/installing.md
Aaron R a8556fb8be
Update installing.md to be a bit more clear 
This change should make it more obvious which order the steps must be done
2021-10-19 22:57:01 -05:00

3.0 KiB
Raw Blame History

Installing

1. Installing the Matrix services

If you've configured your DNS and have configured the playbook, you can start the installation procedure.

Run this command to install the Matrix services:

ansible-playbook -i inventory/hosts setup.yml --tags=setup-all

The above command doesn't start any services just yet (another step does this later - below). Feel free to re-run this setup command any time you think something is off with the server configuration.

Notes:

  • if you don't use SSH keys for authentication, but rather a regular password, you may need to add --ask-pass to the above (and all other) Ansible commands.
  • if you do use SSH keys for authentication, and use a non-root user to become root (sudo), you may need to add -K (--ask-become-pass) to the above (and all other) Ansible commands.

2. Things you might want to do after installing

Before starting the services, you may want to do additional things like:

3. Starting the services

When you're ready to start the Matrix services (and set them up to auto-start in the future), run this command:

ansible-playbook -i inventory/hosts setup.yml --tags=start

4. Finalize the installation

Now that services are running, you need to finalize the installation process (required for federation to work!) by Configuring Service Discovery via .well-known.

5. Things to do next

After you have started the services and finalized the installation process (required for federation to work!) by Configuring Service Discovery via .well-known, you can: