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.
10427 Révisions
12 Branches
590 MiB
 
 
Aborescence: 90d3cf78b3
Branches Tags
${ item.name }
Créer la branche ${ searchTerm }
de '90d3cf78b3'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-sygnal...

146 lignes
7.2 KiB
Brut Annotations Historique 

  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/configuring-playbook-sygnal.md:1

  20. msgid "Setting up the Sygnal push gateway (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-sygnal.md:3

  24. msgid "The playbook can install and configure the [Sygnal](https://github.com/matrix-org/sygnal) push gateway for you."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-sygnal.md:5

  28. msgid "See the project's [documentation](https://github.com/matrix-org/sygnal/blob/master/README.md) to learn what it does and why it might be useful to you."

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-sygnal.md:7

  32. msgid "**Note**: most people don't need to install their own gateway. As Sygnal's [Notes for application developers](https://github.com/matrix-org/sygnal/blob/master/docs/applications.md) documentation says:"

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-sygnal.md:9

  36. msgid "It is not feasible to allow end-users to configure their own Sygnal instance, because the Sygnal instance needs the appropriate FCM or APNs secrets that belong to the application."

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-sygnal.md:11

  40. msgid "This optional playbook component is only useful to people who develop/build their own Matrix client applications themselves."

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-sygnal.md:13

  44. msgid "Adjusting DNS records"

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-sygnal.md:15

  48. msgid "By default, this playbook installs Sygnal on the `sygnal.` subdomain (`sygnal.example.com`) and requires you to create a CNAME record for `sygnal`, which targets `matrix.example.com`."

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-sygnal.md:17

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

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-sygnal.md:19

  56. msgid "Adjusting the playbook configuration"

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-sygnal.md:21

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

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-sygnal.md:49

  64. msgid "Configuring [GCM/FCM](https://firebase.google.com/docs/cloud-messaging/) is easier, as it only requires that you provide some config values."

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-sygnal.md:51

  68. msgid "To configure [APNS](https://developer.apple.com/notifications/) (Apple Push Notification Service), you'd need to provide one or more certificate files. To do that, the above example configuration:"

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-sygnal.md:53

  72. msgid "makes use of the [`aux` role](https://github.com/mother-of-all-self-hosting/ansible-role-aux) (and its `aux_file_definitions` variable) to make the playbook install files into `/matrix/sygnal/data` (the `matrix_sygnal_data_path` variable). See [`defaults/main.yml` file](https://github.com/mother-of-all-self-hosting/ansible-role-aux/blob/main/defaults/main.yml) of the `aux` role for usage examples. It also makes sure the files are owned by `matrix:matrix`, so that Sygnal can read them. Of course, you can also install these files manually yourself, if you'd rather not use `aux`."

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-sygnal.md:55

  76. msgid "references these files in the Sygnal configuration (`matrix_sygnal_apps`) using a path like `/data/…` (the `/matrix/sygnal/data` directory on the host system is mounted into the `/data` directory inside the container)"

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-sygnal.md:57

  80. msgid "Adjusting the Sygnal URL (optional)"

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-sygnal.md:59

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

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-sygnal.md:61

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

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-sygnal.md:72

  92. msgid "After changing the domain, **you may need to adjust your DNS** records to point the Sygnal domain to the Matrix server."

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-sygnal.md:74

  96. msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration."

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-sygnal.md:76

  100. msgid "Extending the configuration"

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-sygnal.md:78

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

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-sygnal.md:80

  108. msgid "Take a look at:"

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-sygnal.md:82

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

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-sygnal.md:83

  116. msgid "`roles/custom/matrix-sygnal/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_sygnal_configuration_extension_yaml` variable"

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-sygnal.md:85

  120. msgid "Installing"

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-sygnal.md:87

  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-sygnal.md:94

  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-sygnal.md:96

  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-sygnal.md:98

  136. msgid "Usage"

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-sygnal.md:100

  140. msgid "To make use of your Sygnal installation, you'd need to build your own Matrix client application, which uses the same API keys (for [GCM/FCM](https://firebase.google.com/docs/cloud-messaging/)) and certificates (for [APNS](https://developer.apple.com/notifications/)) and is to your Sygnal URL endpoint (e.g. `https://sygnal.example.com`)."

  141. msgstr ""

  142. 

  143. #: ../../../docs/configuring-playbook-sygnal.md:102

  144. msgid "Refer to Sygnal's [Notes for application developers](https://github.com/matrix-org/sygnal/blob/master/docs/applications.md) document."

  145. msgstr ""