mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2025-10-30 23:07:57 +01:00
4df7b983ed
This follows 802032cda7/docs/configuring-dns.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
43 lines
2.2 KiB
Markdown
43 lines
2.2 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: 2019 Slavi Pantaleev
|
|
SPDX-FileCopyrightText: 2024 Suguru Hirahara
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-or-later
|
|
-->
|
|
|
|
# Getting the playbook
|
|
|
|
<sup>[Prerequisites](prerequisites.md) > [Configuring DNS settings](configuring-dns.md) > Getting the playbook > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)</sup>
|
|
|
|
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](#using-git-to-get-the-playbook) (recommended)
|
|
- [Downloading the playbook as a ZIP archive](#downloading-the-playbook-as-a-zip-archive) (not recommended)
|
|
|
|
## Using git to get the playbook
|
|
|
|
We recommend using the [git](https://git-scm.com/) tool to get the playbook's source code, because it lets you easily keep up to date in the future when [Maintaining services](maintenance-upgrading-services.md).
|
|
|
|
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:
|
|
|
|
```sh
|
|
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](#using-git-to-get-the-playbook) 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.
|
|
|
|
---------------------------------------------
|
|
|
|
[▶️](configuring-playbook.md) No matter which method you've used to download the playbook, you can proceed by [Configuring the playbook](configuring-playbook.md).
|