overmind
/
matrix-docker-ansible-deploy
의 미러 https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
포크 0
코드 이슈 0 릴리즈 0 위키 활동
Matrix Docker Ansible eploy
25개 이상의 토픽을 선택하실 수 없습니다. Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
10960 커밋
13 브랜치
36 MiB
 
 
트리: 46b97d0a7a
브랜치 태그
${ item.name }
${ searchTerm } 브랜치 생성
from '46b97d0a7a'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/faq.pot

839 lines
40 KiB
Raw Blame 히스토리 

  1. # SOME DESCRIPTIVE TITLE.

  2. # Copyright (C) 2018-2026, Slavi Pantaleev, Aine Etke, MDAD community members

  3. # This file is distributed under the same license as the matrix-docker-ansible-deploy package.

  4. # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.

  5. #

  6. #, fuzzy

  7. msgid ""

  8. msgstr ""

  9. "Project-Id-Version: matrix-docker-ansible-deploy \n"

  10. "Report-Msgid-Bugs-To: \n"

  11. "POT-Creation-Date: 2026-03-03 10:49+0000\n"

  12. "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"

  13. "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

  14. "Language-Team: LANGUAGE <LL@li.org>\n"

  15. "MIME-Version: 1.0\n"

  16. "Content-Type: text/plain; charset=UTF-8\n"

  17. "Content-Transfer-Encoding: 8bit\n"

  18. 

  19. #: ../../../docs/faq.md:13

  20. msgid "Frequently Asked Questions"

  21. msgstr ""

  22. 

  23. #: ../../../docs/faq.md:15

  24. 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))."

  25. msgstr ""

  26. 

  27. #: ../../../docs/faq.md:17

  28. msgid "This FAQ page does not intend to replace the [matrix.org FAQ](https://matrix.org/faq/) (please see that one too)."

  29. msgstr ""

  30. 

  31. #: ../../../docs/faq.md:19

  32. msgid "We've only started this FAQ recently, so it's still somewhat empty."

  33. msgstr ""

  34. 

  35. #: ../../../docs/faq.md:21

  36. 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."

  37. msgstr ""

  38. 

  39. #: ../../../docs/faq.md:23

  40. msgid "Introductory"

  41. msgstr ""

  42. 

  43. #: ../../../docs/faq.md:25

  44. msgid "Where do I find more questions and answers about Matrix?"

  45. msgstr ""

  46. 

  47. #: ../../../docs/faq.md:27

  48. 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."

  49. msgstr ""

  50. 

  51. #: ../../../docs/faq.md:29

  52. msgid "For a lot more generic questions and answers, see the [matrix.org FAQ](https://matrix.org/faq/)."

  53. msgstr ""

  54. 

  55. #: ../../../docs/faq.md:31

  56. msgid "What is Matrix? What is Element? What is Synapse? Why are you confusing me with so many terms?"

  57. msgstr ""

  58. 

  59. #: ../../../docs/faq.md:33

  60. msgid "[Matrix](https://matrix.org/) is a new type of realtime communication (chat) network, the closest analogy to which is probably \"email\"."

  61. msgstr ""

  62. 

  63. #: ../../../docs/faq.md:35

  64. 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)."

  65. msgstr ""

  66. 

  67. #: ../../../docs/faq.md:37

  68. 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)."

  69. msgstr ""

  70. 

  71. #: ../../../docs/faq.md:39

  72. 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`)."

  73. msgstr ""

  74. 

  75. #: ../../../docs/faq.md:41

  76. 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."

  77. msgstr ""

  78. 

  79. #: ../../../docs/faq.md:43

  80. 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."

  81. msgstr ""

  82. 

  83. #: ../../../docs/faq.md:45

  84. msgid "In short:"

  85. msgstr ""

  86. 

  87. #: ../../../docs/faq.md:47

  88. msgid "Matrix is the protocol — a set of rules about how the chat network operates"

  89. msgstr ""

  90. 

  91. #: ../../../docs/faq.md:48

  92. 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/)."

  93. msgstr ""

  94. 

  95. #: ../../../docs/faq.md:49

  96. msgid "Synapse is a server program you can use to host your very own Matrix server."

  97. msgstr ""

  98. 

  99. #: ../../../docs/faq.md:51

  100. 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/)."

  101. msgstr ""

  102. 

  103. #: ../../../docs/faq.md:53

  104. msgid "People I wish to talk to are not on Matrix. Can I talk to them?"

  105. msgstr ""

  106. 

  107. #: ../../../docs/faq.md:55

  108. 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."

  109. msgstr ""

  110. 

  111. #: ../../../docs/faq.md:57

  112. msgid "This Ansible playbook can help you install [tens of bridges for various networks](configuring-playbook.md#bridging-other-networks)."

  113. msgstr ""

  114. 

  115. #: ../../../docs/faq.md:59

  116. msgid "Besides setting up your own bridges (preferable), you can also use some [public bridges hosted by others](https://publiclist.anchel.nl/#bridges)."

  117. msgstr ""

  118. 

  119. #: ../../../docs/faq.md:61

  120. msgid "How do I get started with Matrix?"

  121. msgstr ""

  122. 

  123. #: ../../../docs/faq.md:63

  124. 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`)."

  125. msgstr ""

  126. 

  127. #: ../../../docs/faq.md:65

  128. msgid "There are 3 ways to get into Matrix, depending on your technical ability and needs:"

  129. msgstr ""

  130. 

  131. #: ../../../docs/faq.md:67

  132. 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."

  133. msgstr ""

  134. 

  135. #: ../../../docs/faq.md:69

  136. 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."

  137. msgstr ""

  138. 

  139. #: ../../../docs/faq.md:71

  140. 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)."

  141. msgstr ""

  142. 

  143. #: ../../../docs/faq.md:73

  144. msgid "How do I set up my own Matrix server?"

  145. msgstr ""

  146. 

  147. #: ../../../docs/faq.md:75

  148. 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)."

  149. msgstr ""

  150. 

  151. #: ../../../docs/faq.md:77

  152. 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."

  153. msgstr ""

  154. 

  155. #: ../../../docs/faq.md:79

  156. 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."

  157. msgstr ""

  158. 

  159. #: ../../../docs/faq.md:81

  160. 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)."

  161. msgstr ""

  162. 

  163. #: ../../../docs/faq.md:83

  164. msgid "What is Ansible? How does it work?"

  165. msgstr ""

  166. 

  167. #: ../../../docs/faq.md:85

  168. 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."

  169. msgstr ""

  170. 

  171. #: ../../../docs/faq.md:87

  172. msgid "We have written these automated tasks for you and all you need to do is execute them using the Ansible program."

  173. msgstr ""

  174. 

  175. #: ../../../docs/faq.md:89

  176. 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."

  177. msgstr ""

  178. 

  179. #: ../../../docs/faq.md:91

  180. msgid "Alternatively, you can download Ansible and the playbook itself directly on the `matrix.example.com` server."

  181. msgstr ""

  182. 

  183. #: ../../../docs/faq.md:93

  184. msgid "To learn more, see our [dedicated Ansible documentation page](ansible.md)."

  185. msgstr ""

  186. 

  187. #: ../../../docs/faq.md:95

  188. msgid "What is `just`?"

  189. msgstr ""

  190. 

  191. #: ../../../docs/faq.md:97

  192. 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."

  193. msgstr ""

  194. 

  195. #: ../../../docs/faq.md:99

  196. 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)."

  197. msgstr ""

  198. 

  199. #: ../../../docs/faq.md:101

  200. msgid "For details about `just` commands, take a look at: [Running `just` commands](just.md)."

  201. msgstr ""

  202. 

  203. #: ../../../docs/faq.md:103

  204. 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`."

  205. msgstr ""

  206. 

  207. #: ../../../docs/faq.md:105

  208. msgid "Why use this playbook and not install Synapse and other things manually?"

  209. msgstr ""

  210. 

  211. #: ../../../docs/faq.md:107

  212. msgid "There are various guides telling you how easy it is to install [Synapse](https://github.com/element-hq/synapse)."

  213. msgstr ""

  214. 

  215. #: ../../../docs/faq.md:109

  216. msgid "Reading the documentation of this Ansible playbook, you may also be thinking:"

  217. msgstr ""

  218. 

  219. #: ../../../docs/faq.md:111

  220. 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."

  221. msgstr ""

  222. 

  223. #: ../../../docs/faq.md:113

  224. msgid "… so you may be leaning toward [installing Synapse manually](https://github.com/element-hq/synapse/blob/master/INSTALL.md)."

  225. msgstr ""

  226. 

  227. #: ../../../docs/faq.md:115

  228. msgid "The problem with a manual installation is:"

  229. msgstr ""

  230. 

  231. #: ../../../docs/faq.md:117

  232. 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."

  233. msgstr ""

  234. 

  235. #: ../../../docs/faq.md:118

  236. 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."

  237. msgstr ""

  238. 

  239. #: ../../../docs/faq.md:119

  240. msgid "you may also need a reverse-proxy server in front of it (nginx, Apache), so you'd need to be familiar with that"

  241. msgstr ""

  242. 

  243. #: ../../../docs/faq.md:120

  244. 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."

  245. msgstr ""

  246. 

  247. #: ../../../docs/faq.md:121

  248. 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."

  249. msgstr ""

  250. 

  251. #: ../../../docs/faq.md:122

  252. msgid "you'll likely get slower updates for all of these components, depending on your distro packaging or your own time and ability"

  253. msgstr ""

  254. 

  255. #: ../../../docs/faq.md:124

  256. 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."

  257. msgstr ""

  258. 

  259. #: ../../../docs/faq.md:126

  260. 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."

  261. msgstr ""

  262. 

  263. #: ../../../docs/faq.md:128

  264. msgid "Why use this playbook and not just use the Docker image directly?"

  265. msgstr ""

  266. 

  267. #: ../../../docs/faq.md:130

  268. msgid "Reasons are similar to the reasons for not installing manually."

  269. msgstr ""

  270. 

  271. #: ../../../docs/faq.md:132

  272. msgid "Besides Synapse, you'd need other things — a Postgres database, likely the [Element](https://element.io) client, etc., etc."

  273. msgstr ""

  274. 

  275. #: ../../../docs/faq.md:134

  276. msgid "Using the playbook, you get all these components in a way that works well together out of the box."

  277. msgstr ""

  278. 

  279. #: ../../../docs/faq.md:136

  280. msgid "Occasionally I see some people are talking about \"MDAD\". What is it?"

  281. msgstr ""

  282. 

  283. #: ../../../docs/faq.md:138

  284. msgid "It is the acronym of us: **m**atrix-**d**ocker-**a**nsible-**d**eploy."

  285. msgstr ""

  286. 

  287. #: ../../../docs/faq.md:140

  288. msgid "What's different about this Ansible playbook compared to [EMnify/matrix-synapse-auto-deploy](https://github.com/EMnify/matrix-synapse-auto-deploy)?"

  289. msgstr ""

  290. 

  291. #: ../../../docs/faq.md:142

  292. msgid "This is similar to the [EMnify/matrix-synapse-auto-deploy](https://github.com/EMnify/matrix-synapse-auto-deploy) Ansible deployment, but:"

  293. msgstr ""

  294. 

  295. #: ../../../docs/faq.md:144

  296. 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"

  297. msgstr ""

  298. 

  299. #: ../../../docs/faq.md:146

  300. msgid "this one installs and hooks together **a lot more Matrix-related services** for you (see above)"

  301. msgstr ""

  302. 

  303. #: ../../../docs/faq.md:148

  304. msgid "this one **can be executed more than once** without causing trouble"

  305. msgstr ""

  306. 

  307. #: ../../../docs/faq.md:150

  308. msgid "works on various distros: **CentOS** (7.0+), Debian-based distributions (**Debian** 10/Buster+, **Ubuntu** 18.04+), **Archlinux**"

  309. msgstr ""

  310. 

  311. #: ../../../docs/faq.md:152

  312. msgid "this one installs everything in a single directory (`/matrix` by default) and **doesn't \"contaminate\" your server** with files all over the place"

  313. msgstr ""

  314. 

  315. #: ../../../docs/faq.md:154

  316. 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)"

  317. msgstr ""

  318. 

  319. #: ../../../docs/faq.md:156

  320. 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))"

  321. msgstr ""

  322. 

  323. #: ../../../docs/faq.md:158

  324. msgid "this one retrieves and automatically renews free [Let's Encrypt](https://letsencrypt.org/) **SSL certificates** for you"

  325. msgstr ""

  326. 

  327. #: ../../../docs/faq.md:160

  328. 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)"

  329. msgstr ""

  330. 

  331. #: ../../../docs/faq.md:162

  332. msgid "this one optionally **allows you to use an external PostgreSQL server** for Synapse's database (but defaults to running one in a container)"

  333. msgstr ""

  334. 

  335. #: ../../../docs/faq.md:164

  336. msgid "helps you **import data from a previous installation** (so you can migrate your manual virtualenv/Docker setup to a more managed one)"

  337. msgstr ""

  338. 

  339. #: ../../../docs/faq.md:166

  340. msgid "this one is actually **maintained**"

  341. msgstr ""

  342. 

  343. #: ../../../docs/faq.md:168

  344. msgid "Server-related"

  345. msgstr ""

  346. 

  347. #: ../../../docs/faq.md:170

  348. msgid "What kind of server do I need to install Matrix using this Ansible playbook?"

  349. msgstr ""

  350. 

  351. #: ../../../docs/faq.md:172

  352. msgid "We list our server requirements in [Prerequisites](prerequisites.md)."

  353. msgstr ""

  354. 

  355. #: ../../../docs/faq.md:174

  356. msgid "Why not run Matrix on Kubernetes?"

  357. msgstr ""

  358. 

  359. #: ../../../docs/faq.md:176

  360. msgid "There's no reason not to run Matrix on [Kubernetes](https://kubernetes.io/)."

  361. msgstr ""

  362. 

  363. #: ../../../docs/faq.md:178

  364. 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."

  365. msgstr ""

  366. 

  367. #: ../../../docs/faq.md:180

  368. msgid "For us, a Kubernetes-based setup which requires a cluster of multiple computers and is more technically-involved is a no-go."

  369. msgstr ""

  370. 

  371. #: ../../../docs/faq.md:182

  372. 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."

  373. msgstr ""

  374. 

  375. #: ../../../docs/faq.md:184

  376. msgid "Why don't you use Podman instead of Docker?"

  377. msgstr ""

  378. 

  379. #: ../../../docs/faq.md:186

  380. msgid "We like the philosophy of a daemonless container runtime, but [Podman](https://podman.io) is just not ready for our use case yet."

  381. msgstr ""

  382. 

  383. #: ../../../docs/faq.md:188

  384. 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)."

  385. msgstr ""

  386. 

  387. #: ../../../docs/faq.md:190

  388. msgid "In short, `alias podman=docker` is a lie (for us)."

  389. msgstr ""

  390. 

  391. #: ../../../docs/faq.md:192

  392. msgid "Why use Docker?"

  393. msgstr ""

  394. 

  395. #: ../../../docs/faq.md:194

  396. msgid "[Docker](https://www.docker.com/) is one of our 2 hard dependencies (the other one being [systemd](https://systemd.io/))."

  397. msgstr ""

  398. 

  399. #: ../../../docs/faq.md:196

  400. msgid "It lets us run services in an isolated manner and independently of the (usually old) packages available for distributions."

  401. msgstr ""

  402. 

  403. #: ../../../docs/faq.md:198

  404. msgid "It also lets us have a unified setup which runs the same across various supported distros (see them on [Prerequisites](prerequisites.md))."

  405. msgstr ""

  406. 

  407. #: ../../../docs/faq.md:200

  408. msgid "Is Docker a hard requirement?"

  409. msgstr ""

  410. 

  411. #: ../../../docs/faq.md:202

  412. 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."

  413. msgstr ""

  414. 

  415. #: ../../../docs/faq.md:204

  416. 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."

  417. msgstr ""

  418. 

  419. #: ../../../docs/faq.md:206

  420. msgid "The only thing we need on the distro is systemd and Python (we install Docker ourselves, unless you ask us not to)."

  421. msgstr ""

  422. 

  423. #: ../../../docs/faq.md:208

  424. msgid "Why don't you use docker-compose?"

  425. msgstr ""

  426. 

  427. #: ../../../docs/faq.md:210

  428. msgid "Instead of using [docker-compose](https://docs.docker.com/compose/), we prefer installing systemd services and scheduling those independently."

  429. msgstr ""

  430. 

  431. #: ../../../docs/faq.md:212

  432. 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."

  433. msgstr ""

  434. 

  435. #: ../../../docs/faq.md:214

  436. msgid "Can I run this on a distro without systemd?"

  437. msgstr ""

  438. 

  439. #: ../../../docs/faq.md:216

  440. msgid "No. [systemd](https://systemd.io/) is one of our 2 hard dependencies (the other one being [Docker](https://www.docker.com/))."

  441. msgstr ""

  442. 

  443. #: ../../../docs/faq.md:218

  444. msgid "Can I install this on a Raspberry Pi?"

  445. msgstr ""

  446. 

  447. #: ../../../docs/faq.md:220

  448. msgid "Yes, you can. See our [Alternative Architectures](alternative-architectures.md) documentation page."

  449. msgstr ""

  450. 

  451. #: ../../../docs/faq.md:222

  452. msgid "Whether a Raspberry Pi has enough power to give you a good experience is another question. It depends on your use case."

  453. msgstr ""

  454. 

  455. #: ../../../docs/faq.md:224

  456. msgid "Also see: [What kind of server specs do I need?](#what-kind-of-server-specs-do-i-need)."

  457. msgstr ""

  458. 

  459. #: ../../../docs/faq.md:226

  460. msgid "What kind of server specs do I need?"

  461. msgstr ""

  462. 

  463. #: ../../../docs/faq.md:228

  464. 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."

  465. msgstr ""

  466. 

  467. #: ../../../docs/faq.md:230

  468. msgid "Federated rooms with lots of history and containing hundreds of other servers are very heavy CPU-wise and memory-wise."

  469. msgstr ""

  470. 

  471. #: ../../../docs/faq.md:232

  472. 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)."

  473. msgstr ""

  474. 

  475. #: ../../../docs/faq.md:234

  476. 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)."

  477. msgstr ""

  478. 

  479. #: ../../../docs/faq.md:236

  480. 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."

  481. msgstr ""

  482. 

  483. #: ../../../docs/faq.md:238

  484. 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."

  485. msgstr ""

  486. 

  487. #: ../../../docs/faq.md:240

  488. msgid "Can I run this in an LXC container?"

  489. msgstr ""

  490. 

  491. #: ../../../docs/faq.md:242

  492. 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."

  493. msgstr ""

  494. 

  495. #: ../../../docs/faq.md:244

  496. msgid "Configuration"

  497. msgstr ""

  498. 

  499. #: ../../../docs/faq.md:246

  500. msgid "Why install my server at matrix.example.com and not at the base domain?"

  501. msgstr ""

  502. 

  503. #: ../../../docs/faq.md:248

  504. 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."

  505. msgstr ""

  506. 

  507. #: ../../../docs/faq.md:250

  508. 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."

  509. msgstr ""

  510. 

  511. #: ../../../docs/faq.md:252

  512. msgid "I don't control anything on the base domain and can't set up delegation to matrix.example.com. What do I do?"

  513. msgstr ""

  514. 

  515. #: ../../../docs/faq.md:254

  516. 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)"

  517. msgstr ""

  518. 

  519. #: ../../../docs/faq.md:256

  520. msgid "I can't set up HTTPS on the base domain. How will I get Matrix federating?"

  521. msgstr ""

  522. 

  523. #: ../../../docs/faq.md:258

  524. 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)"

  525. msgstr ""

  526. 

  527. #: ../../../docs/faq.md:260

  528. msgid "How do I install on matrix.example.com without involving the base domain?"

  529. msgstr ""

  530. 

  531. #: ../../../docs/faq.md:262

  532. msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  533. msgstr ""

  534. 

  535. #: ../../../docs/faq.md:283

  536. msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"

  537. msgstr ""

  538. 

  539. #: ../../../docs/faq.md:290

  540. msgid "**Notes**:"

  541. msgstr ""

  542. 

  543. #: ../../../docs/faq.md:292

  544. msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"

  545. msgstr ""

  546. 

  547. #: ../../../docs/faq.md:294

  548. 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."

  549. msgstr ""

  550. 

  551. #: ../../../docs/faq.md:296

  552. 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`."

  553. msgstr ""

  554. 

  555. #: ../../../docs/faq.md:298

  556. msgid "I don't use the base domain for anything. How am I supposed to set up Server Delegation for Matrix services?"

  557. msgstr ""

  558. 

  559. #: ../../../docs/faq.md:300

  560. 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))."

  561. msgstr ""

  562. 

  563. #: ../../../docs/faq.md:302

  564. msgid "Luckily, the playbook can set up your Matrix server (at `matrix.example.com`) to also handle traffic for the base domain (`example.com`)."

  565. msgstr ""

  566. 

  567. #: ../../../docs/faq.md:304

  568. msgid "See [Serving the base domain](configuring-playbook-base-domain-serving.md)."

  569. msgstr ""

  570. 

  571. #: ../../../docs/faq.md:306

  572. msgid "How do I optimize this setup for a low-power server?"

  573. msgstr ""

  574. 

  575. #: ../../../docs/faq.md:308

  576. msgid "For a low-power server, it's best to use an alternative homeserver implementation (other than [Synapse](configuring-playbook-synapse.md))."

  577. msgstr ""

  578. 

  579. #: ../../../docs/faq.md:310

  580. msgid "You can disable some not-so-important services to save on memory."

  581. msgstr ""

  582. 

  583. #: ../../../docs/faq.md:317

  584. 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."

  585. msgstr ""

  586. 

  587. #: ../../../docs/faq.md:320

  588. msgid "Synapse-specific optimizations"

  589. msgstr ""

  590. 

  591. #: ../../../docs/faq.md:322

  592. msgid "If you're using [Synapse](configuring-playbook-synapse.md), you can also consider the following optimizations:"

  593. msgstr ""

  594. 

  595. #: ../../../docs/faq.md:332

  596. msgid "You can also consider [implementing a restriction on room complexity](configuring-playbook-synapse.md#limit-joining-heavy-rooms-on-constrained-hosts), in order to prevent users from joining very heavy rooms:"

  597. msgstr ""

  598. 

  599. #: ../../../docs/faq.md:340

  600. msgid "I already have Docker on my server. Can you stop installing Docker via the playbook?"

  601. msgstr ""

  602. 

  603. #: ../../../docs/faq.md:342

  604. msgid "Yes, we can stop installing Docker ourselves. Just use this in your `vars.yml` file:"

  605. msgstr ""

  606. 

  607. #: ../../../docs/faq.md:348

  608. msgid "I run another webserver on the same server where I wish to install Matrix. What now?"

  609. msgstr ""

  610. 

  611. #: ../../../docs/faq.md:350

  612. 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)."

  613. msgstr ""

  614. 

  615. #: ../../../docs/faq.md:352

  616. msgid "How is the effective configuration determined?"

  617. msgstr ""

  618. 

  619. #: ../../../docs/faq.md:354

  620. msgid "Configuration variables are defined in multiple places in this playbook and are considered in this order:"

  621. msgstr ""

  622. 

  623. #: ../../../docs/faq.md:356

  624. 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)."

  625. msgstr ""

  626. 

  627. #: ../../../docs/faq.md:358

  628. 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."

  629. msgstr ""

  630. 

  631. #: ../../../docs/faq.md:360

  632. msgid "finally, there's your `inventory/host_vars/matrix.example.com/vars.yml` file, which is the ultimate override"

  633. msgstr ""

  634. 

  635. #: ../../../docs/faq.md:362

  636. msgid "What configuration variables are available?"

  637. msgstr ""

  638. 

  639. #: ../../../docs/faq.md:364

  640. msgid "You can discover the variables you can override in each role (`roles/*/*/defaults/main.yml`)."

  641. msgstr ""

  642. 

  643. #: ../../../docs/faq.md:366

  644. 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`."

  645. msgstr ""

  646. 

  647. #: ../../../docs/faq.md:368

  648. 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)."

  649. msgstr ""

  650. 

  651. #: ../../../docs/faq.md:370

  652. #: ../../../docs/faq.md:382

  653. 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`)."

  654. msgstr ""

  655. 

  656. #: ../../../docs/faq.md:372

  657. msgid "I'd like to adjust some configuration which doesn't have a corresponding variable. How do I do it?"

  658. msgstr ""

  659. 

  660. #: ../../../docs/faq.md:374

  661. 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."

  662. msgstr ""

  663. 

  664. #: ../../../docs/faq.md:376

  665. 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)."

  666. msgstr ""

  667. 

  668. #: ../../../docs/faq.md:378

  669. 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."

  670. msgstr ""

  671. 

  672. #: ../../../docs/faq.md:380

  673. msgid "Check each role's `roles/*/*/defaults/main.yml` for the corresponding variable and an example for how use it."

  674. msgstr ""

  675. 

  676. #: ../../../docs/faq.md:384

  677. msgid "Installation"

  678. msgstr ""

  679. 

  680. #: ../../../docs/faq.md:386

  681. msgid "How do I run the installation?"

  682. msgstr ""

  683. 

  684. #: ../../../docs/faq.md:388

  685. msgid "See [Installing](installing.md) to learn how to use Ansible to install Matrix services."

  686. msgstr ""

  687. 

  688. #: ../../../docs/faq.md:390

  689. msgid "However, we recommend you to follow our installation guide, instead of jumping straight to installing."

  690. msgstr ""

  691. 

  692. #: ../../../docs/faq.md:392

  693. msgid "There are two guides available:"

  694. msgstr ""

  695. 

  696. #: ../../../docs/faq.md:394

  697. 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\"."

  698. msgstr ""

  699. 

  700. #: ../../../docs/faq.md:396

  701. 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."

  702. msgstr ""

  703. 

  704. #: ../../../docs/faq.md:398

  705. msgid "I installed Synapse some other way. Can I migrate such a setup to the playbook?"

  706. msgstr ""

  707. 

  708. #: ../../../docs/faq.md:400

  709. msgid "Yes, you can."

  710. msgstr ""

  711. 

  712. #: ../../../docs/faq.md:402

  713. 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."

  714. msgstr ""

  715. 

  716. #: ../../../docs/faq.md:404

  717. 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)"

  718. msgstr ""

  719. 

  720. #: ../../../docs/faq.md:406

  721. 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)."

  722. msgstr ""

  723. 

  724. #: ../../../docs/faq.md:408

  725. msgid "I've downloaded Ansible and the playbook on the server. It can't connect using SSH."

  726. msgstr ""

  727. 

  728. #: ../../../docs/faq.md:410

  729. msgid "If you're using the playbook directly on the server, then Ansible doesn't need to connect using SSH."

  730. msgstr ""

  731. 

  732. #: ../../../docs/faq.md:412

  733. 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."

  734. msgstr ""

  735. 

  736. #: ../../../docs/faq.md:414

  737. 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."

  738. msgstr ""

  739. 

  740. #: ../../../docs/faq.md:416

  741. msgid "Maintenance and Troubleshooting"

  742. msgstr ""

  743. 

  744. #: ../../../docs/faq.md:418

  745. msgid "💡 Also see this page for generic information about maintaining the services and troubleshooting: [Maintenance and Troubleshooting](maintenance-and-troubleshooting.md)"

  746. msgstr ""

  747. 

  748. #: ../../../docs/faq.md:420

  749. msgid "Do I need to do anything to keep my Matrix server updated?"

  750. msgstr ""

  751. 

  752. #: ../../../docs/faq.md:422

  753. msgid "Yes. We don't update anything for you automatically."

  754. msgstr ""

  755. 

  756. #: ../../../docs/faq.md:424

  757. msgid "See our [documentation page about upgrading services](maintenance-upgrading-services.md)."

  758. msgstr ""

  759. 

  760. #: ../../../docs/faq.md:426

  761. msgid "How do I move my existing installation to another (VM) server?"

  762. msgstr ""

  763. 

  764. #: ../../../docs/faq.md:428

  765. 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)."

  766. msgstr ""

  767. 

  768. #: ../../../docs/faq.md:430

  769. 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)."

  770. msgstr ""

  771. 

  772. #: ../../../docs/faq.md:432

  773. msgid "What is this `/matrix/postgres/data-auto-upgrade-backup` directory that is taking up so much space?"

  774. msgstr ""

  775. 

  776. #: ../../../docs/faq.md:434

  777. 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."

  778. msgstr ""

  779. 

  780. #: ../../../docs/faq.md:436

  781. msgid "After verifying that everything still works after the Postgres upgrade, you can safely delete `/matrix/postgres/data-auto-upgrade-backup`"

  782. msgstr ""

  783. 

  784. #: ../../../docs/faq.md:438

  785. msgid "I get \"Error response from daemon: configured logging driver does not support reading\" when I run `docker logs matrix-synapse`. Why?"

  786. msgstr ""

  787. 

  788. #: ../../../docs/faq.md:440

  789. 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-*`."

  790. msgstr ""

  791. 

  792. #: ../../../docs/faq.md:442

  793. 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."

  794. msgstr ""

  795. 

  796. #: ../../../docs/faq.md:444

  797. msgid "The server fails to start due to the `Unable to start service matrix-coturn.service` error. Why and how to solve it?"

  798. msgstr ""

  799. 

  800. #: ../../../docs/faq.md:446

  801. msgid "The error is most likely because Traefik cannot obtain SSL certificates due to certain reasons such as wrong domain name configuration or port 80 being unavailable due to other services."

  802. msgstr ""

  803. 

  804. #: ../../../docs/faq.md:448

  805. msgid "If Traefik fails to obtain an SSL certificate for domain names such as `matrix.`, Traefik Certs Dumper cannot extract the SSL certificate out of there, and coturn cannot be started and the error occurs. Refer to these comments for details:"

  806. msgstr ""

  807. 

  808. #: ../../../docs/faq.md:450

  809. msgid "<https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3957#issuecomment-2599590441>"

  810. msgstr ""

  811. 

  812. #: ../../../docs/faq.md:451

  813. msgid "<https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/4570#issuecomment-3364111466>"

  814. msgstr ""

  815. 

  816. #: ../../../docs/faq.md:453

  817. msgid "If you are not sure what the problem is, at first make sure that you have set the \"base domain\" (`example.com`, **not `matrix.example.com`**) to `matrix_domain`. You should be able to find it at the top of your `vars.yml`."

  818. msgstr ""

  819. 

  820. #: ../../../docs/faq.md:455

  821. msgid "If it is correctly specified, look Traefik's logs (`journalctl -fu matrix-traefik.service`) for errors by Let's Encrypt for troubleshooting."

  822. msgstr ""

  823. 

  824. #: ../../../docs/faq.md:457

  825. msgid "Miscellaneous"

  826. msgstr ""

  827. 

  828. #: ../../../docs/faq.md:459

  829. msgid "I would like to see this favorite service of mine integrated and become available on my Matrix server. How can I request it?"

  830. msgstr ""

  831. 

  832. #: ../../../docs/faq.md:461

  833. 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."

  834. msgstr ""

  835. 

  836. #: ../../../docs/faq.md:463

  837. 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."

  838. msgstr ""