matrix-docker-ansible-deploy/i18n/translation-templates/docs/quick-start.pot

# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2018-2026, Slavi Pantaleev, Aine Etke, MDAD community members
# This file is distributed under the same license as the matrix-docker-ansible-deploy package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: matrix-docker-ansible-deploy \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-07-12 15:37+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#: ../../../docs/quick-start.md:7
msgid "Quick start"
msgstr ""

#: ../../../docs/quick-start.md:15
msgid "This page explains how to use this Ansible playbook to install Matrix services on your server with a minimal set of core services."
msgstr ""

#: ../../../docs/quick-start.md:17
msgid "We will be using `example.com` as the \"base domain\" in the following instruction."
msgstr ""

#: ../../../docs/quick-start.md:19
msgid "By following the instruction on this page, you will set up:"
msgstr ""

#: ../../../docs/quick-start.md:21
msgid "**your own Matrix server** on a `matrix.example.com` server, which is configured to present itself as `example.com`"
msgstr ""

#: ../../../docs/quick-start.md:22
msgid "**your user account** like `@alice:example.com` on the server"
msgstr ""

#: ../../../docs/quick-start.md:23
msgid "a **self-hosted Matrix client**, [Element Web](configuring-playbook-client-element-web.md) with the default subdomain at `element.example.com`"
msgstr ""

#: ../../../docs/quick-start.md:24
msgid "Matrix delegation, so that your `matrix.example.com` server (presenting itself as `example.com`) can join the Matrix Federation and communicate with any other server in the Matrix network"
msgstr ""

#: ../../../docs/quick-start.md:26
msgid "Please remember to replace `example.com` with your own domain before running any commands."
msgstr ""

#: ../../../docs/quick-start.md:28
msgid "Prerequisites"
msgstr ""

#: ../../../docs/quick-start.md:30
msgid "<sup>This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Prerequisites](prerequisites.md)</sup>"
msgstr ""

#: ../../../docs/quick-start.md:32
msgid "At first, **check prerequisites** and prepare for installation by setting up programs [on your own computer](prerequisites.md#your-local-computer) and [your server](prerequisites.md#server). You also need `root` access on your server (a user that could elevate to `root` via `sudo` also works)."
msgstr ""

#: ../../../docs/quick-start.md:34
msgid "When preparing your server, make sure to check [the server specs you need](faq.md#what-kind-of-server-specs-do-i-need). We recommend starting with a server having at least 2GB of memory."
msgstr ""

#: ../../../docs/quick-start.md:40
msgid "If you encounter an error during installation, please make sure that you have installed and configured programs correctly."
msgstr ""

#: ../../../docs/quick-start.md:42
msgid "One of the main reasons of basic errors is using an incompatible version of required software such as Ansible. Take a look at [our guide about Ansible](ansible.md) for more information. In short: installing the latest available version is recommended."
msgstr ""

#: ../../../docs/quick-start.md:44
msgid "Configure your DNS settings"
msgstr ""

#: ../../../docs/quick-start.md:46
msgid "<sup>This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Configuring DNS settings](configuring-dns.md)</sup>"
msgstr ""

#: ../../../docs/quick-start.md:48
msgid "After installing and configuring prerequisites, you will need to **configure DNS records**."
msgstr ""

#: ../../../docs/quick-start.md:50
msgid "To configure Matrix services in the default settings, go to your DNS service provider, and adjust DNS records as below."
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "Type"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "Host"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "Priority"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "Weight"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "Port"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "Target"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "A"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "`matrix`"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "-"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "`matrix-server-IPv4`"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "AAAA"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "`matrix-server-IPv6`"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "CNAME"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "`element`"
msgstr ""

#: ../../../docs/quick-start.md:0
msgid "`matrix.example.com`"
msgstr ""

#: ../../../docs/quick-start.md:58
msgid "As the table illustrates, you need to create 2 subdomains (`matrix.example.com` and `element.example.com`) and point both of them to your server's IPv4/IPv6 address."
msgstr ""

#: ../../../docs/quick-start.md:60
msgid "If you don't have IPv6 connectivity yet, you can skip the `AAAA` record. For more details about IPv6, see the [Configuring IPv6](./configuring-ipv6.md) documentation page."
msgstr ""

#: ../../../docs/quick-start.md:62
msgid "It might take some time for the DNS records to propagate after creation."
msgstr ""

