overmind
/
matrix-docker-ansible-deploy
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Fork 0
Code Issues 0 Releases 0 Wiki Activity
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.
8817 Commits
13 Branches
36 MiB
 
 
Tree: 0afa372ca8
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0afa372ca8'
${ noResults }
matrix-docker-ansible-deploy/i18n/locales/jp/LC_MESSAGES/docs/configuring-playbook-ma1sd.po

343 lines
12 KiB
Raw Blame History 

  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-20 09:53+0200\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. 

  23. #: ../../../docs/configuring-playbook-ma1sd.md:1

  24. msgid "Setting up ma1sd Identity Server (optional)"

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-ma1sd.md:3

  28. msgid ""

  29. "**⚠️Note**: ma1sd itself has also been unmaintained for years (the latest"

  30. " commit and release being from 2021). The role of identity servers in the"

  31. " Matrix specification also has an uncertain future. **We recommend not "

  32. "bothering with installing it unless it's the only way you can do what you"

  33. " need to do**. For example, certain things like LDAP integration can also"

  34. " be implemented via [the LDAP provider module for Synapse](./configuring-"

  35. "playbook-ldap-auth.md)."

  36. msgstr ""

  37. 

  38. #: ../../../docs/configuring-playbook-ma1sd.md:5

  39. msgid ""

  40. "The playbook can configure the [ma1sd](https://github.com/ma1uta/ma1sd) "

  41. "Identity Server for you. It is a fork of [mxisd](https://github.com"

  42. "/kamax-io/mxisd) which was pronounced end of life 2019-06-21."

  43. msgstr ""

  44. 

  45. #: ../../../docs/configuring-playbook-ma1sd.md:7

  46. msgid ""

  47. "ma1sd is used for 3PIDs (3rd party identifiers like E-mail and phone "

  48. "numbers) and some [enhanced "

  49. "features](https://github.com/ma1uta/ma1sd/#features). It is private by "

  50. "default, potentially at the expense of user discoverability."

  51. msgstr ""

  52. 

  53. #: ../../../docs/configuring-playbook-ma1sd.md:9

  54. msgid ""

  55. "See the project's "

  56. "[documentation](https://github.com/ma1uta/ma1sd/blob/master/README.md) to"

  57. " learn what it does and why it might be useful to you."

  58. msgstr ""

  59. 

  60. #: ../../../docs/configuring-playbook-ma1sd.md:11

  61. msgid ""

  62. "**Note**: enabling ma1sd, means that the `openid` API endpoints will be "

  63. "exposed on the Matrix Federation port (usually `8448`), even if "

  64. "[federation](configuring-playbook-federation.md) is disabled. It's "

  65. "something to be aware of, especially in terms of firewall whitelisting "

  66. "(make sure port `8448` is accessible)."

  67. msgstr ""

  68. 

  69. #: ../../../docs/configuring-playbook-ma1sd.md:13

  70. msgid "Adjusting DNS records"

  71. msgstr ""

  72. 

  73. #: ../../../docs/configuring-playbook-ma1sd.md:15

  74. msgid ""

  75. "To make the ma1sd Identity Server enable its federation features, set up "

  76. "a SRV record that looks like this:"

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-ma1sd.md:17

  80. msgid "Name: `_matrix-identity._tcp` (use this text as-is)"

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-ma1sd.md:18

  84. msgid ""

  85. "Content: `10 0 443 matrix.example.com` (replace `example.com` with your "

  86. "own)"

  87. msgstr ""

  88. 

  89. #: ../../../docs/configuring-playbook-ma1sd.md:20

  90. msgid ""

  91. "See [ma1sd's documentation](https://github.com/ma1uta/ma1sd/wiki/mxisd-"

  92. "and-your-privacy#choices-are-never-easy) for information on the privacy "

  93. "implications of setting up this SRV record."

  94. msgstr ""

  95. 

  96. #: ../../../docs/configuring-playbook-ma1sd.md:22

  97. msgid ""

  98. "**Note**: This `_matrix-identity._tcp` SRV record for the identity server"

  99. " is different from the `_matrix._tcp` that can be used for Synapse "

  100. "delegation. See [howto-server-delegation.md](howto-server-delegation.md) "

  101. "for more information about delegation."

  102. msgstr ""

  103. 

  104. #: ../../../docs/configuring-playbook-ma1sd.md:24

  105. msgid "Adjusting the playbook configuration"

  106. msgstr ""

  107. 

  108. #: ../../../docs/configuring-playbook-ma1sd.md:26

  109. msgid ""

  110. "To enable ma1sd, add the following configuration to your "

  111. "`inventory/host_vars/matrix.example.com/vars.yml` file:"

  112. msgstr ""

  113. 

  114. #: ../../../docs/configuring-playbook-ma1sd.md:32

  115. msgid "Matrix.org lookup forwarding"

  116. msgstr ""

  117. 

  118. #: ../../../docs/configuring-playbook-ma1sd.md:34

  119. msgid ""

  120. "To ensure maximum discovery, you can make your identity server also "

  121. "forward lookups to the central matrix.org Identity server (at the cost of"

  122. " potentially leaking all your contacts information)."

  123. msgstr ""

  124. 

  125. #: ../../../docs/configuring-playbook-ma1sd.md:36

  126. msgid ""

  127. "Enabling this is discouraged and you'd better [learn "

  128. "more](https://github.com/ma1uta/ma1sd/blob/master/docs/features/identity.md#lookups)"

  129. " before proceeding."

  130. msgstr ""

  131. 

  132. #: ../../../docs/configuring-playbook-ma1sd.md:38

  133. msgid ""

  134. "To enable matrix.org forwarding, add the following configuration to your "

  135. "`inventory/host_vars/matrix.example.com/vars.yml` file:"

  136. msgstr ""

  137. 

  138. #: ../../../docs/configuring-playbook-ma1sd.md:44

  139. msgid "Additional features"

  140. msgstr ""

  141. 

  142. #: ../../../docs/configuring-playbook-ma1sd.md:46

  143. msgid ""

  144. "What this playbook configures for your is some bare minimum Identity "

  145. "Server functionality, so that you won't need to rely on external 3rd "

  146. "party services."

  147. msgstr ""

  148. 

  149. #: ../../../docs/configuring-playbook-ma1sd.md:48

  150. msgid ""

  151. "A few variables can be toggled in this playbook to alter the ma1sd "

  152. "configuration that gets generated."

  153. msgstr ""

  154. 

  155. #: ../../../docs/configuring-playbook-ma1sd.md:50

  156. msgid ""

  157. "Still, ma1sd can do much more. You can refer to the [ma1sd "

  158. "website](https://github.com/ma1uta/ma1sd) for more details and "

  159. "configuration options."

  160. msgstr ""

  161. 

  162. #: ../../../docs/configuring-playbook-ma1sd.md:52

  163. msgid ""

  164. "To use a more custom configuration, you can define a "

  165. "`matrix_ma1sd_configuration_extension_yaml` string variable and put your "

  166. "configuration in it. To learn more about how to do this, refer to the "

  167. "information about `matrix_ma1sd_configuration_extension_yaml` in the "

  168. "[default variables file](../roles/custom/matrix-ma1sd/defaults/main.yml) "

  169. "of the ma1sd component."

  170. msgstr ""

  171. 

  172. #: ../../../docs/configuring-playbook-ma1sd.md:54

  173. msgid "Customizing email templates"

  174. msgstr ""

  175. 

  176. #: ../../../docs/configuring-playbook-ma1sd.md:56

  177. msgid ""

  178. "If you'd like to change the default email templates used by ma1sd, take a"

  179. " look at the `matrix_ma1sd_threepid_medium_email_custom_` variables (in "

  180. "the `roles/custom/matrix-ma1sd/defaults/main.yml` file."

  181. msgstr ""

  182. 

  183. #: ../../../docs/configuring-playbook-ma1sd.md:58

  184. msgid "ma1sd-controlled Registration"

  185. msgstr ""

  186. 

  187. #: ../../../docs/configuring-playbook-ma1sd.md:60

  188. msgid ""

  189. "To use the "

  190. "[Registration](https://github.com/ma1uta/ma1sd/blob/master/docs/features/registration.md)"

  191. " feature of ma1sd, you can make use of the following variables:"

  192. msgstr ""

  193. 

  194. #: ../../../docs/configuring-playbook-ma1sd.md:62

  195. msgid ""

  196. "`matrix_synapse_enable_registration` - to enable user-initiated "

  197. "registration in Synapse"

  198. msgstr ""

  199. 

  200. #: ../../../docs/configuring-playbook-ma1sd.md:64

  201. msgid ""

  202. "`matrix_synapse_enable_registration_captcha` - to validate registering "

  203. "users using reCAPTCHA, as described in the [enabling reCAPTCHA"

  204. "](configuring-captcha.md) documentation."

  205. msgstr ""

  206. 

  207. #: ../../../docs/configuring-playbook-ma1sd.md:66

  208. msgid ""

  209. "`matrix_synapse_registrations_require_3pid` - a list of 3pid types (among"

  210. " `'email'`, `'msisdn'`) required by the Synapse server for registering"

  211. msgstr ""

  212. 

  213. #: ../../../docs/configuring-playbook-ma1sd.md:68

  214. msgid ""

  215. "variables prefixed with `matrix_ma1sd_container_labels_` (e.g. "

  216. "`matrix_ma1sd_container_labels_matrix_client_3pid_registration_enabled`) "

  217. "- to configure the Traefik reverse-proxy to capture and send registration"

  218. " requests to ma1sd (instead of Synapse), so it can apply its additional "

  219. "functionality"

  220. msgstr ""

  221. 

  222. #: ../../../docs/configuring-playbook-ma1sd.md:70

  223. msgid ""

  224. "`matrix_ma1sd_configuration_extension_yaml` - to configure ma1sd as "

  225. "required. See the [Registration feature's "

  226. "docs](https://github.com/ma1uta/ma1sd/blob/master/docs/features/registration.md)"

  227. " for inspiration. Also see the [Additional features](#additional-"

  228. "features) section below to learn more about how to use "

  229. "`matrix_ma1sd_configuration_extension_yaml`."

  230. msgstr ""

  231. 

  232. #: ../../../docs/configuring-playbook-ma1sd.md:72

  233. msgid ""

  234. "**Note**: For this to work, either the homeserver needs to [federate"

  235. "](configuring-playbook-federation.md) or the `openid` APIs need to "

  236. "exposed on the federation port. When federation is disabled and ma1sd is "

  237. "enabled, we automatically expose the `openid` APIs (only!) on the "

  238. "federation port. Make sure the federation port (usually "

  239. "`https://matrix.example.com:8448`) is whitelisted in your firewall (even "

  240. "if you don't actually use/need federation)."

  241. msgstr ""

  242. 

  243. #: ../../../docs/configuring-playbook-ma1sd.md:74

  244. msgid "Authentication"

  245. msgstr ""

  246. 

  247. #: ../../../docs/configuring-playbook-ma1sd.md:76

  248. msgid ""

  249. "[Authentication](https://github.com/ma1uta/ma1sd/blob/master/docs/features/authentication.md)"

  250. " provides the possibility to use your own [Identity "

  251. "Stores](https://github.com/ma1uta/ma1sd/blob/master/docs/stores/README.md)"

  252. " (for example LDAP) to authenticate users on your Homeserver."

  253. msgstr ""

  254. 

  255. #: ../../../docs/configuring-playbook-ma1sd.md:78

  256. msgid ""

  257. "To enable authentication against an LDAP server, add the following "

  258. "configuration to your `inventory/host_vars/matrix.example.com/vars.yml` "

  259. "file:"

  260. msgstr ""

  261. 

  262. #: ../../../docs/configuring-playbook-ma1sd.md:98

  263. msgid "Example: SMS verification"

  264. msgstr ""

  265. 

  266. #: ../../../docs/configuring-playbook-ma1sd.md:100

  267. msgid ""

  268. "If your use case requires mobile verification, it is quite simple to "

  269. "integrate ma1sd with [Twilio](https://www.twilio.com/), an online "

  270. "telephony services gateway. Their prices are reasonable for low-volume "

  271. "projects and integration can be done with the following configuration:"

  272. msgstr ""

  273. 

  274. #: ../../../docs/configuring-playbook-ma1sd.md:114

  275. msgid "Example: Open Registration for every Domain"

  276. msgstr ""

  277. 

  278. #: ../../../docs/configuring-playbook-ma1sd.md:116

  279. msgid ""

  280. "If you want to open registration for any domain, you have to setup the "

  281. "allowed domains with ma1sd's `blacklist` and `whitelist`. The default "

  282. "behavior when neither the `blacklist`, nor the `whitelist` match, is to "

  283. "allow registration. Beware: you can't block toplevel domains (aka `.xy`) "

  284. "because the internal architecture of ma1sd doesn't allow that."

  285. msgstr ""

  286. 

  287. #: ../../../docs/configuring-playbook-ma1sd.md:130

  288. msgid "Installing"

  289. msgstr ""

  290. 

  291. #: ../../../docs/configuring-playbook-ma1sd.md:132

  292. msgid ""

  293. "After configuring the playbook, run it with [playbook tags](playbook-"

  294. "tags.md) as below:"

  295. msgstr ""

  296. 

  297. #: ../../../docs/configuring-playbook-ma1sd.md:139

  298. msgid ""

  299. "The shortcut commands with the [`just` program](just.md) are also "

  300. "available: `just install-all` or `just setup-all`"

  301. msgstr ""

  302. 

  303. #: ../../../docs/configuring-playbook-ma1sd.md:141

  304. msgid ""

  305. "`just install-all` is useful for maintaining your setup quickly ([2x-5x "

  306. "faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-"

  307. "runtime) than `just setup-all`) when its components remain unchanged. If "

  308. "you adjust your `vars.yml` to remove other components, you'd need to run "

  309. "`just setup-all`, or these components will still remain installed. Note "

  310. "these shortcuts run the `ensure-matrix-users-created` tag too."

  311. msgstr ""

  312. 

  313. #: ../../../docs/configuring-playbook-ma1sd.md:143

  314. msgid "Troubleshooting"

  315. msgstr ""

  316. 

  317. #: ../../../docs/configuring-playbook-ma1sd.md:145

  318. msgid ""

  319. "If email address validation emails sent by ma1sd are not reaching you, "

  320. "you should look into [Adjusting email-sending settings](configuring-"

  321. "playbook-email.md)."

  322. msgstr ""

  323. 

  324. #: ../../../docs/configuring-playbook-ma1sd.md:147

  325. msgid ""

  326. "If you'd like additional logging information, temporarily enable verbose "

  327. "logging for ma1sd."

  328. msgstr ""

  329. 

  330. #: ../../../docs/configuring-playbook-ma1sd.md:149

  331. msgid ""

  332. "To enable it, add the following configuration to your "

  333. "`inventory/host_vars/matrix.example.com/vars.yml` file:"

  334. msgstr ""

  335. 

  336. #~ msgid ""

  337. #~ "See the project's "

  338. #~ "[documentation](https://github.com/ma1uta/ma1sd) to learn"

  339. #~ " what it does and why it might"

  340. #~ " be useful to you."

  341. #~ msgstr ""