overmind
/
matrix-docker-ansible-deploy
kopie van https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Vork 0
Code Kwesties 0 Publicaties 0 Wiki Activiteit
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.
8895 Commits
14 Branches
106 MiB
 
 
Tree: 71e59d1784
Branches Labels
${ item.name }
Maak branch ${ searchTerm }
van '71e59d1784'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-sygnal...

130 regels
6.8 KiB
Ruw Blame Geschiedenis 

  1. # SOME DESCRIPTIVE TITLE.

  2. # Copyright (C) 2018-2024, 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: 2024-12-20 09:53+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 the playbook configuration"

  45. msgstr ""

  46. 

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

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

  49. msgstr ""

  50. 

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

  52. msgid "For a more complete example of available fields and values they can take, see `roles/custom/matrix-sygnal/templates/sygnal.yaml.j2` (or the [upstream `sygnal.yaml.sample` configuration file](https://github.com/matrix-org/sygnal/blob/master/sygnal.yaml.sample))."

  53. msgstr ""

  54. 

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

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

  57. msgstr ""

  58. 

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

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

  61. msgstr ""

  62. 

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

  64. 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`."

  65. msgstr ""

  66. 

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

  68. 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)"

  69. msgstr ""

  70. 

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

  72. msgid "Adjusting the Sygnal URL"

  73. msgstr ""

  74. 

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

  76. msgid "By default, this playbook installs Sygnal on the `sygnal.` subdomain (`sygnal.example.com`) and requires you to [adjust your DNS records](#adjusting-dns-records)."

  77. msgstr ""

  78. 

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

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

  81. msgstr ""

  82. 

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

  84. msgid "Example additional configuration for your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  85. msgstr ""

  86. 

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

  88. msgid "Adjusting DNS records"

  89. msgstr ""

  90. 

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

  92. msgid "Once you've decided on the domain and path, **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 "By default, you will need to create a CNAME record for `sygnal`. See [Configuring DNS](configuring-dns.md) for details about DNS changes."

  97. msgstr ""

  98. 

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

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

  101. msgstr ""

  102. 

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

  104. msgid "Installing"

  105. msgstr ""

  106. 

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

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

  109. msgstr ""

  110. 

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

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

  113. msgstr ""

  114. 

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

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

  117. msgstr ""

  118. 

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

  120. msgid "Usage"

  121. msgstr ""

  122. 

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

  124. 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`)."

  125. msgstr ""

  126. 

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

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

  129. msgstr ""