#: ../../../docs/quick-start.md:64
msgid "**💡 Note**: if you are using Cloudflare DNS, make sure to disable the proxy and set all records to \"DNS only\""
msgstr ""

#: ../../../docs/quick-start.md:66
msgid "Get the playbook"
msgstr ""

#: ../../../docs/quick-start.md:68
msgid "<sup>This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Getting the playbook](getting-the-playbook.md)</sup>"
msgstr ""

#: ../../../docs/quick-start.md:70
msgid "Next, let's **get the playbook's source code**."
msgstr ""

#: ../../../docs/quick-start.md:72
msgid "We recommend to do so with [git](https://git-scm.com/) as it enables you to keep it up to date with the latest source code. While it is possible to download the playbook as a ZIP archive, it is not recommended."
msgstr ""

#: ../../../docs/quick-start.md:74
msgid "To get the playbook with git, install git on your computer, go to a directory, and run the command:"
msgstr ""

#: ../../../docs/quick-start.md:80
msgid "It will fetch the playbook to a new `matrix-docker-ansible-deploy` directory underneath the directory you are currently in."
msgstr ""

#: ../../../docs/quick-start.md:82
msgid "Configure the playbook"
msgstr ""

#: ../../../docs/quick-start.md:84
msgid "<sup>This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Configuring the playbook](configuring-playbook.md)</sup>"
msgstr ""

#: ../../../docs/quick-start.md:86
msgid "Now that the playbook was fetched, it is time to **configure** it per your needs."
msgstr ""

#: ../../../docs/quick-start.md:88
msgid "To install Matrix services with this playbook, you would at least need 2 configuration files."
msgstr ""

#: ../../../docs/quick-start.md:90
msgid "For your convenience, we have prepared example files of them ([`vars.yml`](../examples/vars.yml) and [`hosts`](../examples/hosts))."
msgstr ""

#: ../../../docs/quick-start.md:92
msgid "To start quickly based on these example files, go into the `matrix-docker-ansible-deploy` directory and initialize your configuration, either automatically or manually."
msgstr ""

#: ../../../docs/quick-start.md:94
msgid "To initialize it automatically (with the base domain and server address pre-filled and secrets generated for you), run:"
msgstr ""

#: ../../../docs/quick-start.md:96
msgid "either: `just add-inventory-host example.com 1.2.3.4` (if you have the [`just`](just.md) tool)"
msgstr ""

#: ../../../docs/quick-start.md:97
msgid "or: `make add-inventory-host domain=example.com ip=1.2.3.4` (if you have the `make` program)"
msgstr ""

#: ../../../docs/quick-start.md:99
msgid "… where `example.com` is your \"base domain\" (not `matrix.example.com`) and `1.2.3.4` is your server's external IP address (or domain name)."
msgstr ""

#: ../../../docs/quick-start.md:101
msgid "Given a base domain of `example.com`, this creates:"
msgstr ""

#: ../../../docs/quick-start.md:103
msgid "an entry for `matrix.example.com` (the Matrix server's default hostname: `matrix.` + your base domain) in the inventory hosts file (`inventory/hosts`)"
msgstr ""

#: ../../../docs/quick-start.md:104
msgid "a configuration file (`inventory/host_vars/matrix.example.com/vars.yml`) containing `matrix_domain: example.com` and automatically generated secrets"
msgstr ""

#: ../../../docs/quick-start.md:106
msgid "Afterward, edit these 2 files to adjust them further, as necessary. Existing configuration is never overwritten (the command refuses to run if the host is already in your inventory), so it can also be used for adding more hosts later."
msgstr ""

#: ../../../docs/quick-start.md:108
msgid "To initialize it manually, follow the instructions below:"
msgstr ""

#: ../../../docs/quick-start.md:110
msgid "Create a directory to hold your configuration: `mkdir -p inventory/host_vars/matrix.example.com` where `example.com` is your \"base domain\""
msgstr ""

#: ../../../docs/quick-start.md:111
msgid "Copy the sample configuration file: `cp examples/vars.yml inventory/host_vars/matrix.example.com/vars.yml`"
msgstr ""

#: ../../../docs/quick-start.md:112
msgid "Copy the sample inventory hosts file: `cp examples/hosts inventory/hosts`"
msgstr ""

#: ../../../docs/quick-start.md:113
msgid "Edit the configuration file (`inventory/host_vars/matrix.example.com/vars.yml`)"
msgstr ""

