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.
9032 Commits
5 Branches
451 MiB
 
 
 
Tree: 292b0704cc
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '292b0704cc'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-bridge...

126 lines
6.2 KiB
Raw Blame History 

  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-bridge-heisenbridge.md:1

  20. msgid "Setting up Heisenbridge bouncer-style IRC bridging (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:3

  24. msgid "**Note**: bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) can also happen via the [matrix-appservice-irc](configuring-playbook-bridge-appservice-irc.md) bridge supported by the playbook."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:5

  28. msgid "The playbook can install and configure [Heisenbridge](https://github.com/hifi/heisenbridge) - the bouncer-style [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) bridge for you."

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:7

  32. msgid "See the project's [documentation](https://github.com/hifi/heisenbridge/blob/master/README.md) to learn what it does and why it might be useful to you. You can also take a look at [this demonstration video](https://www.youtube.com/watch?v=nQk1Bp4tk4I)."

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:9

  36. msgid "Configuration"

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:11

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

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:24

  44. msgid "For a more complete list of variables that you could override, see the [`defaults/main.yml` file](../roles/custom/matrix-bridge-heisenbridge/defaults/main.yml) of the Heisenbridge Ansible role."

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:26

  48. msgid "Adjusting the Heisenbridge URL"

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:28

  52. msgid "By default, this playbook installs Heisenbridge on the `matrix.` subdomain, at the `/heisenbridge` path (https://matrix.example.com/heisenbridge). It would handle media requests there (see the [release notes for Heisenbridge v1.15.0](https://github.com/hifi/heisenbridge/releases/tag/v1.15.0))."

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:30

  56. msgid "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."

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:32

  60. msgid "By tweaking the `matrix_heisenbridge_hostname` and `matrix_heisenbridge_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-bridge-heisenbridge.md:34

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

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:42

  68. msgid "Adjusting DNS records"

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:44

  72. msgid "If you've changed the default hostname, **you may need to adjust your DNS** records to point the Heisenbridge domain to the Matrix server."

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:46

  76. msgid "See [Configuring DNS](configuring-dns.md) for details about DNS changes."

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:48

  80. msgid "If you've decided to use the default hostname, you won't need to do any extra DNS configuration."

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:50

  84. msgid "Installing"

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:52

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

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:59

  92. msgid "**Notes**:"

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:61

  96. msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:63

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

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:65

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

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:67

  108. msgid "Usage"

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:69

  112. msgid "To use the bridge, you need to start a chat with `@heisenbridge:example.com` (where `example.com` is your base domain, not the `matrix.` domain). If the bridge ignores you and a DM is not accepted then the owner setting may be wrong."

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:71

  116. msgid "Help is available for all commands with the `-h` switch."

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:73

  120. msgid "You can also learn the basics by watching [this demonstration video](https://www.youtube.com/watch?v=nQk1Bp4tk4I)."

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-bridge-heisenbridge.md:75

  124. msgid "If you encounter issues or feel lost you can join the project room at [#heisenbridge:vi.fi](https://matrix.to/#/#heisenbridge:vi.fi) for help."

  125. msgstr ""