3684e93a61
* Add hard-coded breadcrumbs to documentation files about installation procedure for easier navigation Since it is easy to get lost among these files, the breadcrumbs should be helpful to get the whole picture of the procedure. Hopefully they will be replaced with something else generated automatically. Please note that the usage of <sup> HTML tags on this context is not proper as the tag is intended to be used only for typographical reasons. Here <small> tags should rather be used instead as long as we do not use CSS, but since GitHub strips these tags against its spec (https://github.github.com/gfm/#disallowed-raw-html-extension-) (also note: the <small> HTML tags are not stripped on Codeberg for example), this commit intentionally uses <sup> to have those breadcrumbs rendered in small points. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook.md title The file is referred from other files as "Configuring the playbook" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Add "Quick start" link with the thunder icon For now docs/README.md is linked 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>
2.1 KiB
Getting the playbook
⚡️Quick start | Prerequisites > Configuring your DNS server > Getting the playbook > Configuring the playbook > Installing
This Ansible playbook is meant to be executed on your own computer (not the Matrix server).
In special cases (if your computer cannot run Ansible, etc.) you may put the playbook on the server as well.
You can retrieve the playbook's source code by:
-
Using git to get the playbook (recommended)
-
Downloading the playbook as a ZIP archive (not recommended)
Using git to get the playbook
We recommend using the git tool to get the playbook's source code, because it lets you easily keep up to date in the future when Maintaining services.
Once you've installed git on your computer, you can go to any directory of your choosing and run the following command to retrieve the playbook's source code:
git clone https://github.com/spantaleev/matrix-docker-ansible-deploy.git
This will create a new matrix-docker-ansible-deploy directory. You're supposed to execute all other installation commands inside that directory.
Downloading the playbook as a ZIP archive
Alternatively, you can download the playbook as a ZIP archive. This is not recommended, as it's not easy to keep up to date with future updates. We suggest you use git instead.
The latest version is always at the following URL: https://github.com/spantaleev/matrix-docker-ansible-deploy/archive/master.zip
You can extract this archive anywhere. You'll get a directory called matrix-docker-ansible-deploy-master. You're supposed to execute all other installation commands inside that directory.
No matter which method you've used to download the playbook, you can proceed by Configuring the playbook.