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.
 
 
 

557 lines
19 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: jp\n"
  17. "Language-Team: jp <LL@li.org>\n"
  18. "MIME-Version: 1.0\n"
  19. "Content-Type: text/plain; charset=utf-8\n"
  20. "Content-Transfer-Encoding: 8bit\n"
  21. "Generated-By: Babel 2.16.0\n"
  22. #: ../../../docs/configuring-playbook-jitsi.md:1
  23. msgid "Setting up the Jitsi video-conferencing platform (optional)"
  24. msgstr ""
  25. #: ../../../docs/configuring-playbook-jitsi.md:3
  26. msgid ""
  27. "The playbook can install the [Jitsi](https://jitsi.org/) video-"
  28. "conferencing platform and integrate it with Element clients ([Element Web"
  29. "](configuring-playbook-client-element-web.md)/Desktop, Android and iOS)."
  30. msgstr ""
  31. #: ../../../docs/configuring-playbook-jitsi.md:5
  32. msgid ""
  33. "Jitsi installation is **not enabled by default**, because it's not a core"
  34. " component of Matrix services."
  35. msgstr ""
  36. #: ../../../docs/configuring-playbook-jitsi.md:7
  37. msgid ""
  38. "The setup done by the playbook is very similar to [docker-jitsi-"
  39. "meet](https://github.com/jitsi/docker-jitsi-meet). You can refer to the "
  40. "documentation there for many of the options here."
  41. msgstr ""
  42. #: ../../../docs/configuring-playbook-jitsi.md:9
  43. msgid "Prerequisites"
  44. msgstr ""
  45. #: ../../../docs/configuring-playbook-jitsi.md:11
  46. msgid "You may need to open the following ports to your server:"
  47. msgstr ""
  48. #: ../../../docs/configuring-playbook-jitsi.md:13
  49. msgid "`4443/tcp` - RTP media fallback over TCP"
  50. msgstr ""
  51. #: ../../../docs/configuring-playbook-jitsi.md:14
  52. msgid ""
  53. "`10000/udp` - RTP media over UDP. Depending on your firewall/NAT setup, "
  54. "incoming RTP packets on port `10000` may have the external IP of your "
  55. "firewall as destination address, due to the usage of STUN in JVB (see "
  56. "[`jitsi_jvb_stun_servers`](https://github.com/mother-of-all-self-hosting"
  57. "/ansible-role-jitsi/blob/main/defaults/main.yml))."
  58. msgstr ""
  59. #: ../../../docs/configuring-playbook-jitsi.md:16
  60. msgid "Adjusting the playbook configuration"
  61. msgstr ""
  62. #: ../../../docs/configuring-playbook-jitsi.md:18
  63. msgid ""
  64. "To enable Jitsi, add the following configuration to your "
  65. "`inventory/host_vars/matrix.example.com/vars.yml` file:"
  66. msgstr ""
  67. #: ../../../docs/configuring-playbook-jitsi.md:24
  68. msgid "Adjusting the Jitsi URL"
  69. msgstr ""
  70. #: ../../../docs/configuring-playbook-jitsi.md:26
  71. msgid ""
  72. "By default, this playbook installs Jitsi on the `jitsi.` subdomain "
  73. "(`jitsi.example.com`) and requires you to [adjust your DNS records"
  74. "](#adjusting-dns-records)."
  75. msgstr ""
  76. #: ../../../docs/configuring-playbook-jitsi.md:28
  77. msgid ""
  78. "By tweaking the `jitsi_hostname` variable, you can easily make the "
  79. "service available at a **different hostname** than the default one."
  80. msgstr ""
  81. #: ../../../docs/configuring-playbook-jitsi.md:30
  82. msgid ""
  83. "Example additional configuration for your "
  84. "`inventory/host_vars/matrix.example.com/vars.yml` file:"
  85. msgstr ""
  86. #: ../../../docs/configuring-playbook-jitsi.md:37
  87. msgid "Adjusting DNS records"
  88. msgstr ""
  89. #: ../../../docs/configuring-playbook-jitsi.md:39
  90. msgid ""
  91. "Once you've decided on the domain and path, **you may need to adjust your"
  92. " DNS** records to point the Jitsi domain to the Matrix server."
  93. msgstr ""
  94. #: ../../../docs/configuring-playbook-jitsi.md:41
  95. msgid ""
  96. "By default, you will need to create a CNAME record for `jitsi`. See "
  97. "[Configuring DNS](configuring-dns.md) for details about DNS changes."
  98. msgstr ""
  99. #: ../../../docs/configuring-playbook-jitsi.md:43
  100. msgid "(Optional) Configure Jitsi authentication and guests mode"
  101. msgstr ""
  102. #: ../../../docs/configuring-playbook-jitsi.md:45
  103. msgid ""
  104. "By default the Jitsi Meet instance does not require any kind of login and"
  105. " is open to use for anyone without registration."
  106. msgstr ""
  107. #: ../../../docs/configuring-playbook-jitsi.md:47
  108. msgid ""
  109. "If you're fine with such an open Jitsi instance, please skip to "
  110. "[Installing](#installing)."
  111. msgstr ""
  112. #: ../../../docs/configuring-playbook-jitsi.md:49
  113. msgid ""
  114. "If you would like to control who is allowed to open meetings on your new "
  115. "Jitsi instance, then please follow the following steps to enable Jitsi's "
  116. "authentication and optionally guests mode."
  117. msgstr ""
  118. #: ../../../docs/configuring-playbook-jitsi.md:51
  119. msgid ""
  120. "Currently, there are three supported authentication modes: 'internal' "
  121. "(default), 'matrix' and 'ldap'."
  122. msgstr ""
  123. #: ../../../docs/configuring-playbook-jitsi.md:53
  124. msgid ""
  125. "**Note**: Authentication is not tested via the playbook's self-checks. We"
  126. " therefore recommend that you manually verify if authentication is "
  127. "required by jitsi. For this, try to manually create a conference on "
  128. "jitsi.example.com in your browser."
  129. msgstr ""
  130. #: ../../../docs/configuring-playbook-jitsi.md:55
  131. msgid "Authenticate using Jitsi accounts (Auth-Type 'internal')"
  132. msgstr ""
  133. #: ../../../docs/configuring-playbook-jitsi.md:57
  134. msgid ""
  135. "The default authentication mechanism is 'internal' auth, which requires "
  136. "jitsi-accounts to be setup and is the recommended setup, as it also works"
  137. " in federated rooms. With authentication enabled, all meeting rooms have "
  138. "to be opened by a registered user, after which guests are free to join. "
  139. "If a registered host is not yet present, guests are put on hold in "
  140. "individual waiting rooms."
  141. msgstr ""
  142. #: ../../../docs/configuring-playbook-jitsi.md:59
  143. msgid ""
  144. "Add these lines to your `inventory/host_vars/matrix.example.com/vars.yml`"
  145. " configuration:"
  146. msgstr ""
  147. #: ../../../docs/configuring-playbook-jitsi.md:71
  148. msgid ""
  149. "**Caution**: Accounts added here and subsequently removed will not be "
  150. "automatically removed from the Prosody server until user account cleaning"
  151. " is integrated into the playbook."
  152. msgstr ""
  153. #: ../../../docs/configuring-playbook-jitsi.md:73
  154. msgid ""
  155. "**If you get an error** like this: \"Error: Account creation/modification"
  156. " not supported.\", it's likely that you had previously installed Jitsi "
  157. "without auth/guest support. In such a case, you should look into "
  158. "[Rebuilding your Jitsi installation](#rebuilding-your-jitsi-"
  159. "installation)."
  160. msgstr ""
  161. #: ../../../docs/configuring-playbook-jitsi.md:75
  162. msgid "Authenticate using Matrix OpenID (Auth-Type 'matrix')"
  163. msgstr ""
  164. #: ../../../docs/configuring-playbook-jitsi.md:77
  165. msgid ""
  166. "**Attention: Probably breaks Jitsi in federated rooms and does not allow "
  167. "sharing conference links with guests.**"
  168. msgstr ""
  169. #: ../../../docs/configuring-playbook-jitsi.md:79
  170. msgid ""
  171. "Using this authentication type require a [Matrix User Verification "
  172. "Service](https://github.com/matrix-org/matrix-user-verification-service)."
  173. " By default, this playbook creates and configures a user-verification-"
  174. "service to run locally, see [configuring-user-verification-service"
  175. "](configuring-playbook-user-verification-service.md)."
  176. msgstr ""
  177. #: ../../../docs/configuring-playbook-jitsi.md:81
  178. msgid "To enable set this configuration at host level:"
  179. msgstr ""
  180. #: ../../../docs/configuring-playbook-jitsi.md:89
  181. msgid ""
  182. "For more information see also [https://github.com/matrix-org/prosody-mod-"
  183. "auth-matrix-user-verification](https://github.com/matrix-org/prosody-mod-"
  184. "auth-matrix-user-verification)."
  185. msgstr ""
  186. #: ../../../docs/configuring-playbook-jitsi.md:91
  187. msgid "Authenticate using LDAP (Auth-Type 'ldap')"
  188. msgstr ""
  189. #: ../../../docs/configuring-playbook-jitsi.md:93
  190. msgid "An example LDAP configuration could be:"
  191. msgstr ""
  192. #: ../../../docs/configuring-playbook-jitsi.md:113
  193. msgid ""
  194. "For more information refer to the [docker-jitsi-"
  195. "meet](https://github.com/jitsi/docker-jitsi-meet#authentication-using-"
  196. "ldap) and the [saslauthd `LDAP_SASLAUTHD`](https://github.com/winlibs"
  197. "/cyrus-sasl/blob/master/saslauthd/LDAP_SASLAUTHD) documentation."
  198. msgstr ""
  199. #: ../../../docs/configuring-playbook-jitsi.md:115
  200. msgid "(Optional) Making your Jitsi server work on a LAN"
  201. msgstr ""
  202. #: ../../../docs/configuring-playbook-jitsi.md:117
  203. msgid ""
  204. "By default the Jitsi Meet instance does not work with a client in LAN "
  205. "(Local Area Network), even if others are connected from WAN. There are no"
  206. " video and audio. In the case of WAN to WAN everything is ok."
  207. msgstr ""
  208. #: ../../../docs/configuring-playbook-jitsi.md:119
  209. msgid ""
  210. "The reason is the Jitsi VideoBridge git to LAN client the IP address of "
  211. "the docker image instead of the host. The "
  212. "[documentation](https://jitsi.github.io/handbook/docs/devops-guide"
  213. "/devops-guide-docker/#running-behind-nat-or-on-a-lan-environment) of "
  214. "Jitsi in docker suggest to add `JVB_ADVERTISE_IPS` in enviornment "
  215. "variable to make it work."
  216. msgstr ""
  217. #: ../../../docs/configuring-playbook-jitsi.md:121
  218. msgid "Here is how to do it in the playbook."
  219. msgstr ""
  220. #: ../../../docs/configuring-playbook-jitsi.md:123
  221. msgid ""
  222. "Add these two lines to your "
  223. "`inventory/host_vars/matrix.example.com/vars.yml` configuration:"
  224. msgstr ""
  225. #: ../../../docs/configuring-playbook-jitsi.md:130
  226. msgid "(Optional) Fine tune Jitsi"
  227. msgstr ""
  228. #: ../../../docs/configuring-playbook-jitsi.md:132
  229. msgid ""
  230. "Sample **additional** `inventory/host_vars/matrix.example.com/vars.yml` "
  231. "configuration to save up resources (explained below):"
  232. msgstr ""
  233. #: ../../../docs/configuring-playbook-jitsi.md:147
  234. msgid ""
  235. "You may want to **suspend unused video layers** until they are requested "
  236. "again, to save up resources on both server and clients. Read more on this"
  237. " feature [here](https://jitsi.org/blog/new-off-stage-layer-suppression-"
  238. "feature/)"
  239. msgstr ""
  240. #: ../../../docs/configuring-playbook-jitsi.md:149
  241. msgid ""
  242. "You may wish to **disable audio levels** to avoid excessive refresh of "
  243. "the client-side page and decrease the CPU consumption involved."
  244. msgstr ""
  245. #: ../../../docs/configuring-playbook-jitsi.md:151
  246. msgid ""
  247. "You may want to **limit the number of video feeds forwarded to each "
  248. "client**, to save up resources on both server and clients. As clients’ "
  249. "bandwidth and CPU may not bear the load, use this setting to avoid lag "
  250. "and crashes. This feature is found by default in other webconference "
  251. "applications such as Office 365 Teams (limit is set to 4). Read how it "
  252. "works [here](https://github.com/jitsi/jitsi-"
  253. "videobridge/blob/master/doc/last-n.md) and performance evaluation on this"
  254. " [study](https://jitsi.org/wp-"
  255. "content/uploads/2016/12/nossdav2015lastn.pdf)."
  256. msgstr ""
  257. #: ../../../docs/configuring-playbook-jitsi.md:153
  258. msgid ""
  259. "You may want to **limit the maximum video resolution**, to save up "
  260. "resources on both server and clients."
  261. msgstr ""
  262. #: ../../../docs/configuring-playbook-jitsi.md:155
  263. msgid "(Optional) Specify a Max number of participants on a Jitsi conference"
  264. msgstr ""
  265. #: ../../../docs/configuring-playbook-jitsi.md:157
  266. msgid ""
  267. "The playbook allows a user to set a max number of participants allowed to"
  268. " join a Jitsi conference. By default there is no limit."
  269. msgstr ""
  270. #: ../../../docs/configuring-playbook-jitsi.md:159
  271. msgid ""
  272. "In order to set the max number of participants use the following "
  273. "**additional** configuration:"
  274. msgstr ""
  275. #: ../../../docs/configuring-playbook-jitsi.md:165
  276. msgid "(Optional) Additional JVBs"
  277. msgstr ""
  278. #: ../../../docs/configuring-playbook-jitsi.md:167
  279. msgid ""
  280. "By default, a single JVB ([Jitsi VideoBridge](https://github.com/jitsi"
  281. "/jitsi-videobridge)) is deployed on the same host as the Matrix server. "
  282. "To allow more video-conferences to happen at the same time, you may need "
  283. "to provision additional JVB services on other hosts."
  284. msgstr ""
  285. #: ../../../docs/configuring-playbook-jitsi.md:169
  286. msgid ""
  287. "There is an ansible playbook that can be run with the following tag: "
  288. "`ansible-playbook -i inventory/hosts --limit jitsi_jvb_servers "
  289. "jitsi_jvb.yml --tags=common,setup-additional-jitsi-jvb,start`"
  290. msgstr ""
  291. #: ../../../docs/configuring-playbook-jitsi.md:171
  292. msgid ""
  293. "For this role to work you will need an additional section in the ansible "
  294. "hosts file with the details of the JVB hosts, for example:"
  295. msgstr ""
  296. #: ../../../docs/configuring-playbook-jitsi.md:178
  297. msgid ""
  298. "Each JVB will require a server ID to be set so that it can be uniquely "
  299. "identified and this allows Jitsi to keep track of which conferences are "
  300. "on which JVB. The server ID is set with the variable "
  301. "`jitsi_jvb_server_id` which ends up as the JVB_WS_SERVER_ID environment "
  302. "variables in the JVB docker container. This variable can be set via the "
  303. "host file, a parameter to the ansible command or in the `vars.yaml` for "
  304. "the host which will have the additional JVB. For example:"
  305. msgstr ""
  306. #: ../../../docs/configuring-playbook-jitsi.md:190
  307. msgid ""
  308. "Note that the server ID `jvb-1` is reserved for the JVB instance running "
  309. "on the Matrix host and therefore should not be used as the ID of an "
  310. "additional jvb host."
  311. msgstr ""
  312. #: ../../../docs/configuring-playbook-jitsi.md:192
  313. msgid ""
  314. "The additional JVB will also need to expose the colibri web socket port "
  315. "and this can be done with the following variable:"
  316. msgstr ""
  317. #: ../../../docs/configuring-playbook-jitsi.md:198
  318. msgid ""
  319. "The JVB will also need to know where the prosody xmpp server is located, "
  320. "similar to the server ID this can be set in the vars for the JVB by using"
  321. " the variable `jitsi_xmpp_server`. The Jitsi prosody container is "
  322. "deployed on the Matrix server by default so the value can be set to the "
  323. "Matrix domain. For example:"
  324. msgstr ""
  325. #: ../../../docs/configuring-playbook-jitsi.md:204
  326. msgid ""
  327. "However, it can also be set the ip address of the Matrix server. This can"
  328. " be useful if you wish to use a private ip. For example:"
  329. msgstr ""
  330. #: ../../../docs/configuring-playbook-jitsi.md:210
  331. msgid ""
  332. "For the JVB to be able to contact the XMPP server, the latter must expose"
  333. " the XMPP port (5222). By default, the Matrix server does not expose the "
  334. "port; only the XMPP container exposes it internally inside the host, "
  335. "which means that the first JVB (which runs on the Matrix server) can "
  336. "reach it but the additional JVB cannot. The port is exposed by setting "
  337. "`jitsi_prosody_container_jvb_host_bind_port` like this:"
  338. msgstr ""
  339. #: ../../../docs/configuring-playbook-jitsi.md:216
  340. msgid "(The default is empty; if it's set then docker forwards the port.)"
  341. msgstr ""
  342. #: ../../../docs/configuring-playbook-jitsi.md:218
  343. msgid ""
  344. "Applied together this will allow you to provision extra JVB instances "
  345. "which will register themselves with the prosody service and be available "
  346. "for jicofo to route conferences too."
  347. msgstr ""
  348. #: ../../../docs/configuring-playbook-jitsi.md:220
  349. msgid ""
  350. "To make Traefik reverse-proxy to these additional JVBs (living on other "
  351. "hosts), **you would need to add the following Traefik configuration "
  352. "extension**:"
  353. msgstr ""
  354. #: ../../../docs/configuring-playbook-jitsi.md:256
  355. msgid "(Optional) Enable Gravatar"
  356. msgstr ""
  357. #: ../../../docs/configuring-playbook-jitsi.md:258
  358. msgid ""
  359. "In the default Jisti Meet configuration, gravatar.com is enabled as an "
  360. "avatar service. This results in third party request leaking data to "
  361. "gravatar. Since Element clients already send the url of configured Matrix"
  362. " avatars to Jitsi, we disabled gravatar."
  363. msgstr ""
  364. #: ../../../docs/configuring-playbook-jitsi.md:260
  365. msgid "To enable Gravatar set:"
  366. msgstr ""
  367. #: ../../../docs/configuring-playbook-jitsi.md:266
  368. msgid ""
  369. "**Beware**: This leaks information to a third party, namely the Gravatar-"
  370. "Service (unless configured otherwise: gravatar.com). Besides metadata, "
  371. "this includes the Matrix user_id and possibly the room identifier (via "
  372. "`referrer` header)."
  373. msgstr ""
  374. #: ../../../docs/configuring-playbook-jitsi.md:268
  375. msgid "Installing"
  376. msgstr ""
  377. #: ../../../docs/configuring-playbook-jitsi.md:270
  378. msgid ""
  379. "After configuring the playbook and potentially [adjusting your DNS "
  380. "records](#adjusting-dns-records), run the playbook with [playbook tags"
  381. "](playbook-tags.md) as below:"
  382. msgstr ""
  383. #: ../../../docs/configuring-playbook-jitsi.md:277
  384. msgid ""
  385. "The shortcut commands with the [`just` program](just.md) are also "
  386. "available: `just install-all` or `just setup-all`"
  387. msgstr ""
  388. #: ../../../docs/configuring-playbook-jitsi.md:279
  389. msgid ""
  390. "`just install-all` is useful for maintaining your setup quickly ([2x-5x "
  391. "faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-"
  392. "runtime) than `just setup-all`) when its components remain unchanged. If "
  393. "you adjust your `vars.yml` to remove other components, you'd need to run "
  394. "`just setup-all`, or these components will still remain installed. Note "
  395. "these shortcuts run the `ensure-matrix-users-created` tag too."
  396. msgstr ""
  397. #: ../../../docs/configuring-playbook-jitsi.md:281
  398. msgid "Usage"
  399. msgstr ""
  400. #: ../../../docs/configuring-playbook-jitsi.md:283
  401. msgid "You can use the self-hosted Jitsi server in multiple ways:"
  402. msgstr ""
  403. #: ../../../docs/configuring-playbook-jitsi.md:285
  404. msgid ""
  405. "**by adding a widget to a room via Element Web** (the one configured by "
  406. "the playbook at `https://element.example.com`). Just start a voice or a "
  407. "video call in a room containing more than 2 members and that would create"
  408. " a Jitsi widget which utilizes your self-hosted Jitsi server."
  409. msgstr ""
  410. #: ../../../docs/configuring-playbook-jitsi.md:287
  411. msgid ""
  412. "**by adding a widget to a room via the Dimension integration manager**. "
  413. "You'll have to point the widget to your own Jitsi server manually. See "
  414. "our [Dimension integration manager](./configuring-playbook-dimension.md) "
  415. "documentation page for more details. Naturally, Dimension would need to "
  416. "be installed first (the playbook doesn't install it by default)."
  417. msgstr ""
  418. #: ../../../docs/configuring-playbook-jitsi.md:289
  419. msgid ""
  420. "**directly (without any Matrix integration)**. Just go to "
  421. "`https://jitsi.example.com`"
  422. msgstr ""
  423. #: ../../../docs/configuring-playbook-jitsi.md:291
  424. msgid ""
  425. "**Note**: Element apps on mobile devices currently [don't support joining"
  426. " meetings on a self-hosted Jitsi server](https://github.com/element-hq"
  427. "/riot-web/blob/601816862f7d84ac47547891bd53effa73d32957/docs/jitsi.md"
  428. "#mobile-app-support)."
  429. msgstr ""
  430. #: ../../../docs/configuring-playbook-jitsi.md:293
  431. msgid "Troubleshooting"
  432. msgstr ""
  433. #: ../../../docs/configuring-playbook-jitsi.md:295
  434. msgid "Rebuilding your Jitsi installation"
  435. msgstr ""
  436. #: ../../../docs/configuring-playbook-jitsi.md:297
  437. msgid ""
  438. "**If you ever run into any trouble** or **if you change configuration "
  439. "(`jitsi_*` variables) too much**, we urge you to rebuild your Jitsi "
  440. "setup."
  441. msgstr ""
  442. #: ../../../docs/configuring-playbook-jitsi.md:299
  443. msgid ""
  444. "We normally don't require such manual intervention for other services, "
  445. "but Jitsi services generate a lot of configuration files on their own."
  446. msgstr ""
  447. #: ../../../docs/configuring-playbook-jitsi.md:301
  448. msgid ""
  449. "These files are not all managed by Ansible (at least not yet), so you may"
  450. " sometimes need to delete them all and start fresh."
  451. msgstr ""
  452. #: ../../../docs/configuring-playbook-jitsi.md:303
  453. msgid "To rebuild your Jitsi configuration:"
  454. msgstr ""
  455. #: ../../../docs/configuring-playbook-jitsi.md:305
  456. msgid ""
  457. "ask Ansible to stop all Jitsi services: `just run-tags stop-group "
  458. "--extra-vars=group=jitsi`"
  459. msgstr ""
  460. #: ../../../docs/configuring-playbook-jitsi.md:306
  461. msgid ""
  462. "SSH into the server and do this and remove all Jitsi configuration & data"
  463. " (`rm -rf /matrix/jitsi`)"
  464. msgstr ""
  465. #: ../../../docs/configuring-playbook-jitsi.md:307
  466. msgid ""
  467. "ask Ansible to set up Jitsi anew and restart services (`just install-"
  468. "service jitsi`)"
  469. msgstr ""