mirror/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-11-07 10:38:58 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
096b85bd966931c6ddca8196829c4b99f2fb664f
matrix-docker-ansible-deploy/i18n/translation-templates/docs/faq.pot
Suguru Hirahara 096b85bd96 Update translation-templates/ 
Signed-off-by: Suguru Hirahara <did🔑z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>
2025-11-06 23:12:32 +09:00

799 lines
38 KiB
Plaintext
Raw Blame History

# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2018-2025, 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: 2025-11-06 23:09+0900\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/faq.md:13
msgid "Frequently Asked Questions"
msgstr ""
#: ../../../docs/faq.md:15
msgid "This documentation page tries to answer various Frequently Asked Questions about all things [Matrix](https://matrix.org/), with a focus on this [Ansible](https://www.ansible.com/) playbook ([What is Ansible? How does it work?](#what-is-ansible-how-does-it-work))."
msgstr ""
#: ../../../docs/faq.md:17
msgid "This FAQ page does not intend to replace the [matrix.org FAQ](https://matrix.org/faq/) (please see that one too)."
msgstr ""
#: ../../../docs/faq.md:19
msgid "We've only started this FAQ recently, so it's still somewhat empty."
msgstr ""
#: ../../../docs/faq.md:21
msgid "Also, we encourage you to not dig yourself into a hole by reading way too much. When you've heard enough, proceed to installation. To get started, see [below](#how-do-i-run-the-installation) about our installation guides."
msgstr ""
#: ../../../docs/faq.md:23
msgid "Introductory"
msgstr ""
#: ../../../docs/faq.md:25
msgid "Where do I find more questions and answers about Matrix?"
msgstr ""
#: ../../../docs/faq.md:27
msgid "This is a Frequently Asked Questions page focused on this [Ansible](https://www.ansible.com/) playbook ([What is Ansible? How does it work?](#what-is-ansible-how-does-it-work)) for deploying a [Matrix](https://matrix.org/) server."
msgstr ""
#: ../../../docs/faq.md:29
msgid "For a lot more generic questions and answers, see the [matrix.org FAQ](https://matrix.org/faq/)."
msgstr ""
#: ../../../docs/faq.md:31
msgid "What is Matrix? What is Element? What is Synapse? Why are you confusing me with so many terms?"
msgstr ""
#: ../../../docs/faq.md:33
msgid "[Matrix](https://matrix.org/) is a new type of realtime communication (chat) network, the closest analogy to which is probably \"email\"."
msgstr ""
#: ../../../docs/faq.md:35
msgid "You don't just use the \"email\" protocols (SMTP, POP3, IMAP) directly though. There's a *server* somewhere which stores your data (`@gmail.com`, `@yahoo.com`, `@hotmail.com`, `@your-company.com`) and you access it by using these \"email\" protocols via some *client* program (Outlook, Thunderbird, some website, etc)."
msgstr ""
#: ../../../docs/faq.md:37
msgid "In the world of the Matrix chat protocol, there are various client programs. The first and currently most full-featured one is called [Element](https://element.io/) (used to be called Riot.im and Vector.im in the past). There are [many other clients](https://matrix.org/clients/). You can switch clients as much as you want until you find the one that is right for you on a given platform (you may use Element Desktop on your desktop, but Fluffychat on your phone, etc)."
msgstr ""
#: ../../../docs/faq.md:39
msgid "Matrix is also like email due to the fact that there are many servers around the world which can all talk to each other (you can send email from `@gmail.com` addresses to `@yahoo.com` and `@hotmail.com` addresses). It's the same with Matrix (`@bob:example.com` can talk to `@alice:example.org`)."
msgstr ""
#: ../../../docs/faq.md:41
msgid "If someone else is hosting your Matrix server (you being `@alice:matrix.org` or some other public server like this), all you need is a Matrix client program, like Element Web or Element X Android."
msgstr ""
#: ../../../docs/faq.md:43
msgid "If you'd like to host your own server (you being `@alice:example.com`), you'd need to set up a Matrix server program, like Synapse."
msgstr ""
#: ../../../docs/faq.md:45
msgid "In short:"
msgstr ""
#: ../../../docs/faq.md:47
msgid "Matrix is the protocol — a set of rules about how the chat network operates"
msgstr ""
#: ../../../docs/faq.md:48
msgid "Element is a client program you can use to participate on the Matrix chat network via some server (yours or someone else's). There are also [many other client programs](https://matrix.org/clients/)."
msgstr ""
#: ../../../docs/faq.md:49
msgid "Synapse is a server program you can use to host your very own Matrix server."
msgstr ""
#: ../../../docs/faq.md:51
msgid "This FAQ here mostly focuses on installing various Matrix services using the Ansible automation tool. You can learn much more about Matrix in the [matrix.org FAQ](https://matrix.org/faq/)."
msgstr ""
#: ../../../docs/faq.md:53
msgid "People I wish to talk to are not on Matrix. Can I talk to them?"
msgstr ""
#: ../../../docs/faq.md:55
msgid "You most likely can. Besides Matrix-native chats, Matrix also supports the concept of \"bridging\", which allows you to plug other networks into it."
msgstr ""
#: ../../../docs/faq.md:57
msgid "This Ansible playbook can help you install [tens of bridges for various networks](configuring-playbook.md#bridging-other-networks)."
msgstr ""
#: ../../../docs/faq.md:59
msgid "Besides setting up your own bridges (preferable), you can also use some [public bridges hosted by others](https://publiclist.anchel.nl/#bridges)."
msgstr ""
#: ../../../docs/faq.md:61
msgid "How do I get started with Matrix?"
msgstr ""
#: ../../../docs/faq.md:63
msgid "One of [Matrix](https://matrix.org/)'s distinguishing strengths (compared to other chat networks) is its decentralized nature. There's not just one entity (company, organization) controlling the servers. Rather there's thousands of servers operated by different people — one server being insecure, slow or disrespective toward its users does not affect the rest of the network. To participate in that decentralization in its fullest, consider hosting your own server or using some public server other than the largest/default one (`matrix.org`)."
msgstr ""
#: ../../../docs/faq.md:65
msgid "There are 3 ways to get into Matrix, depending on your technical ability and needs:"
msgstr ""
#: ../../../docs/faq.md:67
msgid "**using the existing default server** — the easiest way is to use an existing server. The largest public Matrix server is `matrix.org` and it's configured as a default server in clients such as [Element Web](https://app.element.io) and many others. Just use Element Web on the browser via that link (or [download client apps for your Desktop or smartphone](https://element.io/app-for-productivity)), create an account and start chatting."
msgstr ""
#: ../../../docs/faq.md:69
msgid "**using some other server** — instead of using the largest public server (`matrix.org`), you can use another public one. Here's a [list of public Matrix servers](https://joinmatrix.org/servers/) to choose from. Go to [Element Web](https://app.element.io) or download [some other client](https://matrix.org/clients/) of your choosing and adjust the homeserver URL during login."
msgstr ""
#: ../../../docs/faq.md:71
msgid "**using your own server** — running your own server puts you in ultimate control of your data. It also lets you have your own user IDs (e.g. `@bob:example.com`). See [How do I set up my own Matrix server](#how-do-i-set-up-my-own-matrix-server)."
msgstr ""
#: ../../../docs/faq.md:73
msgid "How do I set up my own Matrix server?"
msgstr ""
#: ../../../docs/faq.md:75
msgid "Normally, you'd first choose the [Matrix](https://matrix.org/) server software you'd like to run. At the time of this writing (January/2021), there's only one fully-featured server program, so there's only one reasonable choice. That's [Synapse](https://github.com/element-hq/synapse)."
msgstr ""
#: ../../../docs/faq.md:77
msgid "There are [many guides about installing Synapse](https://matrix.org/docs/guides/#installing-synapse). Using this Ansible playbook is just one way of doing it."
msgstr ""
#: ../../../docs/faq.md:79
msgid "Naturally, we're biased, so our usual recommendation is to go with this [Ansible](https://www.ansible.com/) playbook, instead of installing Synapse (and many many other things around it) manually."
msgstr ""
#: ../../../docs/faq.md:81
msgid "To get started with the playbook, check out the [Quick start](quick-start.md) or full installation guide (starting at the [Prerequisites](prerequisites.md) page)."
msgstr ""
#: ../../../docs/faq.md:83
msgid "What is Ansible? How does it work?"
msgstr ""
#: ../../../docs/faq.md:85
msgid "[Ansible](https://www.ansible.com/) is an automation program. This \"playbook\" is a collection of tasks/scripts that will set up a [Matrix](https://matrix.org/) server for you, so you don't have to perform these tasks manually."
msgstr ""
#: ../../../docs/faq.md:87
msgid "We have written these automated tasks for you and all you need to do is execute them using the Ansible program."
msgstr ""
#: ../../../docs/faq.md:89
msgid "You can install Ansible and this playbook code repository on your own computer and tell it to install Matrix services at the server living at `matrix.example.com`. We recommend installing Ansible on your own computer."
msgstr ""
#: ../../../docs/faq.md:91
msgid "Alternatively, you can download Ansible and the playbook itself directly on the `matrix.example.com` server."
msgstr ""
#: ../../../docs/faq.md:93
msgid "To learn more, see our [dedicated Ansible documentation page](ansible.md)."
msgstr ""
#: ../../../docs/faq.md:95
msgid "What is `just`?"
msgstr ""
#: ../../../docs/faq.md:97
msgid "[`just`](https://github.com/casey/just) is a modern command-runner alternative to [make](https://www.gnu.org/software/make/). It can be used to invoke commands with less typing."
msgstr ""
#: ../../../docs/faq.md:99
msgid "The `just` utility executes shortcut commands (called \"recipes\"), which invoke `ansible-playbook`, `ansible-galaxy` or [`agru`](https://github.com/etkecc/agru) (depending on what is available in your system). The targets of the recipes are defined in [`justfile`](../justfile)."
msgstr ""
#: ../../../docs/faq.md:101
msgid "For details about `just` commands, take a look at: [Running `just` commands](just.md)."
msgstr ""
#: ../../../docs/faq.md:103
msgid "The playbook also contains a `Makefile` for the `make` tool, but most of the just recipes are not available as targets in the `Makefile`."
msgstr ""
#: ../../../docs/faq.md:105
msgid "Why use this playbook and not install Synapse and other things manually?"
msgstr ""
#: ../../../docs/faq.md:107
msgid "There are various guides telling you how easy it is to install [Synapse](https://github.com/element-hq/synapse)."
msgstr ""
#: ../../../docs/faq.md:109
msgid "Reading the documentation of this Ansible playbook, you may also be thinking:"
msgstr ""
#: ../../../docs/faq.md:111
msgid "I don't know what [Ansible](https://www.ansible.com/) is. I don't know what [Docker](https://www.docker.com/) is. This looks more complicated."
msgstr ""
#: ../../../docs/faq.md:113
msgid "… so you may be leaning toward [installing Synapse manually](https://github.com/element-hq/synapse/blob/master/INSTALL.md)."
msgstr ""
#: ../../../docs/faq.md:115
msgid "The problem with a manual installation is:"
msgstr ""
#: ../../../docs/faq.md:117
msgid "Synapse is written in Python. If not packaged for your distribution, you'd need to install various Python modules, etc., and keep them updated."
msgstr ""
#: ../../../docs/faq.md:118
msgid "Synapse requires a [Postgres](https://www.postgresql.org/) database (it can run on SQLite, but that's very much discouraged). So you'd need to install Postgres as well."
msgstr ""
#: ../../../docs/faq.md:119
msgid "you may also need a reverse-proxy server in front of it (nginx, Apache), so you'd need to be familiar with that"
msgstr ""
#: ../../../docs/faq.md:120
msgid "SSL is required, so you'd need to obtain Let's Encrypt (or other free or non-free) certificates for one or more domain names. You'd need to be familiar with [certbot](https://certbot.eff.org/) (when using Let's Encrypt) or similar software."
msgstr ""
#: ../../../docs/faq.md:121
msgid "for each additional component you'd like to add (client like [Element](https://element.io), bridge to some other chat network, integration manager (stickers, other services, Identity Manager, etc.), you'll need to spend extra time installing and wiring it with the rest of the system in a way that works."
msgstr ""
#: ../../../docs/faq.md:122
msgid "you'll likely get slower updates for all of these components, depending on your distro packaging or your own time and ability"
msgstr ""
#: ../../../docs/faq.md:124
msgid "The playbook, on the other hand, installs a bunch of components for you by default, obtains SSL certificates for you, etc. If you'd like, you can enable various bridges and other services with very little effort. All the components are wired to work together."
msgstr ""
#: ../../../docs/faq.md:126
msgid "All services run in Docker containers (most being officially provided by each component's developers), so we're not at the mercy of distro packaging."
msgstr ""
#: ../../../docs/faq.md:128
msgid "Why use this playbook and not just use the Docker image directly?"
msgstr ""
#: ../../../docs/faq.md:130
msgid "Reasons are similar to the reasons for not installing manually."
msgstr ""
#: ../../../docs/faq.md:132
msgid "Besides Synapse, you'd need other things — a Postgres database, likely the [Element](https://element.io) client, etc., etc."
msgstr ""
#: ../../../docs/faq.md:134
msgid "Using the playbook, you get all these components in a way that works well together out of the box."
msgstr ""
#: ../../../docs/faq.md:136
msgid "Occasionally I see some people are talking about \"MDAD\". What is it?"
msgstr ""
#: ../../../docs/faq.md:138
msgid "It is the acronym of us: **m**atrix-**d**ocker-**a**nsible-**d**eploy."
msgstr ""
#: ../../../docs/faq.md:140
msgid "What's different about this Ansible playbook compared to [EMnify/matrix-synapse-auto-deploy](https://github.com/EMnify/matrix-synapse-auto-deploy)?"
msgstr ""
#: ../../../docs/faq.md:142
msgid "This is similar to the [EMnify/matrix-synapse-auto-deploy](https://github.com/EMnify/matrix-synapse-auto-deploy) Ansible deployment, but:"
msgstr ""
#: ../../../docs/faq.md:144
msgid "this one is a complete Ansible playbook (instead of just a role), so it's **easier to run** — especially for folks not familiar with Ansible"
msgstr ""
#: ../../../docs/faq.md:146
msgid "this one installs and hooks together **a lot more Matrix-related services** for you (see above)"
msgstr ""
#: ../../../docs/faq.md:148
msgid "this one **can be executed more than once** without causing trouble"
msgstr ""
#: ../../../docs/faq.md:150
msgid "works on various distros: **CentOS** (7.0+), Debian-based distributions (**Debian** 10/Buster+, **Ubuntu** 18.04+), **Archlinux**"
msgstr ""
#: ../../../docs/faq.md:152
msgid "this one installs everything in a single directory (`/matrix` by default) and **doesn't \"contaminate\" your server** with files all over the place"
msgstr ""
#: ../../../docs/faq.md:154
msgid "this one **doesn't necessarily take over** ports 80 and 443. By default, it sets up [Traefik](https://doc.traefik.io/traefik/) for you there, but you can also [use your own webserver](configuring-playbook-own-webserver.md)"
msgstr ""
#: ../../../docs/faq.md:156
msgid "this one **runs everything in Docker containers**, so it's likely more predictable and less fragile (see [Docker images used by this playbook](container-images.md))"
msgstr ""
#: ../../../docs/faq.md:158
msgid "this one retrieves and automatically renews free [Let's Encrypt](https://letsencrypt.org/) **SSL certificates** for you"
msgstr ""
#: ../../../docs/faq.md:160
msgid "this one optionally can store the `media_store` content repository files on [Amazon S3](https://aws.amazon.com/s3/) (but defaults to storing files on the server's filesystem)"
msgstr ""
#: ../../../docs/faq.md:162
msgid "this one optionally **allows you to use an external PostgreSQL server** for Synapse's database (but defaults to running one in a container)"
msgstr ""
#: ../../../docs/faq.md:164
msgid "helps you **import data from a previous installation** (so you can migrate your manual virtualenv/Docker setup to a more managed one)"
msgstr ""
#: ../../../docs/faq.md:166
msgid "this one is actually **maintained**"
msgstr ""
#: ../../../docs/faq.md:168
msgid "Server-related"
msgstr ""
#: ../../../docs/faq.md:170
msgid "What kind of server do I need to install Matrix using this Ansible playbook?"
msgstr ""
#: ../../../docs/faq.md:172
msgid "We list our server requirements in [Prerequisites](prerequisites.md)."
msgstr ""
#: ../../../docs/faq.md:174
msgid "Why not run Matrix on Kubernetes?"
msgstr ""
#: ../../../docs/faq.md:176
msgid "There's no reason not to run Matrix on [Kubernetes](https://kubernetes.io/)."
msgstr ""
#: ../../../docs/faq.md:178
msgid "However, that's overly complicated for thousands of us who just want to run a single small (and sometimes not so small) Matrix server, either using \"cloud\" servers or even a [Raspberry Pi](https://www.raspberrypi.org/) at home."
msgstr ""
#: ../../../docs/faq.md:180
msgid "For us, a Kubernetes-based setup which requires a cluster of multiple computers and is more technically-involved is a no-go."
msgstr ""
#: ../../../docs/faq.md:182
msgid "There are others working on automating a Matrix-on-Kubernetes setup, such as this [Helm](https://helm.sh/) chart: https://github.com/dacruz21/matrix-chart."
msgstr ""
#: ../../../docs/faq.md:184
msgid "Why don't you use Podman instead of Docker?"
msgstr ""
#: ../../../docs/faq.md:186
msgid "We like the philosophy of a daemonless container runtime, but [Podman](https://podman.io) is just not ready for our use case yet."
msgstr ""
#: ../../../docs/faq.md:188
msgid "Learn more about our past experiences/attempts to give Podman a chance, by reading [this issue](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/520)."
msgstr ""
#: ../../../docs/faq.md:190
msgid "In short, `alias podman=docker` is a lie (for us)."
msgstr ""
#: ../../../docs/faq.md:192
msgid "Why use Docker?"
msgstr ""
#: ../../../docs/faq.md:194
msgid "[Docker](https://www.docker.com/) is one of our 2 hard dependencies (the other one being [systemd](https://systemd.io/))."
msgstr ""
#: ../../../docs/faq.md:196
msgid "It lets us run services in an isolated manner and independently of the (usually old) packages available for distributions."
msgstr ""
#: ../../../docs/faq.md:198
msgid "It also lets us have a unified setup which runs the same across various supported distros (see them on [Prerequisites](prerequisites.md))."
msgstr ""
#: ../../../docs/faq.md:200
msgid "Is Docker a hard requirement?"
msgstr ""
#: ../../../docs/faq.md:202
msgid "Yes. See [Why don't you use Podman instead of Docker?](#why-dont-you-use-podman-instead-of-docker) for why we're not using another container runtime."
msgstr ""
#: ../../../docs/faq.md:204
msgid "All of our services run in containers. It's how we achieve predictability and also how we support tens of different services across lots of distros."
msgstr ""
#: ../../../docs/faq.md:206
msgid "The only thing we need on the distro is systemd and Python (we install Docker ourselves, unless you ask us not to)."
msgstr ""
#: ../../../docs/faq.md:208
msgid "Why don't you use docker-compose?"
msgstr ""
#: ../../../docs/faq.md:210
msgid "Instead of using [docker-compose](https://docs.docker.com/compose/), we prefer installing systemd services and scheduling those independently."
msgstr ""
#: ../../../docs/faq.md:212
msgid "There are people who have worked on turning this setup into a docker-compose-based one. See these experiments [here](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/64#issuecomment-603164625). There is also a demo project ([element-docker-demo](https://github.com/element-hq/element-docker-demo)) by Element."
msgstr ""
#: ../../../docs/faq.md:214
msgid "Can I run this on a distro without systemd?"
msgstr ""
#: ../../../docs/faq.md:216
msgid "No. [systemd](https://systemd.io/) is one of our 2 hard dependencies (the other one being [Docker](https://www.docker.com/))."
msgstr ""
#: ../../../docs/faq.md:218
msgid "Can I install this on a Raspberry Pi?"
msgstr ""
#: ../../../docs/faq.md:220
msgid "Yes, you can. See our [Alternative Architectures](alternative-architectures.md) documentation page."
msgstr ""
#: ../../../docs/faq.md:222
msgid "Whether a Raspberry Pi has enough power to give you a good experience is another question. It depends on your use case."
msgstr ""
#: ../../../docs/faq.md:224
msgid "Also see: [What kind of server specs do I need?](#what-kind-of-server-specs-do-i-need)."
msgstr ""
#: ../../../docs/faq.md:226
msgid "What kind of server specs do I need?"
msgstr ""
#: ../../../docs/faq.md:228
msgid "This largely depends on your use case. It's not so much the number of users that you plan to host, but rather the number of large rooms they will join."
msgstr ""
#: ../../../docs/faq.md:230
msgid "Federated rooms with lots of history and containing hundreds of other servers are very heavy CPU-wise and memory-wise."
msgstr ""
#: ../../../docs/faq.md:232
msgid "You can probably use a 1 CPU + 1GB memory server to host hundreds of local users just fine, but as soon as one of them joins a federated room like `#matrix:matrix.org` (Matrix HQ) or some IRC-bridged room (say `##linux`), your server will get the need for a lot more power (at least 2GB RAM, etc)."
msgstr ""
#: ../../../docs/faq.md:234
msgid "Running Matrix on a server with 1GB of memory is possible (especially if you disable some not-so-important services). See [How do I optimize this setup for a low-power server?](#how-do-i-optimize-this-setup-for-a-low-power-server)."
msgstr ""
#: ../../../docs/faq.md:236
msgid "**We recommend starting with a server having at least 2GB of memory** and even then using it sparingly. If you know for sure you'll be joining various large rooms, etc., then going for 4GB of memory or more is a good idea."
msgstr ""
#: ../../../docs/faq.md:238
msgid "Besides the regular Matrix stuff, we also support things like video-conferencing using [Jitsi](configuring-playbook-jitsi.md) and other additional services which (when installed) may use up a lot of memory. Things do add up. Besides the Synapse Matrix server, Jitsi is especially notorious for consuming a lot of resources. If you plan on running Jitsi, we recommend a server with at least 2GB of memory (preferably more). See our [Jitsi documentation page](configuring-playbook-jitsi.md) to learn how to optimize its memory/CPU usage."
msgstr ""
#: ../../../docs/faq.md:240
msgid "Can I run this in an LXC container?"
msgstr ""
#: ../../../docs/faq.md:242
msgid "If your distro runs within an [LXC container](https://linuxcontainers.org/), you may hit [this issue](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/703). It can be worked around, if absolutely necessary, but we suggest that you avoid running from within an LXC container."
msgstr ""
#: ../../../docs/faq.md:244
msgid "Configuration"
msgstr ""
#: ../../../docs/faq.md:246
msgid "Why install my server at matrix.example.com and not at the base domain?"
msgstr ""
#: ../../../docs/faq.md:248
msgid "It's the same with email servers. Your email address is likely `name@company.com`, not `name@mail.company.com`, even though it's `mail.company.com` that is really handling your data for `@company.com` email to work."
msgstr ""
#: ../../../docs/faq.md:250
msgid "Using a separate domain name is easier to manage (although it's a little hard to get right at first) and keeps your Matrix server isolated from your website (if you have one), from your email server (if you have one), etc. Therefore, this playbook sets up services on your Matrix server (`matrix.example.com`) by default."
msgstr ""
#: ../../../docs/faq.md:252
msgid "I don't control anything on the base domain and can't set up delegation to matrix.example.com. What do I do?"
msgstr ""
#: ../../../docs/faq.md:254
msgid "If you're not in control of your base domain (or the server handling it) at all, you can take a look at [How do I install on matrix.example.com without involving the base domain?](#how-do-i-install-on-matrixexamplecom-without-involving-the-base-domain)"
msgstr ""
#: ../../../docs/faq.md:256
msgid "I can't set up HTTPS on the base domain. How will I get Matrix federating?"
msgstr ""
#: ../../../docs/faq.md:258
msgid "If you really can't obtain an HTTPS certificate for your base domain, you can take a look at [How do I install on matrix.example.com without involving the base domain?](#how-do-i-install-on-matrixexamplecom-without-involving-the-base-domain)"
msgstr ""
#: ../../../docs/faq.md:260
msgid "How do I install on matrix.example.com without involving the base domain?"
msgstr ""
#: ../../../docs/faq.md:262
msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
msgstr ""
#: ../../../docs/faq.md:283
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
msgstr ""
#: ../../../docs/faq.md:290
msgid "**Notes**:"
msgstr ""
#: ../../../docs/faq.md:292
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
msgstr ""
#: ../../../docs/faq.md:294
msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too."
msgstr ""
#: ../../../docs/faq.md:296
msgid "Without setting up [server delegation](howto-server-delegation.md) to `matrix.example.com`, your user IDs will be like `@alice:matrix.example.com`. This is equivalent to having an email address like `bob@mail.company.com`, instead of just `bob@company.com`."
msgstr ""
#: ../../../docs/faq.md:298
msgid "I don't use the base domain for anything. How am I supposed to set up Server Delegation for Matrix services?"
msgstr ""
#: ../../../docs/faq.md:300
msgid "If you don't use your base domain for anything, then it's hard for you to \"serve files over HTTPS\" on it — something we ask you to do for the [.well-known](configuring-well-known.md) setup (needed for [Server Delegation](howto-server-delegation.md))."
msgstr ""
#: ../../../docs/faq.md:302
msgid "Luckily, the playbook can set up your Matrix server (at `matrix.example.com`) to also handle traffic for the base domain (`example.com`)."
msgstr ""
#: ../../../docs/faq.md:304
msgid "See [Serving the base domain](configuring-playbook-base-domain-serving.md)."
msgstr ""
#: ../../../docs/faq.md:306
msgid "How do I optimize this setup for a low-power server?"
msgstr ""
#: ../../../docs/faq.md:308
msgid "You can disable some not-so-important services to save on memory."
msgstr ""
#: ../../../docs/faq.md:327
msgid "You can also consider implementing a restriction on room complexity, in order to prevent users from joining very heavy rooms:"
msgstr ""
#: ../../../docs/faq.md:337
msgid "If you've installed [Jitsi](configuring-playbook-jitsi.md) (not installed by default), there are additional optimizations listed on its documentation page that you can perform."
msgstr ""
#: ../../../docs/faq.md:339
msgid "I already have Docker on my server. Can you stop installing Docker via the playbook?"
msgstr ""
#: ../../../docs/faq.md:341
msgid "Yes, we can stop installing Docker ourselves. Just use this in your `vars.yml` file:"
msgstr ""
#: ../../../docs/faq.md:347
msgid "I run another webserver on the same server where I wish to install Matrix. What now?"
msgstr ""
#: ../../../docs/faq.md:349
msgid "By default, we install a webserver for you ([Traefik](https://doc.traefik.io/traefik/)), but you can also use [your own webserver](configuring-playbook-own-webserver.md)."
msgstr ""
#: ../../../docs/faq.md:351
msgid "How is the effective configuration determined?"
msgstr ""
#: ../../../docs/faq.md:353
msgid "Configuration variables are defined in multiple places in this playbook and are considered in this order:"
msgstr ""
#: ../../../docs/faq.md:355
msgid "there are defaults coming from each role's defaults file (`role/matrix*/defaults/main.yml`). These variable values aim to be good defaults for when the role is used standalone (outside of this collection of roles, also called playbook)."
msgstr ""
#: ../../../docs/faq.md:357
msgid "then, there are overrides in `group_vars/matrix_servers`, which aim to adjust these \"standalone role defaults\" to something which better fits the playbook in its entirety."
msgstr ""
#: ../../../docs/faq.md:359
msgid "finally, there's your `inventory/host_vars/matrix.example.com/vars.yml` file, which is the ultimate override"
msgstr ""
#: ../../../docs/faq.md:361
msgid "What configuration variables are available?"
msgstr ""
#: ../../../docs/faq.md:363
msgid "You can discover the variables you can override in each role (`roles/*/*/defaults/main.yml`)."
msgstr ""
#: ../../../docs/faq.md:365
msgid "As described in [How is the effective configuration determined?](#how-is-the-effective-configuration-determined), these role-defaults may be overridden by values defined in `group_vars/matrix_servers`."
msgstr ""
#: ../../../docs/faq.md:367
msgid "Refer to both of these for inspiration. Still, as mentioned in [Configuring the playbook](configuring-playbook.md), you're only ever supposed to edit your own `inventory/host_vars/matrix.example.com/vars.yml` file and nothing else inside the playbook (unless you're meaning to contribute new features)."
msgstr ""
#: ../../../docs/faq.md:369
#: ../../../docs/faq.md:381
msgid "**Note**: some of the roles (`roles/galaxy/*`) live in separate repositories and are only installed after your run `just roles` (or `make roles`) or `just update` (which automatically does `git pull` and `just roles`)."
msgstr ""
#: ../../../docs/faq.md:371
msgid "I'd like to adjust some configuration which doesn't have a corresponding variable. How do I do it?"
msgstr ""
#: ../../../docs/faq.md:373
msgid "The playbook doesn't aim to expose all configuration settings for all services using variables. Doing so would amount to hundreds of variables that we have to create and maintain."
msgstr ""
#: ../../../docs/faq.md:375
msgid "Instead, we only try to make some important basics configurable using dedicated variables you can see in each role. See [What configuration variables are available?](#what-configuration-variables-are-available)."
msgstr ""
#: ../../../docs/faq.md:377
msgid "Besides that, each role (component) aims to provide a `matrix_SOME_COMPONENT_configuration_extension_yaml` (or `matrix_SOME_COMPONENT_configuration_extension_json`) variable, which can be used to override the configuration."
msgstr ""
#: ../../../docs/faq.md:379
msgid "Check each role's `roles/*/*/defaults/main.yml` for the corresponding variable and an example for how use it."
msgstr ""
#: ../../../docs/faq.md:383
msgid "Installation"
msgstr ""
#: ../../../docs/faq.md:385
msgid "How do I run the installation?"
msgstr ""
#: ../../../docs/faq.md:387
msgid "See [Installing](installing.md) to learn how to use Ansible to install Matrix services."
msgstr ""
#: ../../../docs/faq.md:389
msgid "However, we recommend you to follow our installation guide, instead of jumping straight to installing."
msgstr ""
#: ../../../docs/faq.md:391
msgid "There are two guides available:"
msgstr ""
#: ../../../docs/faq.md:393
msgid "⚡ **[Quick start](quick-start.md)** (for beginners): this is recommended for those who do not have an existing Matrix server and want to start quickly with \"opinionated defaults\"."
msgstr ""
#: ../../../docs/faq.md:395
msgid "**Full installation guide (for advanced users)**: if you need to import an existing Matrix server's data into the new server or want to learn more while setting up the server, follow this guide by starting with the **[Prerequisites](prerequisites.md)** documentation page."
msgstr ""
#: ../../../docs/faq.md:397
msgid "I installed Synapse some other way. Can I migrate such a setup to the playbook?"
msgstr ""
#: ../../../docs/faq.md:399
msgid "Yes, you can."
msgstr ""
#: ../../../docs/faq.md:401
msgid "You generally need to do a playbook installation. It's recommended to follow the full installation guide (starting at the [Prerequisites](prerequisites.md) page), not the [Quick start](quick-start.md) guide. The full installation guide will tell you when it's time to import your existing data into the newly-prepared server."
msgstr ""
#: ../../../docs/faq.md:403
msgid "This Ansible playbook guides you into installing a server for `example.com` (user IDs are like this: `@alice:example.com`), while the server is at `matrix.example.com`. If your existing setup has a server name (`server_name` configuration setting in Synapse's `homeserver.yaml` file) other than the base `example.com`, you may need to tweak some additional variables. This FAQ entry may be of use if you're dealing with a more complicated setup — [How do I install on matrix.example.com without involving the base domain?](#how-do-i-install-on-matrixexamplecom-without-involving-the-base-domain)"
msgstr ""
#: ../../../docs/faq.md:405
msgid "After configuring the playbook and installing and **before starting** services (done with `ansible-playbook … --tags=start`) you'd import [your SQLite](importing-synapse-sqlite.md) (or [Postgres](importing-postgres.md)) database and also [import your media store](importing-synapse-media-store.md)."
msgstr ""
#: ../../../docs/faq.md:407
msgid "I've downloaded Ansible and the playbook on the server. It can't connect using SSH."
msgstr ""
#: ../../../docs/faq.md:409
msgid "If you're using the playbook directly on the server, then Ansible doesn't need to connect using SSH."
msgstr ""
#: ../../../docs/faq.md:411
msgid "It can perform a local connection instead. Just set `ansible_connection=local` at the end of the server line in `inventory/hosts` and re-run the playbook."
msgstr ""
#: ../../../docs/faq.md:413
msgid "If you're running Ansible from within a container (one of the possibilities we list on our [dedicated Ansible documentation page](ansible.md)), then using `ansible_connection=local` is not possible."
msgstr ""
#: ../../../docs/faq.md:415
msgid "Maintenance and Troubleshooting"
msgstr ""
#: ../../../docs/faq.md:417
msgid "💡 Also see this page for generic information about maintaining the services and troubleshooting: [Maintenance and Troubleshooting](maintenance-and-troubleshooting.md)"
msgstr ""
#: ../../../docs/faq.md:419
msgid "Do I need to do anything to keep my Matrix server updated?"
msgstr ""
#: ../../../docs/faq.md:421
msgid "Yes. We don't update anything for you automatically."
msgstr ""
#: ../../../docs/faq.md:423
msgid "See our [documentation page about upgrading services](maintenance-upgrading-services.md)."
msgstr ""
#: ../../../docs/faq.md:425
msgid "How do I move my existing installation to another (VM) server?"
msgstr ""
#: ../../../docs/faq.md:427
msgid "If you have an existing installation done using this Ansible playbook, you can easily migrate that to another server following [our dedicated server migration guide](maintenance-migrating.md)."
msgstr ""
#: ../../../docs/faq.md:429
msgid "If your previous installation is done in some other way (not using this Ansible playbook), see [I installed Synapse some other way. Can I migrate such a setup to the playbook?](#i-installed-synapse-some-other-way-can-i-migrate-such-a-setup-to-the-playbook)."
msgstr ""
#: ../../../docs/faq.md:431
msgid "What is this `/matrix/postgres/data-auto-upgrade-backup` directory that is taking up so much space?"
msgstr ""
#: ../../../docs/faq.md:433
msgid "When you [perform a major Postgres upgrade](maintenance-postgres.md#upgrading-postgresql), we save the the old data files in `/matrix/postgres/data-auto-upgrade-backup`, just so you could easily restore them should something have gone wrong."
msgstr ""
#: ../../../docs/faq.md:435
msgid "After verifying that everything still works after the Postgres upgrade, you can safely delete `/matrix/postgres/data-auto-upgrade-backup`"
msgstr ""
#: ../../../docs/faq.md:437
msgid "I get \"Error response from daemon: configured logging driver does not support reading\" when I run `docker logs matrix-synapse`. Why?"
msgstr ""
#: ../../../docs/faq.md:439
msgid "To prevent double-logging, Docker logging is disabled by explicitly passing `--log-driver=none` to all containers. Due to this, you cannot view logs using `docker logs matrix-*`."
msgstr ""
#: ../../../docs/faq.md:441
msgid "See [this section](maintenance-and-troubleshooting.md#how-to-see-the-logs) on the page for maintenance and troubleshooting for more details to see the logs."
msgstr ""
#: ../../../docs/faq.md:443
msgid "Miscellaneous"
msgstr ""
#: ../../../docs/faq.md:445
msgid "I would like to see this favorite service of mine integrated and become available on my Matrix server. How can I request it?"
msgstr ""
#: ../../../docs/faq.md:447
msgid "You can freely create an issue for feature request on the repository at GitHub [here](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/new/choose). Note this is a community project with no financial backing, and there is not assurance that your request would be eventually picked up by others and the requested feature would become available. The easiest way to get a feature into this project is to just develop it yourself."
msgstr ""
#: ../../../docs/faq.md:449
msgid "Also, please note that this playbook intends to focus solely on Matrix and Matrix-related services. If your request is not specific to Matrix, you may as well to consider to submit it to the [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook), maintained by the members behind this matrix-docker-ansible-deploy project. [This document on the interoperability](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/interoperability.md) describes how to deploy services along with the Matrix services easily."
msgstr ""
Reference in New Issue View Git Blame Copy Permalink