overmind
/
matrix-docker-ansible-deploy
mirror da https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Forka 0
Codice Problemi 0 Rilasci 0 Wiki Attività
Matrix Docker Ansible eploy
Non puoi selezionare più di 25 argomenti Gli argomenti devono iniziare con una lettera o un numero, possono includere trattini ('-') e possono essere lunghi fino a 35 caratteri.
10814 Commit
16 Rami (Branch)
963 MiB
 
 
Albero (Tree): f16c8dfcbf
Rami (Branch) Tag
${ item.name }
Crea branch ${ searchTerm }
da 'f16c8dfcbf'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-bot-ma...

199 righe
9.2 KiB
Originale Blame Cronologia 

  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-11-06 23:09+0900\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:12

  20. msgid "Setting up maubot (optional)"

  21. msgstr ""

  22. 

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

  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:16

  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:18

  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:20

  36. msgid "Adjusting DNS records (optional)"

  37. msgstr ""

  38. 

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

  40. 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**."

  41. msgstr ""

  42. 

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

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

  45. msgstr ""

  46. 

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

  48. msgid "Adjusting the playbook configuration"

  49. msgstr ""

  50. 

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

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

  53. msgstr ""

  54. 

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

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

  57. msgstr ""

  58. 

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

  60. msgid "Adjusting the maubot URL (optional)"

  61. msgstr ""

  62. 

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

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

  65. msgstr ""

  66. 

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

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

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

  70. msgstr ""

  71. 

  72. #: ../../../docs/configuring-playbook-bot-maubot.md:57

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

  74. msgstr ""

  75. 

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

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

  78. msgstr ""

  79. 

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

  81. msgid "Extending the configuration"

  82. msgstr ""

  83. 

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

  85. msgid "There are some additional things you may wish to configure about the bot."

  86. msgstr ""

  87. 

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

  89. msgid "Take a look at:"

  90. msgstr ""

  91. 

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

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

  94. msgstr ""

  95. 

  96. #: ../../../docs/configuring-playbook-bot-maubot.md:68

  97. msgid "`roles/custom/matrix-bot-maubot/templates/config.yaml.j2` for the bot's default configuration"

  98. msgstr ""

  99. 

  100. #: ../../../docs/configuring-playbook-bot-maubot.md:70

  101. msgid "Customizing the maubot container image"

  102. msgstr ""

  103. 

  104. #: ../../../docs/configuring-playbook-bot-maubot.md:72

  105. msgid "Certain [maubot plugins](https://plugins.mau.bot/) require additional dependencies to be installed."

  106. msgstr ""

  107. 

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

  109. msgid "You can customize the default maubot container image and install your own dependencies."

  110. msgstr ""

  111. 

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

  113. msgid "Consult the [Dockerfile reference](https://docs.docker.com/reference/dockerfile/) for more information about the syntax."

  114. msgstr ""

  115. 

  116. #: ../../../docs/configuring-playbook-bot-maubot.md:89

  117. msgid "Installing"

  118. msgstr ""

  119. 

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

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

  122. msgstr ""

  123. 

  124. #: ../../../docs/configuring-playbook-bot-maubot.md:98

  125. msgid "**Notes**:"

  126. msgstr ""

  127. 

  128. #: ../../../docs/configuring-playbook-bot-maubot.md:100

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

  130. msgstr ""

  131. 

  132. #: ../../../docs/configuring-playbook-bot-maubot.md:102

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

  134. msgstr ""

  135. 

  136. #: ../../../docs/configuring-playbook-bot-maubot.md:104

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

  138. msgstr ""

  139. 

  140. #: ../../../docs/configuring-playbook-bot-maubot.md:106

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

  142. msgstr ""

  143. 

  144. #: ../../../docs/configuring-playbook-bot-maubot.md:108

  145. msgid "Usage"

  146. msgstr ""

  147. 

  148. #: ../../../docs/configuring-playbook-bot-maubot.md:110

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

  150. msgstr ""

  151. 

  152. #: ../../../docs/configuring-playbook-bot-maubot.md:112

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

  154. msgstr ""

  155. 

  156. #: ../../../docs/configuring-playbook-bot-maubot.md:113

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

  158. msgstr ""

  159. 

  160. #: ../../../docs/configuring-playbook-bot-maubot.md:114

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

  162. msgstr ""

  163. 

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

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

  166. msgstr ""

  167. 

  168. #: ../../../docs/configuring-playbook-bot-maubot.md:117

  169. msgid "Obtain an access token"

  170. msgstr ""

  171. 

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

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

  174. msgstr ""

  175. 

  176. #: ../../../docs/configuring-playbook-bot-maubot.md:121

  177. msgid "Alternatively, you can refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md). 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 causes issues to your bot in encrypted rooms. Read [more](https://docs.mau.fi/maubot/usage/basic.html#creating-clients)."

  178. msgstr ""

  179. 

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

  181. msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone."

  182. msgstr ""

  183. 

  184. #: ../../../docs/configuring-playbook-bot-maubot.md:126

  185. msgid "Troubleshooting"

  186. msgstr ""

  187. 

  188. #: ../../../docs/configuring-playbook-bot-maubot.md:128

  189. msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-maubot`."

  190. msgstr ""

  191. 

  192. #: ../../../docs/configuring-playbook-bot-maubot.md:130

  193. msgid "Increase logging verbosity"

  194. msgstr ""

  195. 

  196. #: ../../../docs/configuring-playbook-bot-maubot.md:132

  197. msgid "The default logging level for this component is `WARNING`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"

  198. msgstr ""