overmind
/
matrix-docker-ansible-deploy
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Fork 0
Code Issues 0 Releases 0 Wiki Activity
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.
10427 Commits
14 Branches
85 MiB
 
 
Tree: 90d3cf78b3
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '90d3cf78b3'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-slidin...

114 lines
6.1 KiB
Raw Blame History 

  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-sliding-sync-proxy.md:1

  20. msgid "Setting up the Sliding Sync proxy (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:3

  24. msgid "**Note**: The sliding-sync proxy is **not required** anymore as it's been replaced with a different method (called Simplified Sliding Sync) which is integrated into newer homeservers by default (**Conduit** homeserver from version `0.6.0` or **Synapse** from version `1.114`). This component and documentation remain here for historical purposes, but **installing this old sliding-sync proxy is generally not recommended anymore**."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:5

  28. msgid "The playbook can install and configure [sliding-sync](https://github.com/matrix-org/sliding-sync) proxy for you."

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:7

  32. msgid "Sliding Sync is an implementation of [MSC3575](https://github.com/matrix-org/matrix-spec-proposals/blob/kegan/sync-v3/proposals/3575-sync.md) and a prerequisite for running Element X clients ([Element X iOS](https://github.com/element-hq/element-x-ios) and [Element X Android](https://github.com/element-hq/element-x-android)). See the project's [documentation](https://github.com/matrix-org/sliding-sync) to learn more."

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:9

  36. msgid "Adjusting DNS records (optional)"

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:11

  40. msgid "By default, this playbook installs the Sliding Sync proxy on the `matrix.` subdomain, at the `/sliding-sync` path (https://matrix.example.com/sliding-sync). 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."

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:13

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

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:15

  48. msgid "Adjusting the playbook configuration"

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:17

  52. msgid "To enable Sliding Sync proxy, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:23

  56. msgid "Adjusting the Sliding Sync proxy URL (optional)"

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:25

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

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:27

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

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:35

  68. msgid "If you've changed the default hostname, you may need to create a CNAME record for the Sliding Sync proxy domain (`ss.example.com`), which targets `matrix.example.com`."

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:37

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

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:39

  76. msgid "Installing"

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:41

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

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:48

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

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:50

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

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:52

  92. msgid "External databases"

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:54

  96. msgid "Please note that, if your setup utilizes an external database, you must also establish configuration for the sliding sync proxy. Alter the defaults below to suit your configuration:"

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:64

  100. msgid "Usage"

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:66

  104. msgid "You **don't need to do anything special** to make use of the Sliding Sync proxy. Simply open your client which supports Sliding Sync (like Element X) and log in."

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:68

  108. msgid "When the Sliding Sync proxy is [installed](#installing), your `/.well-known/matrix/client` file is also updated. A new `org.matrix.msc3575.proxy` section and `url` property are added there and made to point to your Sliding Sync proxy's base URL (e.g. `https://matrix.example.com/sliding-sync`)."

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:70

  112. msgid "This allows clients which support Sliding Sync to detect the Sliding Sync proxy's URL and make use of it."

  113. msgstr ""