#: ../../../docs/quick-start.md:114
msgid "Edit the inventory hosts file (`inventory/hosts`)"
msgstr ""

#: ../../../docs/quick-start.md:116
msgid "Before editing these 2 files, make sure to read explanations on them to understand what needs to be configured."
msgstr ""

#: ../../../docs/quick-start.md:118
msgid "**💡 Notes:**"
msgstr ""

#: ../../../docs/quick-start.md:119
msgid "If you are not in control of anything on the base domain, you would need to set additional configuration on `vars.yml`. For more information, see [How do I install on matrix.example.com without involving the base domain?](faq.md#how-do-i-install-on-matrix-example-com-without-involving-the-base-domain) on our FAQ."
msgstr ""

#: ../../../docs/quick-start.md:120
msgid "Certain configuration decisions (like the base domain configured in `matrix_domain` and homeserver implementation configured in `matrix_homeserver_implementation`) are final. If you make the wrong choice and wish to change it, you'll have to run the Uninstalling step and start over."
msgstr ""

#: ../../../docs/quick-start.md:121
msgid "Instead of configuring a lot of things all at once, we recommend starting with the basic (default) settings in order to get yourself familiar with how the playbook works. After making sure that everything works as expected, you can add (and remove) advanced settings / features and run the playbook as many times as you wish."
msgstr ""

#: ../../../docs/quick-start.md:123
msgid "Install"
msgstr ""

#: ../../../docs/quick-start.md:125
msgid "<sup>This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Installing](installing.md)</sup>"
msgstr ""

#: ../../../docs/quick-start.md:127
msgid "After editing `vars.yml` and `hosts` files, let's start the **installation** procedure."
msgstr ""

#: ../../../docs/quick-start.md:129
msgid "Update Ansible roles"
msgstr ""

#: ../../../docs/quick-start.md:131
msgid "Before installing, you need to update the Ansible roles that this playbook uses and fetches from outside."
msgstr ""

#: ../../../docs/quick-start.md:133
msgid "To update your playbook directory and all upstream Ansible roles, run:"
msgstr ""

#: ../../../docs/quick-start.md:135
msgid "either: `just update`"
msgstr ""

#: ../../../docs/quick-start.md:136
msgid "or: a combination of `git pull` and `just roles` (or `make roles` if you have `make` program on your computer instead of `just`)"
msgstr ""

#: ../../../docs/quick-start.md:138
msgid "If you don't have either `just` tool or `make` program, you can run the `ansible-galaxy` tool directly after updating the playbook: `git pull; rm -rf roles/galaxy; ansible-galaxy install -r requirements.yml -p roles/galaxy/ --force`"
msgstr ""

#: ../../../docs/quick-start.md:140
msgid "Run installation command"
msgstr ""

#: ../../../docs/quick-start.md:142
msgid "Then, run the command below to start installation:"
msgstr ""

#: ../../../docs/quick-start.md:148
msgid "If you **don't** use SSH keys for authentication, but rather a regular password, you may need to add `--ask-pass` to the command."
msgstr ""

#: ../../../docs/quick-start.md:150
msgid "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 command."
msgstr ""

#: ../../../docs/quick-start.md:152
msgid "Wait until the command completes. If it's all green, everything should be running properly."
msgstr ""

#: ../../../docs/quick-start.md:154
msgid "Create your user account"
msgstr ""

#: ../../../docs/quick-start.md:156
msgid "<sup>This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Registering users](registering-users.md)</sup>"
msgstr ""

#: ../../../docs/quick-start.md:158
msgid "As you have configured your brand new server and the client, you need to **create your user account** on your Matrix server."
msgstr ""

#: ../../../docs/quick-start.md:160
msgid "To create your user account (as an administrator of the server) via this Ansible playbook, run the command below on your local computer."
msgstr ""

#: ../../../docs/quick-start.md:162
msgid "**💡 Notes**:"
msgstr ""

#: ../../../docs/quick-start.md:163
msgid "Make sure to adjust `YOUR_USERNAME_HERE` and `YOUR_PASSWORD_HERE`"
msgstr ""

#: ../../../docs/quick-start.md:164
msgid "For `YOUR_USERNAME_HERE`, use a plain username like `alice`, not your full ID (`@alice:example.com`)"
msgstr ""

#: ../../../docs/quick-start.md:176
msgid "Finalize server installation"
msgstr ""

#: ../../../docs/quick-start.md:178
msgid "<sup>This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Server Delegation](howto-server-delegation.md)</sup>"
msgstr ""

