Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

616 lines
18 KiB

  1. # SOME DESCRIPTIVE TITLE.
  2. # Copyright (C) 2018-2024, Slavi Pantaleev, Aine Etke, MDAD community
  3. # members
  4. # This file is distributed under the same license as the
  5. # matrix-docker-ansible-deploy package.
  6. # FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
  7. #
  8. #, fuzzy
  9. msgid ""
  10. msgstr ""
  11. "Project-Id-Version: matrix-docker-ansible-deploy \n"
  12. "Report-Msgid-Bugs-To: \n"
  13. "POT-Creation-Date: 2024-12-16 12:05+0900\n"
  14. "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
  15. "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
  16. "Language: bg\n"
  17. "Language-Team: bg <LL@li.org>\n"
  18. "Plural-Forms: nplurals=2; plural=(n != 1);\n"
  19. "MIME-Version: 1.0\n"
  20. "Content-Type: text/plain; charset=utf-8\n"
  21. "Content-Transfer-Encoding: 8bit\n"
  22. "Generated-By: Babel 2.16.0\n"
  23. #: ../../../docs/quick-start.md:1
  24. msgid "Quick start"
  25. msgstr ""
  26. #: ../../../docs/quick-start.md:9
  27. msgid ""
  28. "This page explains how to use this Ansible playbook to install Matrix "
  29. "services on your server with a minimal set of core services."
  30. msgstr ""
  31. #: ../../../docs/quick-start.md:11
  32. msgid ""
  33. "We will be using `example.com` as the \"base domain\" in the following "
  34. "instruction."
  35. msgstr ""
  36. #: ../../../docs/quick-start.md:13
  37. msgid "By following the instruction on this page, you will set up:"
  38. msgstr ""
  39. #: ../../../docs/quick-start.md:15
  40. msgid ""
  41. "**your own Matrix server** on a `matrix.example.com` server, which is "
  42. "configured to present itself as `example.com`"
  43. msgstr ""
  44. #: ../../../docs/quick-start.md:16
  45. msgid "**your user account** like `@alice:example.com` on the server"
  46. msgstr ""
  47. #: ../../../docs/quick-start.md:17
  48. msgid ""
  49. "a **self-hosted Matrix client**, [Element Web](configuring-playbook-"
  50. "client-element-web.md) with the default subdomain at "
  51. "`element.example.com`"
  52. msgstr ""
  53. #: ../../../docs/quick-start.md:18
  54. msgid ""
  55. "Matrix delegation, so that your `matrix.example.com` server (presenting "
  56. "itself as `example.com`) can join the Matrix Federation and communicate "
  57. "with any other server in the Matrix network"
  58. msgstr ""
  59. #: ../../../docs/quick-start.md:20
  60. msgid ""
  61. "Please remember to replace `example.com` with your own domain before "
  62. "running any commands."
  63. msgstr ""
  64. #: ../../../docs/quick-start.md:22
  65. msgid "Prerequisites"
  66. msgstr ""
  67. #: ../../../docs/quick-start.md:24
  68. msgid ""
  69. "<sup>This section is optimized for this quick-start guide and is derived "
  70. "from the following full-documentation page: "
  71. "[Prerequisites](prerequisites.md)</sup>"
  72. msgstr ""
  73. #: ../../../docs/quick-start.md:26
  74. msgid ""
  75. "At first, **check prerequisites** and prepare for installation by setting"
  76. " up programs [on your own computer](prerequisites.md#your-local-computer)"
  77. " and [your server](prerequisites.md#server). You also need `root` access "
  78. "on your server (a user that could elevate to `root` via `sudo` also "
  79. "works)."
  80. msgstr ""
  81. #: ../../../docs/quick-start.md:28
  82. msgid ""
  83. "When preparing your server, make sure to check [the server specs you "
  84. "need](faq.md#what-kind-of-server-specs-do-i-need). We recommend starting "
  85. "with a server having at least 2GB of memory."
  86. msgstr ""
  87. #: ../../../docs/quick-start.md:34
  88. msgid ""
  89. "If you encounter an error during installation, please make sure that you "
  90. "have installed and configured programs correctly."
  91. msgstr ""
  92. #: ../../../docs/quick-start.md:36
  93. msgid ""
  94. "One of the main reasons of basic errors is using an incompatible version "
  95. "of required software such as Ansible. Take a look at [our guide about "
  96. "Ansible](ansible.md) for more information. In short: installing the "
  97. "latest available version is recommended."
  98. msgstr ""
  99. #: ../../../docs/quick-start.md:38
  100. msgid "Configure your DNS settings"
  101. msgstr ""
  102. #: ../../../docs/quick-start.md:40
  103. msgid ""
  104. "<sup>This section is optimized for this quick-start guide and is derived "
  105. "from the following full-documentation page: [Configuring your DNS "
  106. "settings](configuring-dns.md)</sup>"
  107. msgstr ""
  108. #: ../../../docs/quick-start.md:42
  109. msgid ""
  110. "After installing and configuring prerequisites, you will need to "
  111. "**configure DNS records**."
  112. msgstr ""
  113. #: ../../../docs/quick-start.md:44
  114. msgid ""
  115. "To configure Matrix services in the default settings, go to your DNS "
  116. "service provider, and adjust DNS records as below."
  117. msgstr ""
  118. #: ../../../docs/quick-start.md
  119. msgid "Type"
  120. msgstr ""
  121. #: ../../../docs/quick-start.md
  122. msgid "Host"
  123. msgstr ""
  124. #: ../../../docs/quick-start.md
  125. msgid "Priority"
  126. msgstr ""
  127. #: ../../../docs/quick-start.md
  128. msgid "Weight"
  129. msgstr ""
  130. #: ../../../docs/quick-start.md
  131. msgid "Port"
  132. msgstr ""
  133. #: ../../../docs/quick-start.md
  134. msgid "Target"
  135. msgstr ""
  136. #: ../../../docs/quick-start.md
  137. msgid "A"
  138. msgstr ""
  139. #: ../../../docs/quick-start.md
  140. msgid "`matrix`"
  141. msgstr ""
  142. #: ../../../docs/quick-start.md
  143. msgid "-"
  144. msgstr ""
  145. #: ../../../docs/quick-start.md
  146. msgid "`matrix-server-IP`"
  147. msgstr ""
  148. #: ../../../docs/quick-start.md
  149. msgid "CNAME"
  150. msgstr ""
  151. #: ../../../docs/quick-start.md
  152. msgid "`element`"
  153. msgstr ""
  154. #: ../../../docs/quick-start.md
  155. msgid "`matrix.example.com`"
  156. msgstr ""
  157. #: ../../../docs/quick-start.md:51
  158. msgid ""
  159. "As the table illustrates, you need to create 2 subdomains "
  160. "(`matrix.example.com` and `element.example.com`) and point both of them "
  161. "to your server's IP address (DNS `A` record or `CNAME` record is fine)."
  162. msgstr ""
  163. #: ../../../docs/quick-start.md:53
  164. msgid "It might take some time for the DNS records to propagate after creation."
  165. msgstr ""
  166. #: ../../../docs/quick-start.md:55
  167. msgid ""
  168. "**💡 Note**: if you are using Cloudflare DNS, make sure to disable the "
  169. "proxy and set all records to \"DNS only\""
  170. msgstr ""
  171. #: ../../../docs/quick-start.md:57
  172. msgid "Get the playbook"
  173. msgstr ""
  174. #: ../../../docs/quick-start.md:59
  175. msgid ""
  176. "<sup>This section is optimized for this quick-start guide and is derived "
  177. "from the following full-documentation page: [Getting the playbook"
  178. "](getting-the-playbook.md)</sup>"
  179. msgstr ""
  180. #: ../../../docs/quick-start.md:61
  181. msgid "Next, let's **get the playbook's source code**."
  182. msgstr ""
  183. #: ../../../docs/quick-start.md:63
  184. msgid ""
  185. "We recommend to do so with [git](https://git-scm.com/) as it enables you "
  186. "to keep it up to date with the latest source code. While it is possible "
  187. "to download the playbook as a ZIP archive, it is not recommended."
  188. msgstr ""
  189. #: ../../../docs/quick-start.md:65
  190. msgid ""
  191. "To get the playbook with git, install git on your computer, go to a "
  192. "directory, and run the command:"
  193. msgstr ""
  194. #: ../../../docs/quick-start.md:71
  195. msgid ""
  196. "It will fetch the playbook to a new `matrix-docker-ansible-deploy` "
  197. "directory underneath the directory you are currently in."
  198. msgstr ""
  199. #: ../../../docs/quick-start.md:73
  200. msgid "Configure the playbook"
  201. msgstr ""
  202. #: ../../../docs/quick-start.md:75
  203. msgid ""
  204. "<sup>This section is optimized for this quick-start guide and is derived "
  205. "from the following full-documentation page: [Configuring the playbook"
  206. "](configuring-playbook.md)</sup>"
  207. msgstr ""
  208. #: ../../../docs/quick-start.md:77
  209. msgid ""
  210. "Now that the playbook was fetched, it is time to **configure** it per "
  211. "your needs."
  212. msgstr ""
  213. #: ../../../docs/quick-start.md:79
  214. msgid ""
  215. "To install Matrix services with this playbook, you would at least need 2 "
  216. "configuration files."
  217. msgstr ""
  218. #: ../../../docs/quick-start.md:81
  219. msgid ""
  220. "For your convenience, we have prepared example files of them "
  221. "([`vars.yml`](../examples/vars.yml) and [`hosts`](../examples/hosts))."
  222. msgstr ""
  223. #: ../../../docs/quick-start.md:83
  224. msgid ""
  225. "To start quickly based on these example files, go into the `matrix-"
  226. "docker-ansible-deploy` directory and follow the instructions below:"
  227. msgstr ""
  228. #: ../../../docs/quick-start.md:85
  229. msgid ""
  230. "Create a directory to hold your configuration: `mkdir -p "
  231. "inventory/host_vars/matrix.example.com` where `example.com` is your "
  232. "\"base domain\""
  233. msgstr ""
  234. #: ../../../docs/quick-start.md:86
  235. msgid ""
  236. "Copy the sample configuration file: `cp examples/vars.yml "
  237. "inventory/host_vars/matrix.example.com/vars.yml`"
  238. msgstr ""
  239. #: ../../../docs/quick-start.md:87
  240. msgid "Copy the sample inventory hosts file: `cp examples/hosts inventory/hosts`"
  241. msgstr ""
  242. #: ../../../docs/quick-start.md:88
  243. msgid ""
  244. "Edit the configuration file "
  245. "(`inventory/host_vars/matrix.example.com/vars.yml`)"
  246. msgstr ""
  247. #: ../../../docs/quick-start.md:89
  248. msgid "Edit the inventory hosts file (`inventory/hosts`)"
  249. msgstr ""
  250. #: ../../../docs/quick-start.md:91
  251. msgid ""
  252. "Before editing these 2 files, make sure to read explanations on them to "
  253. "understand what needs to be configured."
  254. msgstr ""
  255. #: ../../../docs/quick-start.md:93
  256. msgid "**💡 Notes:**"
  257. msgstr ""
  258. #: ../../../docs/quick-start.md:94
  259. msgid ""
  260. "If you are not in control of anything on the base domain, you would need "
  261. "to set additional configuration on `vars.yml`. For more information, see "
  262. "[How do I install on matrix.example.com without involving the base "
  263. "domain?](faq.md#how-do-i-install-on-matrix-example-com-without-involving-"
  264. "the-base-domain) on our FAQ."
  265. msgstr ""
  266. #: ../../../docs/quick-start.md:95
  267. msgid ""
  268. "Certain configuration decisions (like the base domain configured in "
  269. "`matrix_domain` and homeserver implementation configured in "
  270. "`matrix_homeserver_implementation`) are final. If you make the wrong "
  271. "choice and wish to change it, you'll have to run the Uninstalling step "
  272. "and start over."
  273. msgstr ""
  274. #: ../../../docs/quick-start.md:96
  275. msgid ""
  276. "Instead of configuring a lot of things all at once, we recommend starting"
  277. " with the basic (default) settings in order to get yourself familiar with"
  278. " how the playbook works. After making sure that everything works as "
  279. "expected, you can add (and remove) advanced settings / features and run "
  280. "the playbook as many times as you wish."
  281. msgstr ""
  282. #: ../../../docs/quick-start.md:98
  283. msgid "Install"
  284. msgstr ""
  285. #: ../../../docs/quick-start.md:100
  286. msgid ""
  287. "<sup>This section is optimized for this quick-start guide and is derived "
  288. "from the following full-documentation page: "
  289. "[Installing](installing.md)</sup>"
  290. msgstr ""
  291. #: ../../../docs/quick-start.md:102
  292. msgid ""
  293. "After editing `vars.yml` and `hosts` files, let's start the "
  294. "**installation** procedure."
  295. msgstr ""
  296. #: ../../../docs/quick-start.md:104
  297. msgid "Update Ansible roles"
  298. msgstr ""
  299. #: ../../../docs/quick-start.md:106
  300. msgid ""
  301. "Before installing, you need to update the Ansible roles that this "
  302. "playbook uses and fetches from outside."
  303. msgstr ""
  304. #: ../../../docs/quick-start.md:108
  305. msgid "To update your playbook directory and all upstream Ansible roles, run:"
  306. msgstr ""
  307. #: ../../../docs/quick-start.md:110
  308. msgid "either: `just update`"
  309. msgstr ""
  310. #: ../../../docs/quick-start.md:111
  311. msgid ""
  312. "or: a combination of `git pull` and `just roles` (or `make roles` if you "
  313. "have `make` program on your computer instead of `just`)"
  314. msgstr ""
  315. #: ../../../docs/quick-start.md:113
  316. msgid ""
  317. "If you don't have either `just` tool or `make` program, you can run the "
  318. "`ansible-galaxy` tool directly: `rm -rf roles/galaxy; ansible-galaxy "
  319. "install -r requirements.yml -p roles/galaxy/ --force`"
  320. msgstr ""
  321. #: ../../../docs/quick-start.md:115
  322. msgid "Run installation command"
  323. msgstr ""
  324. #: ../../../docs/quick-start.md:117
  325. msgid "Then, run the command below to start installation:"
  326. msgstr ""
  327. #: ../../../docs/quick-start.md:123
  328. msgid ""
  329. "If you **don't** use SSH keys for authentication, but rather a regular "
  330. "password, you may need to add `--ask-pass` to the command."
  331. msgstr ""
  332. #: ../../../docs/quick-start.md:125
  333. msgid ""
  334. "If you **do** use SSH keys for authentication, **and** use a non-root "
  335. "user to *become* root (sudo), you may need to add `-K` (`--ask-become-"
  336. "pass`) to the command."
  337. msgstr ""
  338. #: ../../../docs/quick-start.md:127
  339. msgid ""
  340. "Wait until the command completes. If it's all green, everything should be"
  341. " running properly."
  342. msgstr ""
  343. #: ../../../docs/quick-start.md:129
  344. msgid "Create your user account"
  345. msgstr ""
  346. #: ../../../docs/quick-start.md:131
  347. msgid ""
  348. "<sup>This section is optimized for this quick-start guide and is derived "
  349. "from the following full-documentation page: [Registering users"
  350. "](registering-users.md)</sup>"
  351. msgstr ""
  352. #: ../../../docs/quick-start.md:133
  353. msgid ""
  354. "As you have configured your brand new server and the client, you need to "
  355. "**create your user account** on your Matrix server."
  356. msgstr ""
  357. #: ../../../docs/quick-start.md:135
  358. msgid ""
  359. "To create your user account (as an administrator of the server) via this "
  360. "Ansible playbook, run the command below on your local computer."
  361. msgstr ""
  362. #: ../../../docs/quick-start.md:137
  363. msgid "**💡 Notes**:"
  364. msgstr ""
  365. #: ../../../docs/quick-start.md:138
  366. msgid "Make sure to adjust `YOUR_USERNAME_HERE` and `YOUR_PASSWORD_HERE`"
  367. msgstr ""
  368. #: ../../../docs/quick-start.md:139
  369. msgid ""
  370. "For `YOUR_USERNAME_HERE`, use a plain username like `alice`, not your "
  371. "full ID (`@alice:example.com`)"
  372. msgstr ""
  373. #: ../../../docs/quick-start.md:151
  374. msgid "Finalize server installation"
  375. msgstr ""
  376. #: ../../../docs/quick-start.md:153
  377. msgid ""
  378. "<sup>This section is optimized for this quick-start guide and is derived "
  379. "from the following full-documentation page: [Server Delegation](howto-"
  380. "server-delegation.md)</sup>"
  381. msgstr ""
  382. #: ../../../docs/quick-start.md:155
  383. msgid ""
  384. "Now that you've configured Matrix services and your user account, you "
  385. "need to **finalize the installation process** by [setting up Matrix "
  386. "delegation (redirection)](howto-server-delegation.md), so that your "
  387. "Matrix server (`matrix.example.com`) can present itself as the base "
  388. "domain (`example.com`) in the Matrix network."
  389. msgstr ""
  390. #: ../../../docs/quick-start.md:157
  391. msgid ""
  392. "**This is required for federation to work!** Without a proper "
  393. "configuration, your server will effectively not be part of the Matrix "
  394. "network."
  395. msgstr ""
  396. #: ../../../docs/quick-start.md:159
  397. msgid ""
  398. "To configure the delegation, you have these two options. Choose one of "
  399. "them according to your situation."
  400. msgstr ""
  401. #: ../../../docs/quick-start.md:161
  402. msgid ""
  403. "If you can afford to point the base domain at the Matrix server, follow "
  404. "the instruction below which guides you into [serving the base domain"
  405. "](configuring-playbook-base-domain-serving.md) from the integrated web "
  406. "server."
  407. msgstr ""
  408. #: ../../../docs/quick-start.md:162
  409. msgid ""
  410. "Alternatively, if you're using the base domain for other purposes and "
  411. "cannot point it to the Matrix server (and thus cannot \"serve the base "
  412. "domain\" from it), you most likely need to [manually install well-known "
  413. "files on the base domain's server](configuring-well-known.md#manually-"
  414. "installing-well-known-files-on-the-base-domains-server)."
  415. msgstr ""
  416. #: ../../../docs/quick-start.md:164
  417. msgid ""
  418. "To have the base domain served from the integrated web server, add the "
  419. "following configuration to your "
  420. "`inventory/host_vars/matrix.example.com/vars.yml` file:"
  421. msgstr ""
  422. #: ../../../docs/quick-start.md:170
  423. msgid ""
  424. "After configuring the playbook, run the command below and wait until it "
  425. "finishes:"
  426. msgstr ""
  427. #: ../../../docs/quick-start.md:176
  428. msgid ""
  429. "💡 Running the `install-matrix-static-files` playbook tag (as done here) "
  430. "is an optimized version of running [the full setup command](#run-"
  431. "installation-command)."
  432. msgstr ""
  433. #: ../../../docs/quick-start.md:178
  434. msgid ""
  435. "After the command finishes, you can also check whether your server "
  436. "federates with the Matrix network by using the [Federation "
  437. "Tester](https://federationtester.matrix.org/) against your base domain "
  438. "(`example.com`), not the `matrix.example.com` subdomain."
  439. msgstr ""
  440. #: ../../../docs/quick-start.md:180
  441. msgid "Re-run the full setup command any time"
  442. msgstr ""
  443. #: ../../../docs/quick-start.md:182
  444. msgid ""
  445. "If you think something is wrong with the server configuration, feel free "
  446. "to re-run the setup command any time:"
  447. msgstr ""
  448. #: ../../../docs/quick-start.md:188
  449. msgid "Log in to your user account"
  450. msgstr ""
  451. #: ../../../docs/quick-start.md:190
  452. msgid ""
  453. "Finally, let's make sure that you can log in to the created account with "
  454. "the specified password."
  455. msgstr ""
  456. #: ../../../docs/quick-start.md:192
  457. msgid ""
  458. "You should be able to log in to it with your own [Element Web"
  459. "](configuring-playbook-client-element-web.md) client which you have set "
  460. "up at `element.example.com` by running the playbook. Open the URL "
  461. "(`https://element.example.com`) in a web browser and enter your "
  462. "credentials to log in."
  463. msgstr ""
  464. #: ../../../docs/quick-start.md:194
  465. msgid ""
  466. "**If you successfully logged in to your account, installing and "
  467. "configuring is complete**🎉"
  468. msgstr ""
  469. #: ../../../docs/quick-start.md:196
  470. msgid ""
  471. "Come say Hi👋 in our support room - [#matrix-docker-ansible-"
  472. "deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-"
  473. "deploy:devture.com). You might learn something or get to help someone "
  474. "else new to Matrix hosting."
  475. msgstr ""
  476. #: ../../../docs/quick-start.md:198
  477. msgid "Things to do next"
  478. msgstr ""
  479. #: ../../../docs/quick-start.md:200
  480. msgid ""
  481. "Once you get familiar with the playbook, you might probably want to set "
  482. "up additional services such as a bridge on your server."
  483. msgstr ""
  484. #: ../../../docs/quick-start.md:202
  485. msgid ""
  486. "As this page intends to be a quick start guide which explains how to "
  487. "start the core Matrix services, it does not cover a topic like how to set"
  488. " them up. Take a look at the list of [things to do next](installing.md"
  489. "#things-to-do-next) to learn more."
  490. msgstr ""
  491. #: ../../../docs/quick-start.md:204
  492. msgid "⚠️Keep the playbook and services up-to-date"
  493. msgstr ""
  494. #: ../../../docs/quick-start.md:206
  495. msgid ""
  496. "While this playbook helps you to set up Matrix services and maintain "
  497. "them, it will **not** automatically run the maintenance task for you. You"
  498. " will need to update the playbook and re-run it **manually**."
  499. msgstr ""
  500. #: ../../../docs/quick-start.md:208
  501. msgid ""
  502. "Since it is unsafe to keep outdated services running on the server "
  503. "connected to the internet, please consider to update the playbook and re-"
  504. "run it periodically, in order to keep the services up-to-date."
  505. msgstr ""
  506. #: ../../../docs/quick-start.md:210
  507. msgid ""
  508. "For more information about upgrading or maintaining services with the "
  509. "playbook, take at look at this page: [Upgrading the Matrix services"
  510. "](maintenance-upgrading-services.md)"
  511. msgstr ""