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.
8820 Commits
5 Branches
516 MiB
 
 
 
Tree: c51e771d1a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'c51e771d1a'
${ noResults }
matrix-docker-ansible-deploy/i18n/locales/jp/LC_MESSAGES/docs/configuring-playbook-matrix...

1045 lines
43 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-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. 

  23. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:1

  24. msgid "Setting up Matrix Authentication Service (optional)"

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:3

  28. msgid ""

  29. "This playbook can install and configure [Matrix Authentication "

  30. "Service](https://github.com/element-hq/matrix-authentication-service/) "

  31. "(MAS) - a service operating alongside your existing [Synapse"

  32. "](./configuring-playbook-synapse.md) homeserver and providing [better "

  33. "authentication, session management and permissions in "

  34. "Matrix](https://matrix.org/blog/2023/09/better-auth/)."

  35. msgstr ""

  36. 

  37. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:5

  38. msgid ""

  39. "Matrix Authentication Service is an implementation of [MSC3861: Next-"

  40. "generation auth for Matrix, based on OAuth 2.0/OIDC](https://github.com"

  41. "/matrix-org/matrix-spec-proposals/pull/3861) and still work in progress, "

  42. "tracked at the [areweoidcyet.com](https://areweoidcyet.com/) website."

  43. msgstr ""

  44. 

  45. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:7

  46. msgid ""

  47. "**Before going through with starting to use Matrix Authentication "

  48. "Service**, make sure to read:"

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:9

  52. msgid ""

  53. "the [Reasons to use Matrix Authentication Service](#reasons-to-use-"

  54. "matrix-authentication-service) section below"

  55. msgstr ""

  56. 

  57. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:10

  58. msgid "the [Expectations](#expectations) section below"

  59. msgstr ""

  60. 

  61. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:11

  62. msgid "the [FAQ section on areweoidcyet.com](https://areweoidcyet.com/#faqs)"

  63. msgstr ""

  64. 

  65. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:13

  66. msgid ""

  67. "**If you've already been using Synapse** and have user accounts in its "

  68. "database, you can [migrate to Matrix Authentication Service](#migrating-"

  69. "an-existing-synapse-homeserver-to-matrix-authentication-service)."

  70. msgstr ""

  71. 

  72. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:15

  73. msgid "Reasons to use Matrix Authentication Service"

  74. msgstr ""

  75. 

  76. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:17

  77. msgid ""

  78. "You may be wondering whether you should make the switch to Matrix "

  79. "Authentication Service (MAS) or keep using your existing authentication "

  80. "flow via Synapse (password-based or [OIDC](./configuring-playbook-"

  81. "synapse.md#synapse--openid-connect-for-single-sign-on)-enabled)."

  82. msgstr ""

  83. 

  84. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:19

  85. msgid ""

  86. "Matrix Authentication Service is **still an experimental service** and "

  87. "**not a default** for this Ansible playbook."

  88. msgstr ""

  89. 

  90. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:21

  91. msgid ""

  92. "The [Expectations](#expectations) section contains a list of what works "

  93. "and what doesn't (**some services don't work with MAS yet**), as well as "

  94. "the **relative irreversability** of the migration process."

  95. msgstr ""

  96. 

  97. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:23

  98. msgid ""

  99. "Below, we'll try to **highlight some potential reasons for switching** to"

  100. " Matrix Authentication Service:"

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:25

  104. msgid ""

  105. "To use SSO in [Element X](https://element.io/blog/element-x-ignition/). "

  106. "The old [Synapse OIDC](./configuring-playbook-synapse.md#synapse--openid-"

  107. "connect-for-single-sign-on) login flow is only supported in old Element "

  108. "clients and will not be supported in Element X. Element X will only "

  109. "support the new SSO-based login flow provided by MAS, so if you want to "

  110. "use SSO with Element X, you will need to switch to MAS."

  111. msgstr ""

  112. 

  113. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:27

  114. msgid ""

  115. "To help drive adoption of the \"Next-generation auth for Matrix\" by "

  116. "switching to what's ultimately coming anyway"

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:29

  120. msgid ""

  121. "To help discover (and potentially fix) MAS integration issues with this "

  122. "Ansible playbook"

  123. msgstr ""

  124. 

  125. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:31

  126. msgid ""

  127. "To help discover (and potentially fix) MAS integration issues with "

  128. "various other Matrix components (bridges, bots, clients, etc.)"

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:33

  132. msgid ""

  133. "To reap some of the security benefits that Matrix Authentication Service "

  134. "offers, as outlined in the [Better authentication, session management and"

  135. " permissions in Matrix](https://matrix.org/blog/2023/09/better-auth/) "

  136. "article."

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:35

  140. msgid "Prerequisites"

  141. msgstr ""

  142. 

  143. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:37

  144. msgid ""

  145. "⚠️ the [Synapse](configuring-playbook-synapse.md) homeserver "

  146. "implementation (which is the default for this playbook). Other homeserver"

  147. " implementations ([Dendrite](./configuring-playbook-dendrite.md), "

  148. "[Conduit](./configuring-playbook-conduit.md), etc.) do not support "

  149. "integrating wtih Matrix Authentication Service yet."

  150. msgstr ""

  151. 

  152. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:39

  153. msgid ""

  154. "⚠️ **email sending** configured (see [Adjusting email-sending settings"

  155. "](./configuring-playbook-email.md)), because **Matrix Authentication "

  156. "Service [still insists](https://github.com/element-hq/matrix-"

  157. "authentication-service/issues/1505) on having a verified email address "

  158. "for each user** going through the new SSO-based login flow. It's also "

  159. "possible to [work around email deliverability issues](#working-around-"

  160. "email-deliverability-issues) if your email configuration is not working."

  161. msgstr ""

  162. 

  163. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:41

  164. msgid ""

  165. "❌ **disabling all password providers** for Synapse (things like [shared-"

  166. "secret-auth](./configuring-playbook-shared-secret-auth.md), [rest-auth"

  167. "](./configuring-playbook-rest-auth.md), [LDAP auth](./configuring-"

  168. "playbook-ldap-auth.md), etc.) More details about this are available in "

  169. "the [Expectations](#expectations) section below."

  170. msgstr ""

  171. 

  172. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:43

  173. msgid "Expectations"

  174. msgstr ""

  175. 

  176. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:45

  177. msgid ""

  178. "This section details what you can expect when switching to the Matrix "

  179. "Authentication Service (MAS)."

  180. msgstr ""

  181. 

  182. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:47

  183. msgid ""

  184. "❌ **Synapse password providers will need to be disabled**. You can no "

  185. "longer use [shared-secret-auth](./configuring-playbook-shared-secret-"

  186. "auth.md), [rest-auth](./configuring-playbook-rest-auth.md), [LDAP auth"

  187. "](./configuring-playbook-ldap-auth.md), etc. When the authentication flow"

  188. " is handled by MAS (not by Synapse anymore), it doesn't make sense to "

  189. "extend the Synapse authentication flow with additional modules. Many "

  190. "bridges used to rely on shared-secret-auth for doing double-puppeting "

  191. "(impersonating other users), but most (at least the mautrix bridges) "

  192. "nowadays use [Appservice Double Puppet](./configuring-playbook-"

  193. "appservice-double-puppet.md) as a better alternative. Older/maintained "

  194. "bridges may still rely on shared-secret-auth, as do other services like "

  195. "[matrix-corporal](./configuring-playbook-matrix-corporal.md)."

  196. msgstr ""

  197. 

  198. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:49

  199. msgid ""

  200. "❌ Certain **tools like [synapse-admin](./configuring-playbook-synapse-"

  201. "admin.md) do not have full compatibility with MAS yet**. synapse-admin "

  202. "already supports [login with access token](https://github.com/etkecc"

  203. "/synapse-admin/pull/58), browsing users (which Synapse will internally "

  204. "fetch from MAS) and updating user avatars. However, editing users "

  205. "(passwords, etc.) now needs to happen directly against MAS using the [MAS"

  206. " Admin API](https://element-hq.github.io/matrix-authentication-"

  207. "service/api/index.html), which synapse-admin cannot interact with yet."

  208. msgstr ""

  209. 

  210. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:51

  211. msgid "❌ **Some services experience issues when authenticating via MAS**:"

  212. msgstr ""

  213. 

  214. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:53

  215. msgid ""

  216. "[Postmoogle](./configuring-playbook-bridge-postmoogle.md) works the first"

  217. " time around, but it consistently fails after restarting:"

  218. msgstr ""

  219. 

  220. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:55

  221. msgid ""

  222. "cannot initialize matrix bot error=\"olm account is marked as shared, "

  223. "keys seem to have disappeared from the server\""

  224. msgstr ""

  225. 

  226. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:57

  227. msgid ""

  228. "[matrix-reminder-bot](./configuring-playbook-bot-matrix-reminder-bot.md) "

  229. "fails to start (see [element-hq/matrix-authentication-"

  230. "service#3439](https://github.com/element-hq/matrix-authentication-"

  231. "service/issues/3439))"

  232. msgstr ""

  233. 

  234. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:58

  235. msgid "Other services may be similarly affected. This list is not exhaustive."

  236. msgstr ""

  237. 

  238. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:60

  239. msgid ""

  240. "❌ **Encrypted appservices** do not work yet (related to "

  241. "[MSC4190](https://github.com/matrix-org/matrix-spec-proposals/pull/4190) "

  242. "and [PR 17705 for Synapse](https://github.com/element-"

  243. "hq/synapse/pull/17705)), so all bridges/bots that rely on encryption will"

  244. " fail to start (see [this issue](https://github.com/spantaleev/matrix-"

  245. "docker-ansible-deploy/issues/3658) for Hookshot). You can use these "

  246. "bridges/bots only if you **keep end-to-bridge encryption disabled** "

  247. "(which is the default setting)."

  248. msgstr ""

  249. 

  250. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:62

  251. msgid ""

  252. "⚠️ **You will need to have email sending configured** (see [Adjusting "

  253. "email-sending settings](./configuring-playbook-email.md)), because "

  254. "**Matrix Authentication Service [still insists](https://github.com"

  255. "/element-hq/matrix-authentication-service/issues/1505) on having a "

  256. "verified email address for each user** going through the new SSO-based "

  257. "login flow. It's also possible to [work around email deliverability "

  258. "issues](#working-around-email-deliverability-issues) if your email "

  259. "configuration is not working."

  260. msgstr ""

  261. 

  262. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:64

  263. msgid ""

  264. "⚠️ [Migrating an existing Synapse homeserver to Matrix Authentication "

  265. "Service](#migrating-an-existing-synapse-homeserver-to-matrix-"

  266. "authentication-service) is **possible**, but requires **some playbook-"

  267. "assisted manual work**. Migration is **reversible with no or minor issues"

  268. " if done quickly enough**, but as users start logging in (creating new "

  269. "login sessions) via the new MAS setup, disabling MAS and reverting back "

  270. "to the Synapse user database will cause these new sessions to break."

  271. msgstr ""

  272. 

  273. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:66

  274. msgid ""

  275. "⚠️ [Migrating an existing Synapse homeserver to Matrix Authentication "

  276. "Service](#migrating-an-existing-synapse-homeserver-to-matrix-"

  277. "authentication-service) does not currently seem to preserve the \"admin\""

  278. " flag for users (as found in the Synapse database). All users are "

  279. "imported as non-admin - see [element-hq/matrix-authentication-"

  280. "service#3440](https://github.com/element-hq/matrix-authentication-"

  281. "service/issues/3440). You may need update the Matrix Authentication "

  282. "Service's database manually and adjust the `can_request_admin` column in "

  283. "the `users` table to `true` for users that need to be administrators "

  284. "(e.g. `UPDATE users SET can_request_admin = true WHERE username = "

  285. "'someone';`)"

  286. msgstr ""

  287. 

  288. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:68

  289. msgid ""

  290. "⚠️ Delegating user authentication to MAS causes **your Synapse server to "

  291. "be completely dependant on one more service** for its operations. MAS is "

  292. "quick & lightweight and should be stable enough already, but this is "

  293. "something to keep in mind when making the switch."

  294. msgstr ""

  295. 

  296. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:70

  297. msgid ""

  298. "⚠️ If you've got [OIDC configured in Synapse](./configuring-playbook-"

  299. "synapse.md#synapse--openid-connect-for-single-sign-on), you will need to "

  300. "migrate your OIDC configuration to MAS by adding an [Upstream OAuth2 "

  301. "configuration](#upstream-oauth2-configuration)."

  302. msgstr ""

  303. 

  304. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:72

  305. msgid ""

  306. "⚠️ A [compatibility layer](https://element-hq.github.io/matrix-"

  307. "authentication-service/setup/homeserver.html#set-up-the-compatibility-"

  308. "layer) is installed - all `/_matrix/client/*/login` (etc.) requests will "

  309. "be routed to MAS instead of going to the homeserver. This is done both "

  310. "publicly (e.g. `https://matrix.example.com/_matrix/client/*/login`) and "

  311. "on the internal Traefik entrypoint (e.g. `https://matrix-"

  312. "traefik:8008/_matrix/client/*/login`) which helps addon services reach "

  313. "the homeserver's Client-Server API. You typically don't need to do "

  314. "anything to make this work, but it's good to be aware of it, especially "

  315. "if you have a [custom webserver setup](./configuring-playbook-own-"

  316. "webserver.md)."

  317. msgstr ""

  318. 

  319. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:74

  320. msgid ""

  321. "✅ Your **existing login sessions will continue to work** (you won't get "

  322. "logged out). Migration will require a bit of manual work and minutes of "

  323. "downtime, but it's not too bad."

  324. msgstr ""

  325. 

  326. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:76

  327. msgid ""

  328. "✅ Various clients ([Cinny](./configuring-playbook-client-cinny.md), "

  329. "[Element Web](./configuring-playbook-client-element-web.md), Element X, "

  330. "FluffyChat) will be able to use the **new SSO-based login flow** provided"

  331. " by Matrix Authentication Service"

  332. msgstr ""

  333. 

  334. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:78

  335. msgid ""

  336. "✅ The **old login flow** (called `m.login.password`) **will still "

  337. "continue to work**, so clients (old Element Web, etc.) and bridges/bots "

  338. "that don't support the new OIDC-based login flow will still work. Going "

  339. "through the old login flow does not require users to have a verified "

  340. "email address, as [is the case](https://github.com/element-hq/matrix-"

  341. "authentication-service/issues/1505) for the new SSO-based login flow."

  342. msgstr ""

  343. 

  344. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:80

  345. msgid ""

  346. "✅ [Registering users](./registering-users.md) via **the playbook's "

  347. "`register-user` tag remains unchanged**. The playbook automatically does "

  348. "the right thing regardless of homeserver implementation (Synapse, "

  349. "Dendrite, etc.) and whether MAS is enabled or not. When MAS is enabled, "

  350. "the playbook will forward user-registration requests to MAS. Registering "

  351. "users via the command-line is no longer done via the "

  352. "`/matrix/synapse/bin/register` script, but via `/matrix/matrix-"

  353. "authentication-service/bin/register-user`."

  354. msgstr ""

  355. 

  356. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:82

  357. msgid ""

  358. "✅ Users that are prepared by the playbook (for bots, bridges, etc.) will "

  359. "continue to be registered automatically as expected. The playbook "

  360. "automatically does the right thing regardless of homeserver "

  361. "implementation (Synapse, Dendrite, etc.) and whether MAS is enabled or "

  362. "not. When MAS is enabled, the playbook will forward user-registration "

  363. "requests to MAS."

  364. msgstr ""

  365. 

  366. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:84

  367. msgid "Installation flows"

  368. msgstr ""

  369. 

  370. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:86

  371. msgid "New homeserver"

  372. msgstr ""

  373. 

  374. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:88

  375. msgid ""

  376. "For new homeservers (which don't have any users in their Synapse database"

  377. " yet), follow the [Adjusting the playbook configuration](#adjusting-the-"

  378. "playbook-configuration) instructions and then proceed with "

  379. "[Installing](#installing)."

  380. msgstr ""

  381. 

  382. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:90

  383. msgid "Existing homeserver"

  384. msgstr ""

  385. 

  386. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:92

  387. msgid ""

  388. "Other homeserver implementations ([Dendrite](./configuring-playbook-"

  389. "dendrite.md), [Conduit](./configuring-playbook-conduit.md), etc.) do not "

  390. "support integrating wtih Matrix Authentication Service yet."

  391. msgstr ""

  392. 

  393. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:94

  394. msgid "For existing Synapse homeservers:"

  395. msgstr ""

  396. 

  397. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:96

  398. msgid ""

  399. "when following the [Adjusting the playbook configuration](#adjusting-the-"

  400. "playbook-configuration) instructions, make sure to **disable the "

  401. "integration between Synapse and MAS** by **uncommenting** the "

  402. "`matrix_authentication_service_migration_in_progress: true` line as "

  403. "described in the [Marking an existing homeserver for migration](#marking-"

  404. "an-existing-homeserver-for-migration) section below."

  405. msgstr ""

  406. 

  407. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:98

  408. msgid ""

  409. "then follow the [Migrating an existing Synapse homeserver to Matrix "

  410. "Authentication Service](#migrating-an-existing-synapse-homeserver-to-"

  411. "matrix-authentication-service) instructions to perform the installation "

  412. "and migration"

  413. msgstr ""

  414. 

  415. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:100

  416. msgid "Adjusting the playbook configuration"

  417. msgstr ""

  418. 

  419. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:102

  420. msgid ""

  421. "To enable Matrix Authentication Service, add the following configuration "

  422. "to your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  423. msgstr ""

  424. 

  425. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:116

  426. msgid ""

  427. "In the sub-sections that follow, we'll cover some additional "

  428. "configuration options that you may wish to adjust."

  429. msgstr ""

  430. 

  431. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:118

  432. msgid ""

  433. "There are many other configuration options available. Consult the "

  434. "[`defaults/main.yml` file](../roles/custom/matrix-authentication-"

  435. "service/defaults/main.yml) in the [matrix-authentication-service "

  436. "role](../roles/custom/matrix-authentication-service/) to discover them."

  437. msgstr ""

  438. 

  439. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:120

  440. msgid "Adjusting the Matrix Authentication Service URL"

  441. msgstr ""

  442. 

  443. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:122

  444. msgid ""

  445. "By default, this playbook installs the Matrix Authentication Service on "

  446. "the `matrix.` subdomain, at the `/auth` path "

  447. "(https://matrix.example.com/auth). This makes it easy to install it, "

  448. "because it **doesn't require additional DNS records to be set up**. If "

  449. "that's okay, you can skip this section."

  450. msgstr ""

  451. 

  452. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:124

  453. msgid ""

  454. "By tweaking the `matrix_authentication_service_hostname` and "

  455. "`matrix_authentication_service_path_prefix` variables, you can easily "

  456. "make the service available at a **different hostname and/or path** than "

  457. "the default one."

  458. msgstr ""

  459. 

  460. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:126

  461. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:149

  462. msgid ""

  463. "Example additional configuration for your "

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

  465. msgstr ""

  466. 

  467. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:134

  468. msgid "Marking an existing homeserver for migration"

  469. msgstr ""

  470. 

  471. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:136

  472. msgid ""

  473. "The [configuration above](#adjusting-the-playbook-configuration) "

  474. "instructs existing users wishing to migrate to add "

  475. "`matrix_authentication_service_migration_in_progress: true` to their "

  476. "configuration."

  477. msgstr ""

  478. 

  479. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:138

  480. msgid ""

  481. "This is done temporarily. The migration steps are described in more "

  482. "detail in the [Migrating an existing Synapse homeserver to Matrix "

  483. "Authentication Service](#migrating-an-existing-synapse-homeserver-to-"

  484. "matrix-authentication-service) section below."

  485. msgstr ""

  486. 

  487. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:140

  488. msgid "Upstream OAuth2 configuration"

  489. msgstr ""

  490. 

  491. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:142

  492. msgid ""

  493. "To make Matrix Authentication Service delegate to an existing upstream "

  494. "OAuth 2.0/OIDC provider, you can use its [`upstream_oauth2.providers` "

  495. "setting](https://element-hq.github.io/matrix-authentication-"

  496. "service/reference/configuration.html#upstream_oauth2providers)."

  497. msgstr ""

  498. 

  499. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:144

  500. msgid ""

  501. "The playbook exposes a "

  502. "`matrix_authentication_service_config_upstream_oauth2_providers` variable"

  503. " for controlling this setting."

  504. msgstr ""

  505. 

  506. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:261

  507. msgid ""

  508. "💡 Refer to the [`upstream_oauth2.providers` setting](https://element-"

  509. "hq.github.io/matrix-authentication-"

  510. "service/reference/configuration.html#upstream_oauth2providers) for the "

  511. "most up-to-date schema and example for providers. The value shown above "

  512. "here may be out of date."

  513. msgstr ""

  514. 

  515. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:263

  516. msgid ""

  517. "⚠️ The syntax for existing [OIDC providers configured in Synapse"

  518. "](./configuring-playbook-synapse.md#synapse--openid-connect-for-single-"

  519. "sign-on) is slightly different, so you will need to adjust your "

  520. "configuration when switching from Synapse OIDC to MAS upstream OAuth2."

  521. msgstr ""

  522. 

  523. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:265

  524. msgid ""

  525. "⚠️ When [migrating an existing homeserver](#migrating-an-existing-"

  526. "synapse-homeserver-to-matrix-authentication-service) which contains OIDC-"

  527. "sourced users, you will need to:"

  528. msgstr ""

  529. 

  530. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:267

  531. msgid ""

  532. "[Configure upstream OIDC provider mapping for syn2mas](#configuring-"

  533. "upstream-oidc-provider-mapping-for-syn2mas)"

  534. msgstr ""

  535. 

  536. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:268

  537. msgid ""

  538. "go through the [migrating an existing homeserver](#migrating-an-existing-"

  539. "synapse-homeserver-to-matrix-authentication-service) process"

  540. msgstr ""

  541. 

  542. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:269

  543. msgid ""

  544. "remove all Synapse OIDC-related configuration (`matrix_synapse_oidc_*`) "

  545. "to prevent it being in conflict with the MAS OIDC configuration"

  546. msgstr ""

  547. 

  548. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:271

  549. msgid "Adjusting DNS records"

  550. msgstr ""

  551. 

  552. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:273

  553. msgid ""

  554. "If you've changed the default hostname, **you may need to adjust your "

  555. "DNS** records to point the Matrix Authentication Service domain to the "

  556. "Matrix server."

  557. msgstr ""

  558. 

  559. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:275

  560. msgid "See [Configuring DNS](configuring-dns.md) for details about DNS changes."

  561. msgstr ""

  562. 

  563. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:277

  564. msgid ""

  565. "If you've decided to use the default hostname, you won't need to do any "

  566. "extra DNS configuration."

  567. msgstr ""

  568. 

  569. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:279

  570. msgid "Installing"

  571. msgstr ""

  572. 

  573. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:281

  574. msgid ""

  575. "Now that you've [adjusted the playbook configuration](#adjusting-the-"

  576. "playbook-configuration) and [your DNS records](#adjusting-dns-records), "

  577. "you can run the playbook with [playbook tags](playbook-tags.md) as below:"

  578. msgstr ""

  579. 

  580. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:288

  581. msgid "**Notes**:"

  582. msgstr ""

  583. 

  584. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:290

  585. msgid ""

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

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

  588. msgstr ""

  589. 

  590. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:292

  591. msgid ""

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

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

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

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

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

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

  598. msgstr ""

  599. 

  600. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:294

  601. msgid ""

  602. "If you're in the process of migrating an existing Synapse homeserver to "

  603. "MAS, you should now follow the rest of the steps in the [Migrating an "

  604. "existing Synapse homeserver to Matrix Authentication Service](#migrating-"

  605. "an-existing-synapse-homeserver-to-matrix-authentication-service) guide."

  606. msgstr ""

  607. 

  608. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:296

  609. msgid ""

  610. "💡 After installation, you should [verify that Matrix Authentication "

  611. "Service is installed correctly](#verify-that-matrix-authentication-"

  612. "service-is-installed-correctly)."

  613. msgstr ""

  614. 

  615. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:298

  616. msgid "Migrating an existing Synapse homeserver to Matrix Authentication Service"

  617. msgstr ""

  618. 

  619. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:300

  620. msgid ""

  621. "Our migration guide is loosely based on the upstream [Migrating an "

  622. "existing homeserver](https://element-hq.github.io/matrix-authentication-"

  623. "service/setup/migration.html) guide."

  624. msgstr ""

  625. 

  626. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:302

  627. msgid ""

  628. "Migration is done via a tool called `syn2mas`, which the playbook could "

  629. "run for you (in a container)."

  630. msgstr ""

  631. 

  632. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:304

  633. msgid "The installation + migration steps are like this:"

  634. msgstr ""

  635. 

  636. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:306

  637. msgid ""

  638. "[Adjust your configuration](#adjusting-the-playbook-configuration) to "

  639. "**disable the integration between the homeserver and MAS**. This is done "

  640. "by **uncommenting** the "

  641. "`matrix_authentication_service_migration_in_progress: true` line."

  642. msgstr ""

  643. 

  644. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:308

  645. msgid "Perform the initial [installation](#installing). At this point:"

  646. msgstr ""

  647. 

  648. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:310

  649. msgid ""

  650. "Matrix Authentication Service will be installed. Its database will be "

  651. "empty, so it cannot validate existing access tokens or authentication "

  652. "users yet."

  653. msgstr ""

  654. 

  655. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:312

  656. msgid ""

  657. "The homeserver will still continue to use its local database for "

  658. "validating existing access tokens."

  659. msgstr ""

  660. 

  661. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:314

  662. msgid ""

  663. "Various [compatibility layer URLs](https://element-hq.github.io/matrix-"

  664. "authentication-service/setup/homeserver.html#set-up-the-compatibility-"

  665. "layer) are not yet installed. New login sessions will still be forwarded "

  666. "to the homeserver, which is capable of completing them."

  667. msgstr ""

  668. 

  669. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:316

  670. msgid ""

  671. "The `matrix-user-creator` role would be suppressed, so that it doesn't "

  672. "automatically attempt to create users (for bots, etc.) in the MAS "

  673. "database. These user accounts likely already exist in Synapse's user "

  674. "database and could be migrated over (via syn2mas, as per the steps "

  675. "below), so creating them in the MAS database would have been unnecessary "

  676. "and potentially problematic (conflicts during the syn2mas migration)."

  677. msgstr ""

  678. 

  679. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:318

  680. msgid ""

  681. "Consider taking a full [backup of your Postgres database](./maintenance-"

  682. "postgres.md#backing-up-postgresql). This is done just in case. The "

  683. "**syn2mas migration tool does not delete any data**, so it should be "

  684. "possible to revert to your previous setup by merely disabling MAS and re-"

  685. "running the playbook (no need to restore a Postgres backup). However, do "

  686. "note that as users start logging in (creating new login sessions) via the"

  687. " new MAS setup, disabling MAS and reverting back to the Synapse user "

  688. "database will cause these new sessions to break."

  689. msgstr ""

  690. 

  691. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:320

  692. msgid ""

  693. "[Migrate your data from Synapse to Matrix Authentication Service using "

  694. "syn2mas](#migrate-your-data-from-synapse-to-matrix-authentication-"

  695. "service-using-syn2mas)"

  696. msgstr ""

  697. 

  698. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:322

  699. msgid ""

  700. "[Adjust your configuration](#adjusting-the-playbook-configuration) again,"

  701. " to:"

  702. msgstr ""

  703. 

  704. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:324

  705. msgid ""

  706. "remove the `matrix_authentication_service_migration_in_progress: false` "

  707. "line"

  708. msgstr ""

  709. 

  710. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:326

  711. msgid ""

  712. "if you had been using [OIDC providers configured in Synapse"

  713. "](./configuring-playbook-synapse.md#synapse--openid-connect-for-single-"

  714. "sign-on), remove all Synapse OIDC-related configuration "

  715. "(`matrix_synapse_oidc_*`) to prevent it being in conflict with the MAS "

  716. "OIDC configuration"

  717. msgstr ""

  718. 

  719. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:328

  720. msgid "Perform the [installation](#installing) again. At this point:"

  721. msgstr ""

  722. 

  723. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:330

  724. msgid "The homeserver will start delegating authentication to MAS."

  725. msgstr ""

  726. 

  727. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:332

  728. msgid ""

  729. "The compatibility layer URLs will be installed. New login sessions will "

  730. "be completed by MAS."

  731. msgstr ""

  732. 

  733. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:334

  734. msgid ""

  735. "[Verify that Matrix Authentication Service is installed correctly"

  736. "](#verify-that-matrix-authentication-service-is-installed-correctly)"

  737. msgstr ""

  738. 

  739. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:336

  740. msgid ""

  741. "Migrate your data from Synapse to Matrix Authentication Service using "

  742. "syn2mas"

  743. msgstr ""

  744. 

  745. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:338

  746. msgid ""

  747. "We **don't** ask you to [run the `syn2mas` migration advisor "

  748. "command](https://element-hq.github.io/matrix-authentication-"

  749. "service/setup/migration.html#run-the-migration-advisor), because it only "

  750. "gives you the green light if your Synapse configuration "

  751. "(`homeserver.yaml`) is configured in a way that's compatible with MAS "

  752. "(delegating authentication to MAS; disabling Synapse's password config; "

  753. "etc.). Until we migrate your data with the `syn2mas` tool, we "

  754. "intentionally avoid doing these changes to allow existing user sessions "

  755. "to work."

  756. msgstr ""

  757. 

  758. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:340

  759. msgid ""

  760. "You can invoke the `syn2mas` tool via the playbook by running the "

  761. "playbook's `matrix-authentication-service-syn2mas` tag. We recommend "

  762. "first doing a [dry-run](#performing-a-syn2mas-dry-run) and then a [real "

  763. "migration](#performing-a-real-syn2mas-migration)."

  764. msgstr ""

  765. 

  766. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:342

  767. msgid "Configuring syn2mas"

  768. msgstr ""

  769. 

  770. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:344

  771. msgid ""

  772. "If you're using [OIDC with Synapse](./configuring-playbook-"

  773. "synapse.md#synapse--openid-connect-for-single-sign-on), you will need to "

  774. "[Configuring upstream OIDC provider mapping for syn2mas](#configuring-"

  775. "upstream-oidc-provider-mapping-for-syn2mas)."

  776. msgstr ""

  777. 

  778. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:346

  779. msgid ""

  780. "If you only have local (non-OIDC) users in your Synapse database, you can"

  781. " likely run `syn2mas` as-is (without doing additional configuration "

  782. "changes)."

  783. msgstr ""

  784. 

  785. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:348

  786. msgid ""

  787. "When you're done with potentially configuring `syn2mas`, proceed to doing"

  788. " a [dry-run](#performing-a-syn2mas-dry-run) and then a [real "

  789. "migration](#performing-a-real-syn2mas-migration)."

  790. msgstr ""

  791. 

  792. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:350

  793. msgid "Configuring upstream OIDC provider mapping for syn2mas"

  794. msgstr ""

  795. 

  796. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:352

  797. msgid ""

  798. "If you have existing OIDC users in your Synapse user database (which will"

  799. " be the case if when using [OIDC with Synapse](./configuring-playbook-"

  800. "synapse.md#synapse--openid-connect-for-single-sign-on)), you may need to "

  801. "pass an additional `--upstreamProviderMapping` argument to the `syn2mas` "

  802. "tool to tell it which provider (on the Synapse side) maps to which other "

  803. "provider on the MAS side."

  804. msgstr ""

  805. 

  806. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:354

  807. msgid "If you don't do this, `syn2mas` would report errors like this one:"

  808. msgstr ""

  809. 

  810. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:356

  811. msgid ""

  812. "[FATAL] migrate - [Failed to import external id 4264b0f0-4f11-4ddd-aedb-"

  813. "b500e4d07c25 with oidc-keycloak for user @alice:example.com: Error: "

  814. "Unknown upstream provider oidc-keycloak]"

  815. msgstr ""

  816. 

  817. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:358

  818. msgid "Below is an example situation and a guide for how to solve it."

  819. msgstr ""

  820. 

  821. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:360

  822. msgid ""

  823. "If in `matrix_synapse_oidc_providers` your provider `idp_id` is (was) "

  824. "named `keycloak`, in the Synapse database users would be associated with "

  825. "the `oidc-keycloak` provider (note the `oidc-` prefix that was added "

  826. "automatically by Synapse to your `idp_id` value)."

  827. msgstr ""

  828. 

  829. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:362

  830. msgid ""

  831. "The same OIDC provider may have an `id` of `01HFVBY12TMNTYTBV8W921M5FA` "

  832. "on the MAS side, as defined in "

  833. "`matrix_authentication_service_config_upstream_oauth2_providers` (see the"

  834. " [Upstream OAuth2 configuration](#upstream-oauth2-configuration) section "

  835. "above)."

  836. msgstr ""

  837. 

  838. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:364

  839. msgid ""

  840. "To tell `syn2mas` how the Synapse-configured OIDC provider maps to the "

  841. "new MAS-configured OIDC provider, add this additional configuration to "

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

  843. msgstr ""

  844. 

  845. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:373

  846. msgid "Performing a syn2mas dry-run"

  847. msgstr ""

  848. 

  849. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:375

  850. msgid ""

  851. "Having [configured syn2mas](#configuring-syn2mas), we recommend doing a "

  852. "[dry-run](https://en.wikipedia.org/wiki/Dry_run_(testing)) first to "

  853. "verify that everything will work out as expected."

  854. msgstr ""

  855. 

  856. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:377

  857. msgid "A dry-run would not cause downtime, because it avoids stopping Synapse."

  858. msgstr ""

  859. 

  860. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:379

  861. msgid "To perform a dry-run, run:"

  862. msgstr ""

  863. 

  864. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:385

  865. msgid ""

  866. "Observe the command output (especially the last line of the the syn2mas "

  867. "output). If you are confident that the migration will work out as "

  868. "expected, you can proceed with a [real migration](#performing-a-real-"

  869. "syn2mas-migration)."

  870. msgstr ""

  871. 

  872. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:387

  873. msgid "Performing a real syn2mas migration"

  874. msgstr ""

  875. 

  876. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:389

  877. msgid "Before performing a real migration make sure:"

  878. msgstr ""

  879. 

  880. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:391

  881. msgid "you've familiarized yourself with the [expectations](#expectations)"

  882. msgstr ""

  883. 

  884. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:393

  885. msgid "you've performed a Postgres backup, just in case"

  886. msgstr ""

  887. 

  888. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:395

  889. msgid ""

  890. "you're aware of the irreversibility of the migration process without "

  891. "disruption after users have created new login sessions via the new MAS "

  892. "setup"

  893. msgstr ""

  894. 

  895. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:397

  896. msgid ""

  897. "you've [configured syn2mas](#configuring-syn2mas), especially if you've "

  898. "used [OIDC with Synapse](./configuring-playbook-synapse.md#synapse"

  899. "--openid-connect-for-single-sign-on)"

  900. msgstr ""

  901. 

  902. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:399

  903. msgid ""

  904. "you've performed a [syn2mas dry-run](#performing-a-syn2mas-dry-run) and "

  905. "don't see any issues in its output"

  906. msgstr ""

  907. 

  908. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:401

  909. msgid ""

  910. "To perform a real migration, run the `matrix-authentication-service-"

  911. "syn2mas` tag **without** the "

  912. "`matrix_authentication_service_syn2mas_dry_run` variable:"

  913. msgstr ""

  914. 

  915. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:407

  916. msgid ""

  917. "Having performed a `syn2mas` migration once, trying to do it again will "

  918. "report errors for users that were already migrated (e.g. \"Error: Unknown"

  919. " upstream provider oauth-delegated\")."

  920. msgstr ""

  921. 

  922. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:409

  923. msgid "Verify that Matrix Authentication Service is installed correctly"

  924. msgstr ""

  925. 

  926. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:411

  927. msgid ""

  928. "After [installation](#installing), run the `doctor` subcommand of the "

  929. "[`mas-cli` command-line tool](https://element-hq.github.io/matrix-"

  930. "authentication-service/reference/cli/index.html) to verify that MAS is "

  931. "installed correctly."

  932. msgstr ""

  933. 

  934. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:413

  935. msgid "You can do it:"

  936. msgstr ""

  937. 

  938. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:415

  939. msgid ""

  940. "either via the Ansible playbook's `matrix-authentication-service-mas-cli-"

  941. "doctor` tag: `just run-tags matrix-authentication-service-mas-cli-doctor`"

  942. msgstr ""

  943. 

  944. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:417

  945. msgid ""

  946. "or by running the `mas-cli` script on the server (which invokes the `mas-"

  947. "cli` tool inside a container): `/matrix/matrix-authentication-service/bin"

  948. "/mas-cli doctor`"

  949. msgstr ""

  950. 

  951. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:419

  952. msgid "If successful, you should see some output that looks like this:"

  953. msgstr ""

  954. 

  955. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:431

  956. msgid "Management"

  957. msgstr ""

  958. 

  959. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:433

  960. msgid ""

  961. "You can use the [`mas-cli` command-line tool](https://element-"

  962. "hq.github.io/matrix-authentication-service/reference/cli/index.html) "

  963. "(exposed via the `/matrix/matrix-authentication-service/bin/mas-cli` "

  964. "script) to perform administrative tasks against MAS."

  965. msgstr ""

  966. 

  967. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:435

  968. msgid "This documentation page already mentions:"

  969. msgstr ""

  970. 

  971. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:437

  972. msgid ""

  973. "the `mas-cli doctor` sub-command in the [Verify that Matrix "

  974. "Authentication Service is installed correctly](#verify-that-matrix-"

  975. "authentication-service-is-installed-correctly) section, which you can run"

  976. " via the CLI and via the Ansible playbook's `matrix-authentication-"

  977. "service-mas-cli-doctor` tag"

  978. msgstr ""

  979. 

  980. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:439

  981. msgid ""

  982. "the `mas-cli manage register-user` sub-command in the [Registering users"

  983. "](./registering-users.md) documentation"

  984. msgstr ""

  985. 

  986. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:441

  987. msgid ""

  988. "There are other sub-commands available. Run `/matrix/matrix-"

  989. "authentication-service/bin/mas-cli` to get an overview."

  990. msgstr ""

  991. 

  992. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:443

  993. msgid "User registration"

  994. msgstr ""

  995. 

  996. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:445

  997. msgid ""

  998. "After Matrix Authentication Service is [installed](#installing), users "

  999. "need to be managed there (unless you're managing them in an [upstream "

  1000. "OAuth2 provider](#upstream-oauth2-configuration))."

  1001. msgstr ""

  1002. 

  1003. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:447

  1004. msgid ""

  1005. "You can register users new users as described in the [Registering users"

  1006. "](./registering-users.md) documentation (via `mas-cli manage register-"

  1007. "user` or the Ansible playbook's `register-user` tag)."

  1008. msgstr ""

  1009. 

  1010. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:449

  1011. msgid "Working around email deliverability issues"

  1012. msgstr ""

  1013. 

  1014. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:451

  1015. msgid ""

  1016. "Because Matrix Authentication Service [still insists](https://github.com"

  1017. "/element-hq/matrix-authentication-service/issues/1505) on having a "

  1018. "verified email address for each user, you may need to work around email "

  1019. "deliverability issues if [your email-sending configuration"

  1020. "](./configuring-playbook-email.md) is not working."

  1021. msgstr ""

  1022. 

  1023. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:453

  1024. msgid ""

  1025. "Matrix Authentication Service attempts to verify email addresses by "

  1026. "sending a verification email to the address specified by the user "

  1027. "whenever they log in to an account without a verified email address."

  1028. msgstr ""

  1029. 

  1030. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:455

  1031. msgid ""

  1032. "If email delivery is not working, **you can retrieve the email "

  1033. "configuration code from the Matrix Authentication Service's logs** "

  1034. "(`journalctl -fu matrix-authentication-service`)."

  1035. msgstr ""

  1036. 

  1037. #: ../../../docs/configuring-playbook-matrix-authentication-service.md:457

  1038. msgid ""

  1039. "Alternatively, you can use the [`mas-cli` management tool](#management) "

  1040. "to manually verify email addresses for users. Example: `/matrix/matrix-"

  1041. "authentication-service/bin/mas-cli manage verify-email some.username "

  1042. "email@example.com`"

  1043. msgstr ""