#: ../../../docs/quick-start.md:180
msgid "Now that you've configured Matrix services and your user account, you need to **finalize the installation process** by [setting up Matrix delegation (redirection)](howto-server-delegation.md), so that your Matrix server (`matrix.example.com`) can present itself as the base domain (`example.com`) in the Matrix network."
msgstr ""

#: ../../../docs/quick-start.md:182
msgid "**This is required for federation to work!** Without a proper configuration, your server will effectively not be part of the Matrix network."
msgstr ""

#: ../../../docs/quick-start.md:184
msgid "To configure the delegation, you have these two options. Choose one of them according to your situation."
msgstr ""

#: ../../../docs/quick-start.md:186
msgid "If you can afford to point the base domain at the Matrix server, follow the instruction below which guides you into [serving the base domain](configuring-playbook-base-domain-serving.md) from the integrated web server."
msgstr ""

#: ../../../docs/quick-start.md:187
msgid "Alternatively, if you're using the base domain for other purposes and cannot point it to the Matrix server (and thus cannot \"serve the base domain\" from it), you most likely need to [manually install well-known files on the base domain's server](configuring-well-known.md#manually-installing-well-known-files-on-the-base-domains-server)."
msgstr ""

#: ../../../docs/quick-start.md:189
msgid "To have the base domain served from the integrated web server, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
msgstr ""

#: ../../../docs/quick-start.md:195
msgid "After configuring the playbook, run the command below and wait until it finishes:"
msgstr ""

#: ../../../docs/quick-start.md:201
msgid "💡 Running the `install-matrix-static-files` playbook tag (as done here) is an optimized version of running [the full setup command](#run-installation-command)."
msgstr ""

#: ../../../docs/quick-start.md:203
msgid "After the command finishes, you can also check whether your server federates with the Matrix network by using the [Federation Tester](https://federationtester.matrix.org/) against your base domain (`example.com`), not the `matrix.example.com` subdomain."
msgstr ""

#: ../../../docs/quick-start.md:205
msgid "Re-run the full setup command any time"
msgstr ""

#: ../../../docs/quick-start.md:207
msgid "If you think something is wrong with the server configuration, feel free to re-run the setup command any time:"
msgstr ""

#: ../../../docs/quick-start.md:213
msgid "Log in to your user account"
msgstr ""

#: ../../../docs/quick-start.md:215
msgid "Finally, let's make sure that you can log in to the created account with the specified password."
msgstr ""

#: ../../../docs/quick-start.md:217
msgid "You should be able to log in to it with your own [Element Web](configuring-playbook-client-element-web.md) client which you have set up at `element.example.com` by running the playbook. Open the URL (`https://element.example.com`) in a web browser and enter your credentials to log in."
msgstr ""

#: ../../../docs/quick-start.md:219
msgid "**If you successfully logged in to your account, the installation and configuration have completed successfully**🎉"
msgstr ""

#: ../../../docs/quick-start.md:221
msgid "Come say Hi👋 in our support room — [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com). You might learn something or get to help someone else new to Matrix hosting."
msgstr ""

#: ../../../docs/quick-start.md:223
msgid "Things to do next"
msgstr ""

#: ../../../docs/quick-start.md:225
msgid "Once you get familiar with the playbook, you might probably want to set up additional services such as a bridge on your server."
msgstr ""

#: ../../../docs/quick-start.md:227
msgid "As this page intends to be a quick start guide which explains how to start the core Matrix services, it does not cover a topic like how to set them up. Take a look at the list of [things to do next](installing.md#things-to-do-next) to learn more."
msgstr ""

#: ../../../docs/quick-start.md:229
msgid "⚠️Keep the playbook and services up-to-date"
msgstr ""

#: ../../../docs/quick-start.md:231
msgid "While this playbook helps you to set up Matrix services and maintain them, it will **not** automatically run the maintenance task for you. You will need to update the playbook and re-run it **manually**."
msgstr ""

#: ../../../docs/quick-start.md:233
msgid "Since it is unsafe to keep outdated services running on the server connected to the internet, please consider to update the playbook and re-run it periodically, in order to keep the services up-to-date."
msgstr ""

#: ../../../docs/quick-start.md:235
msgid "For more information about upgrading or maintaining services with the playbook, take a look at this page: [Upgrading the Matrix services](maintenance-upgrading-services.md)"
msgstr ""