overmind
/
matrix-docker-ansible-deploy
mirror da https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Forka 0
Codice Problemi 0 Rilasci 0 Wiki Attività
Matrix Docker Ansible eploy
Non puoi selezionare più di 25 argomenti Gli argomenti devono iniziare con una lettera o un numero, possono includere trattini ('-') e possono essere lunghi fino a 35 caratteri.
10090 Commit
13 Rami (Branch)
120 MiB
 
 
Albero (Tree): ec00a76b14
Rami (Branch) Tag
${ item.name }
Crea branch ${ searchTerm }
da 'ec00a76b14'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/howto-server-delegation.pot

186 righe
10 KiB
Originale Blame Cronologia 

  1. # SOME DESCRIPTIVE TITLE.

  2. # Copyright (C) 2018-2025, 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: 2025-01-27 09:54+0200\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/howto-server-delegation.md:1

  20. msgid "Server Delegation"

  21. msgstr ""

  22. 

  23. #: ../../../docs/howto-server-delegation.md:3

  24. msgid "By default, this playbook sets up services on your Matrix server (`matrix.example.com`). To have this server officially be responsible for Matrix services for the base domain (`example.com`), you need to set up server delegation / redirection."

  25. msgstr ""

  26. 

  27. #: ../../../docs/howto-server-delegation.md:5

  28. msgid "Server delegation can be configured in either of these ways:"

  29. msgstr ""

  30. 

  31. #: ../../../docs/howto-server-delegation.md:7

  32. msgid "[Setting up a `/.well-known/matrix/server` file](#server-delegation-via-a-well-known-file) on the base domain (`example.com`)"

  33. msgstr ""

  34. 

  35. #: ../../../docs/howto-server-delegation.md:8

  36. msgid "[Setting up a `_matrix._tcp` DNS SRV record](#server-delegation-via-a-dns-srv-record-advanced)"

  37. msgstr ""

  38. 

  39. #: ../../../docs/howto-server-delegation.md:10

  40. msgid "Both methods have their place and will continue to do so. You only need to use just one of these delegation methods."

  41. msgstr ""

  42. 

  43. #: ../../../docs/howto-server-delegation.md:12

  44. msgid "For simplicity reasons, this playbook recommends you to set up server delegation via a `/.well-known/matrix/server` file. However, that method may have some downsides that are not to your liking. Hence this guide about alternative ways to set up Server Delegation."

  45. msgstr ""

  46. 

  47. #: ../../../docs/howto-server-delegation.md:14

  48. msgid "**Note**: as an alternative, it is possible to install the server such that it uses only the `matrix.example.com` domain (instead of identifying as the shorter base domain — `example.com`). This should be helpful if you are not in control of anything on the base domain (`example.com`). In this case, you would not need to configure server delegation, but you would need to add other configuration. For more information, see [How do I install on matrix.example.com without involving the base domain?](faq.md#how-do-i-install-on-matrix-example-com-without-involving-the-base-domain) on our FAQ."

  49. msgstr ""

  50. 

  51. #: ../../../docs/howto-server-delegation.md:16

  52. msgid "Server Delegation via a well-known file"

  53. msgstr ""

  54. 

  55. #: ../../../docs/howto-server-delegation.md:18

  56. msgid "This playbook recommends you to set up server delegation by means of a `/.well-known/matrix/server` file served from the base domain (`example.com`), as this is the most straightforward way to set up the delegation."

  57. msgstr ""

  58. 

  59. #: ../../../docs/howto-server-delegation.md:20

  60. msgid "To configure server delegation with the well-known file, check this section on [Configuring Service Discovery via .well-known](configuring-well-known.md): [Installing well-known files on the base domain's server](configuring-well-known.md#installing-well-known-files-on-the-base-domain-s-server)"

  61. msgstr ""

  62. 

  63. #: ../../../docs/howto-server-delegation.md:22

  64. msgid "Downsides of well-known-based Server Delegation"

  65. msgstr ""

  66. 

  67. #: ../../../docs/howto-server-delegation.md:24

  68. msgid "Server Delegation by means of a `/.well-known/matrix/server` file is the most straightforward, but suffers from the following downsides:"

  69. msgstr ""

  70. 

  71. #: ../../../docs/howto-server-delegation.md:26

  72. msgid "you need to have a working HTTPS server for the base domain (`example.com`). If you don't have any server for the base domain at all, you can easily solve it by making the playbook [serve the base domain from the Matrix server](configuring-playbook-base-domain-serving.md)."

  73. msgstr ""

  74. 

  75. #: ../../../docs/howto-server-delegation.md:28

  76. msgid "any downtime on the base domain (`example.com`) or network trouble between the Matrix subdomain (`matrix.example.com`) and the base `example.com` may cause Matrix Federation outages. As the [Server-Server spec says](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery):"

  77. msgstr ""

  78. 

  79. #: ../../../docs/howto-server-delegation.md:30

  80. msgid "Errors are recommended to be cached for up to an hour, and servers are encouraged to exponentially back off for repeated failures."

  81. msgstr ""

  82. 

  83. #: ../../../docs/howto-server-delegation.md:32

  84. msgid "**For most people, this is a reasonable tradeoff** given that it's easy and straightforward to set up. We recommend you stay on this path."

  85. msgstr ""

  86. 

  87. #: ../../../docs/howto-server-delegation.md:34

  88. msgid "Otherwise, you can decide to go against the default for this playbook, and instead set up [Server Delegation via a DNS SRV record (advanced)](#server-delegation-via-a-dns-srv-record-advanced) (much more complicated)."

  89. msgstr ""

  90. 

  91. #: ../../../docs/howto-server-delegation.md:36

  92. msgid "Server Delegation via a DNS SRV record (advanced)"

  93. msgstr ""

  94. 

  95. #: ../../../docs/howto-server-delegation.md:38

  96. msgid "**Note**: doing Server Delegation via a DNS SRV record is a more **advanced** way to do it and is not the default for this playbook. This is usually **much more complicated** to set up, so **we don't recommend it**. If you're not an experienced sysadmin, you'd better stay away from this."

  97. msgstr ""

  98. 

  99. #: ../../../docs/howto-server-delegation.md:40

  100. msgid "As per the [Server-Server spec](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery), it's possible to do Server Delegation using only a SRV record (without a `/.well-known/matrix/server` file)."

  101. msgstr ""

  102. 

  103. #: ../../../docs/howto-server-delegation.md:42

  104. msgid "This prevents you from suffering the [Downsides of well-known-based Server Delegation](#downsides-of-well-known-based-server-delegation)."

  105. msgstr ""

  106. 

  107. #: ../../../docs/howto-server-delegation.md:44

  108. msgid "To use DNS SRV record validation, you need to:"

  109. msgstr ""

  110. 

  111. #: ../../../docs/howto-server-delegation.md:46

  112. msgid "ensure that `/.well-known/matrix/server` is **not served** from the base domain, as that would interfere with DNS SRV record Server Delegation. To make the playbook **not** generate and serve the file, use the following configuration: `matrix_static_files_file_matrix_server_enabled: false`."

  113. msgstr ""

  114. 

  115. #: ../../../docs/howto-server-delegation.md:48

  116. msgid "ensure that you have a `_matrix._tcp` DNS SRV record for your base domain (`example.com`) with a value of `10 0 8448 matrix.example.com`"

  117. msgstr ""

  118. 

  119. #: ../../../docs/howto-server-delegation.md:50

  120. msgid "ensure that you are serving the Matrix Federation API (tcp/8448) with a certificate for `example.com` (not `matrix.example.com`!). Getting this certificate to the `matrix.example.com` server may be complicated. The playbook's automatic SSL obtaining/renewal flow will likely not work and you'll need to copy certificates around manually. See below."

  121. msgstr ""

  122. 

  123. #: ../../../docs/howto-server-delegation.md:52

  124. msgid "For more details on how to configure the playbook to work with SRV delegation, take a look at this documentation: [Server Delegation via a DNS SRV record (advanced)](howto-srv-server-delegation.md)"

  125. msgstr ""

  126. 

  127. #: ../../../docs/howto-server-delegation.md:54

  128. msgid "Obtain certificates"

  129. msgstr ""

  130. 

  131. #: ../../../docs/howto-server-delegation.md:56

  132. msgid "How you can obtain a valid certificate for `example.com` on the `matrix.example.com` server is up to you."

  133. msgstr ""

  134. 

  135. #: ../../../docs/howto-server-delegation.md:58

  136. msgid "If `example.com` and `matrix.example.com` are hosted on the same machine, you can let the playbook obtain the certificate for you, by following our [Obtaining SSL certificates for additional domains](configuring-playbook-ssl-certificates.md#obtaining-ssl-certificates-for-additional-domains) guide."

  137. msgstr ""

  138. 

  139. #: ../../../docs/howto-server-delegation.md:60

  140. msgid "If `example.com` and `matrix.example.com` are not hosted on the same machine, you can copy over the certificate files manually. Don't forget that they may get renewed once in a while, so you may also have to transfer them periodically. How often you do that is up to you, as long as the certificate files don't expire."

  141. msgstr ""

  142. 

  143. #: ../../../docs/howto-server-delegation.md:62

  144. msgid "Serving the Federation API with your certificates"

  145. msgstr ""

  146. 

  147. #: ../../../docs/howto-server-delegation.md:64

  148. msgid "Regardless of which method for obtaining certificates you've used, once you've managed to get certificates for your base domain onto the `matrix.example.com` machine you can put them to use."

  149. msgstr ""

  150. 

  151. #: ../../../docs/howto-server-delegation.md:66

  152. msgid "Based on your setup, you have different ways to go about it:"

  153. msgstr ""

  154. 

  155. #: ../../../docs/howto-server-delegation.md:68

  156. msgid "Serving the Federation API with your certificates and Synapse handling Federation"

  157. msgstr ""

  158. 

  159. #: ../../../docs/howto-server-delegation.md:70

  160. msgid "You can let Synapse handle Federation by itself."

  161. msgstr ""

  162. 

  163. #: ../../../docs/howto-server-delegation.md:72

  164. msgid "To do that, make sure the certificate files are mounted into the Synapse container:"

  165. msgstr ""

  166. 

  167. #: ../../../docs/howto-server-delegation.md:79

  168. msgid "You can then tell Synapse to serve Federation traffic over TLS on `tcp/8448`:"

  169. msgstr ""

  170. 

  171. #: ../../../docs/howto-server-delegation.md:87

  172. msgid "Make sure to reload Synapse once in a while (`systemctl reload matrix-synapse`), so that newer certificates can kick in. Reloading doesn't cause any downtime."

  173. msgstr ""

  174. 

  175. #: ../../../docs/howto-server-delegation.md:89

  176. msgid "Serving the Federation API with your certificates and another webserver"

  177. msgstr ""

  178. 

  179. #: ../../../docs/howto-server-delegation.md:91

  180. msgid "**Alternatively**, if you are using another webserver, you can set up reverse-proxying for the `tcp/8448` port by yourself. Make sure to use the proper certificates for `example.com` (not for `matrix.example.com`) when serving the `tcp/8448` port."

  181. msgstr ""

  182. 

  183. #: ../../../docs/howto-server-delegation.md:93

  184. msgid "As recommended in our [Fronting the integrated reverse-proxy webserver with another reverse-proxy](./configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy) documentation section, we recommend you to expose the Matrix Federation entrypoint from traffic at a local port (e.g. `127.0.0.1:8449`), so your reverese-proxy should send traffic there."

  185. msgstr ""