overmind
/
matrix-docker-ansible-deploy
peilaus alkaen https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Fork 0
Koodi Ongelmat 0 Julkaisut 0 Wiki Toiminta
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.
10960 Commitit
13 Branchit
36 MiB
 
 
Puu: 46b97d0a7a
Branchit Tagit
${ item.name }
Create branch ${ searchTerm }
from '46b97d0a7a'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-synaps...

158 rivejä
8.7 KiB
Raaka Blame Historia 

  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-03-03 10:49+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-synapse-admin.md:13

  20. msgid "Setting up Synapse Admin (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-synapse-admin.md:15

  24. msgid "The playbook can install and configure Synapse Admin for you."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-synapse-admin.md:17

  28. msgid "Synapse Admin is a web UI tool you can use to **administrate users, rooms, media, etc. on your Matrix homeserver**. This playbook is configured to install [etkecc/synapse-admin](https://github.com/etkecc/synapse-admin), which is a [feature-rich](https://github.com/etkecc/synapse-admin#fork-differences) fork of [Awesome-Technologies/synapse-admin](https://github.com/Awesome-Technologies/synapse-admin)."

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-synapse-admin.md:19

  32. msgid "[!NOTE]"

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-synapse-admin.md:21

  36. msgid "Synapse Admin does not work with other homeserver implementations than Synapse due to API's incompatibility."

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-synapse-admin.md:22

  40. msgid "The latest version of Synapse Admin is hosted by [etke.cc](https://etke.cc/) at [admin.etke.cc](https://admin.etke.cc/). If you only need this service occasionally and trust giving your admin credentials to a 3rd party Single Page Application, you can consider using it from there and avoiding the (small) overhead of self-hosting."

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-synapse-admin.md:23

  44. msgid "This playbook also supports an alternative management UI in the shape of [Element Admin](./configuring-playbook-element-admin.md). Please note that it's currently less feature-rich than Synapse Admin and requires [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md)."

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-synapse-admin.md:25

  48. msgid "Adjusting DNS records (optional)"

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-synapse-admin.md:27

  52. msgid "By default, this playbook installs Synapse Admin on the `matrix.` subdomain, at the `/synapse-admin` path (https://matrix.example.com/synapse-admin). 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."

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-synapse-admin.md:29

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

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-synapse-admin.md:31

  60. msgid "Adjusting the playbook configuration"

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-synapse-admin.md:33

  64. msgid "To enable Synapse Admin, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-synapse-admin.md:39

  68. msgid "**Note**: Synapse Admin requires Synapse's [Admin APIs](https://element-hq.github.io/synapse/latest/usage/administration/admin_api/index.html) to function. Access to them is restricted with a valid access token, so exposing them publicly should not be a real security concern. Still, for additional security, we normally leave them unexposed, following [official Synapse reverse-proxying recommendations](https://element-hq.github.io/synapse/latest/reverse_proxy.html#synapse-administration-endpoints). Because Synapse Admin needs these APIs to function, when installing Synapse Admin, the playbook **automatically** exposes the Synapse Admin API publicly for you. Depending on the homeserver implementation you're using (Synapse, Dendrite), this is equivalent to:"

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-synapse-admin.md:41

  72. msgid "for [Synapse](./configuring-playbook-synapse.md) (our default homeserver implementation): `matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true`"

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-synapse-admin.md:42

  76. msgid "for [Dendrite](./configuring-playbook-dendrite.md): `matrix_dendrite_container_labels_public_client_synapse_admin_api_enabled: true`"

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-synapse-admin.md:44

  80. msgid "By default, synapse-admin installation will be [restricted to only work with one homeserver](https://github.com/etkecc/synapse-admin/blob/e21e44362c879ac41f47c580b04210842b6ff3d7/README.md#restricting-available-homeserver) — the one managed by the playbook. To adjust these restrictions, tweak the `matrix_synapse_admin_config_restrictBaseUrl` variable."

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-synapse-admin.md:46

  84. msgid "Adjusting the Synapse Admin URL (optional)"

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-synapse-admin.md:48

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

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-synapse-admin.md:50

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

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-synapse-admin.md:58

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

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-synapse-admin.md:60

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

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-synapse-admin.md:62

  104. msgid "Extending the configuration"

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-synapse-admin.md:64

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

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-synapse-admin.md:66

  112. msgid "Take a look at:"

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-synapse-admin.md:68

  116. msgid "`roles/custom/matrix-synapse-admin/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_synapse_admin_configuration_extension_json` variable"

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-synapse-admin.md:70

  120. msgid "Installing"

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-synapse-admin.md:72

  124. 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:"

  125. msgstr ""

  126. 

  127. #: ../../../docs/configuring-playbook-synapse-admin.md:79

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

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-synapse-admin.md:81

  132. 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."

  133. msgstr ""

  134. 

  135. #: ../../../docs/configuring-playbook-synapse-admin.md:83

  136. msgid "Usage"

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-synapse-admin.md:85

  140. msgid "After installation, Synapse Admin will be accessible at: `https://matrix.example.com/synapse-admin/`"

  141. msgstr ""

  142. 

  143. #: ../../../docs/configuring-playbook-synapse-admin.md:87

  144. msgid "To use Synapse Admin, you need to have [registered at least one administrator account](registering-users.md) on your server."

  145. msgstr ""

  146. 

  147. #: ../../../docs/configuring-playbook-synapse-admin.md:89

  148. msgid "Troubleshooting"

  149. msgstr ""

  150. 

  151. #: ../../../docs/configuring-playbook-synapse-admin.md:91

  152. 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-synapse-admin`."

  153. msgstr ""

  154. 

  155. #: ../../../docs/configuring-playbook-synapse-admin.md:93

  156. msgid "If you have questions, you can join this community room and feel free to ask: [#synapse-admin:etke.cc](https://matrix.to/#/#synapse-admin:etke.cc)"

  157. msgstr ""