overmind
/
matrix-docker-ansible-deploy
miroir de https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Bifurcation 0
Code Tickets 0 Versions 0 Wiki Activité
Matrix Docker Ansible eploy
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.
10858 Révisions
13 Branches
36 MiB
 
 
Aborescence: 2d3d1f83d2
Branches Tags
${ item.name }
Créer la branche ${ searchTerm }
de '2d3d1f83d2'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-matrix...

182 lignes
8.5 KiB
Brut Annotations Historique 

  1. # SOME DESCRIPTIVE TITLE.

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

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

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

  5. #

  6. #, fuzzy

  7. msgid ""

  8. msgstr ""

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

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

  11. "POT-Creation-Date: 2026-02-13 10:32+0000\n"

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

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

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

  15. "MIME-Version: 1.0\n"

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

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

  18. 

  19. #: ../../../docs/configuring-playbook-matrix-registration.md:9

  20. msgid "Setting up matrix-registration (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-matrix-registration.md:11

  24. msgid "[!WARNING]"

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-matrix-registration.md:12

  28. msgid "This is a poorly maintained and buggy project. It's better to avoid using it."

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-matrix-registration.md:13

  32. msgid "This is not related to [matrix-registration-bot](configuring-playbook-bot-matrix-registration-bot.md)"

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-matrix-registration.md:15

  36. msgid "The playbook can install and configure [matrix-registration](https://github.com/ZerataX/matrix-registration) for you. It is a simple python application to have a token based Matrix registration."

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-matrix-registration.md:17

  40. msgid "Use matrix-registration to **create unique registration links**, which people can use to register on your Matrix server. It allows certain people (these having a special link) to register a user account, **keeping your server's registration closed (private)**."

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-matrix-registration.md:19

  44. msgid "**matrix-registration** provides 2 things:"

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-matrix-registration.md:21

  48. msgid "**an API for creating registration tokens** (unique registration links). This API can be used via `curl` or via the playbook (see [Usage](#usage) below)"

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-matrix-registration.md:23

  52. msgid "**a user registration page**, where people can use these registration tokens. By default, exposed at `https://matrix.example.com/matrix-registration`"

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-matrix-registration.md:25

  56. msgid "Adjusting DNS records (optional)"

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-matrix-registration.md:27

  60. msgid "By default, this playbook installs the matrix-registration on the `matrix.` subdomain, at the `/matrix-registration` path (https://matrix.example.com/matrix-registration). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section."

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-matrix-registration.md:29

  64. msgid "If you wish to adjust it, see the section [below](#adjusting-the-matrix-registration-url-optional) for details about DNS configuration."

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-matrix-registration.md:31

  68. msgid "Adjusting the playbook configuration"

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-matrix-registration.md:33

  72. msgid "To enable matrix-registration, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-matrix-registration.md:42

  76. msgid "Adjusting the matrix-registration URL (optional)"

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-matrix-registration.md:44

  80. msgid "By tweaking the `matrix_registration_hostname` and `matrix_registration_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-matrix-registration.md:46

  84. msgid "Example additional configuration for your `vars.yml` file:"

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-matrix-registration.md:54

  88. msgid "If you've changed the default hostname, you may need to create a CNAME record for the matrix-registration domain (`registration.example.com`), which targets `matrix.example.com`."

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-matrix-registration.md:56

  92. msgid "When setting, replace `example.com` with your own."

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-matrix-registration.md:58

  96. msgid "Extending the configuration"

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-matrix-registration.md:60

  100. msgid "There are some additional things you may wish to configure about the component."

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-matrix-registration.md:62

  104. msgid "Take a look at:"

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-matrix-registration.md:64

  108. msgid "`roles/custom/matrix-registration/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-matrix-registration.md:65

  112. msgid "`roles/custom/matrix-registration/templates/config.yaml.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_registration_configuration_extension_yaml` variable"

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-matrix-registration.md:67

  116. msgid "Installing"

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-matrix-registration.md:69

  120. msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:"

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-matrix-registration.md:76

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

  125. msgstr ""

  126. 

  127. #: ../../../docs/configuring-playbook-matrix-registration.md:78

  128. msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too."

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-matrix-registration.md:80

  132. msgid "Usage"

  133. msgstr ""

  134. 

  135. #: ../../../docs/configuring-playbook-matrix-registration.md:82

  136. msgid "**matrix-registration** gets exposed at `https://matrix.example.com/matrix-registration`"

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-matrix-registration.md:84

  140. msgid "It provides various [APIs](https://github.com/ZerataX/matrix-registration/wiki/api) — for creating registration tokens, listing tokens, disabling tokens, etc. To make use of all of its capabilities, consider using `curl`."

  141. msgstr ""

  142. 

  143. #: ../../../docs/configuring-playbook-matrix-registration.md:86

  144. msgid "We make the most common APIs easy to use via the playbook (see below)."

  145. msgstr ""

  146. 

  147. #: ../../../docs/configuring-playbook-matrix-registration.md:88

  148. msgid "Creating registration tokens"

  149. msgstr ""

  150. 

  151. #: ../../../docs/configuring-playbook-matrix-registration.md:90

  152. msgid "To **create a new user registration token (link)**, use this command:"

  153. msgstr ""

  154. 

  155. #: ../../../docs/configuring-playbook-matrix-registration.md:98

  156. msgid "The above command creates and returns a **one-time use** token, which **expires** on the 31st of December 2021. Adjust the `one_time` and `ex_date` variables as you see fit."

  157. msgstr ""

  158. 

  159. #: ../../../docs/configuring-playbook-matrix-registration.md:100

  160. msgid "Share the unique registration link (generated by the command above) with users to let them register on your Matrix server."

  161. msgstr ""

  162. 

  163. #: ../../../docs/configuring-playbook-matrix-registration.md:102

  164. msgid "Listing registration tokens"

  165. msgstr ""

  166. 

  167. #: ../../../docs/configuring-playbook-matrix-registration.md:104

  168. msgid "To **list the existing user registration tokens**, use this command:"

  169. msgstr ""

  170. 

  171. #: ../../../docs/configuring-playbook-matrix-registration.md:111

  172. msgid "The shortcut command with `just` program is also available: `just run-tags list-matrix-registration-tokens`"

  173. msgstr ""

  174. 

  175. #: ../../../docs/configuring-playbook-matrix-registration.md:113

  176. msgid "Troubleshooting"

  177. msgstr ""

  178. 

  179. #: ../../../docs/configuring-playbook-matrix-registration.md:115

  180. msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-registration`."

  181. msgstr ""