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.
8838 Commits
1 Branch
70 MiB
 
 
 
Tree: 93c860305f
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '93c860305f'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-bot-ma...

142 lines
6.9 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 07:23+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-bot-maubot.md:1

  20. msgid "Setting up maubot (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-bot-maubot.md:3

  24. msgid "The playbook can install and configure [maubot](https://github.com/maubot/maubot) for you."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-bot-maubot.md:5

  28. msgid "After setting up maubot, you can use the web management interface to make it do things. The default location of the management interface is `matrix.example.com/_matrix/maubot/`"

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-bot-maubot.md:7

  32. msgid "See the project's [documentation](https://docs.mau.fi/maubot/usage/basic.html) to learn what it does and why it might be useful to you."

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-bot-maubot.md:9

  36. msgid "Adjusting the playbook configuration"

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-bot-maubot.md:11

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

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-bot-maubot.md:26

  44. msgid "You can add multiple admins. The admin accounts are only used to access the maubot administration interface."

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-bot-maubot.md:28

  48. msgid "Adjusting the maubot URL"

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-bot-maubot.md:30

  52. msgid "By default, this playbook installs maubot on the `matrix.` subdomain, at the `/_matrix/maubot/` path (https://matrix.example.com/_matrix/maubot/). 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."

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-bot-maubot.md:32

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

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-bot-maubot.md:34

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

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-bot-maubot.md:42

  64. msgid "Adjusting DNS records"

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-bot-maubot.md:44

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

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-bot-maubot.md:46

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

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-bot-maubot.md:48

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

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-bot-maubot.md:50

  80. msgid "Installing"

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-bot-maubot.md:52

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

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-bot-maubot.md:59

  88. msgid "**Notes**:"

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-bot-maubot.md:61

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

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-bot-maubot.md:63

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

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-bot-maubot.md:65

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

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-bot-maubot.md:67

  104. msgid "If you change the bot password (`matrix_bot_maubot_initial_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_maubot_initial_password` to let the bot know its new password."

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-bot-maubot.md:69

  108. msgid "Usage"

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-bot-maubot.md:71

  112. msgid "By default, you can visit `matrix.example.com/_matrix/maubot/` to manage your available plugins, clients and instances."

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-bot-maubot.md:73

  116. msgid "You should start in the following order"

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-bot-maubot.md:74

  120. msgid "**Create one or more clients**: A client is a Matrix account which the bot will use to message. By default, the playbook creates a `bot.maubot` account (as per the configuration above). You only need to [obtain an access token](#obtaining-an-access-token) for it"

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-bot-maubot.md:75

  124. msgid "**Upload some Plugins**: Plugins can be obtained from [here](https://github.com/maubot/maubot#plugins) or any other source."

  125. msgstr ""

  126. 

  127. #: ../../../docs/configuring-playbook-bot-maubot.md:76

  128. msgid "**Create an instance**: An instance is the actual bot. You have to specify a client which the bot instance will use and the plugin (how the bot will behave)"

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-bot-maubot.md:78

  132. msgid "Obtaining an access token"

  133. msgstr ""

  134. 

  135. #: ../../../docs/configuring-playbook-bot-maubot.md:80

  136. msgid "This can be done via `mbc login` then `mbc auth` (see the [maubot documentation](https://docs.mau.fi/maubot/usage/cli/auth.html)). To run these commands, you'll first need to `exec` into the maubot container with `docker exec -it matrix-bot-maubot sh`."

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-bot-maubot.md:82

  140. msgid "Alternatively, you can follow our generic [obtain an access token](obtaining-access-tokens.md) documentation. Be aware that you'd better use the **Obtain an access token via curl** method (not **Obtain an access token via Element Web**) as the latter will give your bot issues in encrypted rooms. Read [more](https://docs.mau.fi/maubot/usage/basic.html#creating-clients)."

  141. msgstr ""