Matrix Docker Ansible eploy
25개 이상의 토픽을 선택하실 수 없습니다. Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

163 lines
7.8 KiB

  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. #: ../../../docs/configuring-playbook-bot-maubot.md:1
  19. msgid "Setting up maubot (optional)"
  20. msgstr ""
  21. #: ../../../docs/configuring-playbook-bot-maubot.md:3
  22. msgid "The playbook can install and configure [maubot](https://github.com/maubot/maubot) for you."
  23. msgstr ""
  24. #: ../../../docs/configuring-playbook-bot-maubot.md:5
  25. 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/`"
  26. msgstr ""
  27. #: ../../../docs/configuring-playbook-bot-maubot.md:7
  28. 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."
  29. msgstr ""
  30. #: ../../../docs/configuring-playbook-bot-maubot.md:9
  31. msgid "Adjusting DNS records (optional)"
  32. msgstr ""
  33. #: ../../../docs/configuring-playbook-bot-maubot.md:11
  34. 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**."
  35. msgstr ""
  36. #: ../../../docs/configuring-playbook-bot-maubot.md:13
  37. msgid "If you wish to adjust it, see the section [below](#adjusting-the-maubot-url-optional) for details about DNS configuration."
  38. msgstr ""
  39. #: ../../../docs/configuring-playbook-bot-maubot.md:15
  40. msgid "Adjusting the playbook configuration"
  41. msgstr ""
  42. #: ../../../docs/configuring-playbook-bot-maubot.md:17
  43. msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
  44. msgstr ""
  45. #: ../../../docs/configuring-playbook-bot-maubot.md:32
  46. msgid "You can add multiple admins. The admin accounts are only used to access the maubot administration interface."
  47. msgstr ""
  48. #: ../../../docs/configuring-playbook-bot-maubot.md:34
  49. msgid "Adjusting the maubot URL (optional)"
  50. msgstr ""
  51. #: ../../../docs/configuring-playbook-bot-maubot.md:36
  52. 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."
  53. msgstr ""
  54. #: ../../../docs/configuring-playbook-bot-maubot.md:38
  55. #: ../../../docs/configuring-playbook-bot-maubot.md:56
  56. msgid "Example additional configuration for your `vars.yml` file:"
  57. msgstr ""
  58. #: ../../../docs/configuring-playbook-bot-maubot.md:46
  59. 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`."
  60. msgstr ""
  61. #: ../../../docs/configuring-playbook-bot-maubot.md:48
  62. msgid "When setting, replace `example.com` with your own."
  63. msgstr ""
  64. #: ../../../docs/configuring-playbook-bot-maubot.md:50
  65. msgid "Customizing the maubot container image"
  66. msgstr ""
  67. #: ../../../docs/configuring-playbook-bot-maubot.md:52
  68. msgid "Certain [maubot plugins](https://plugins.mau.bot/) require additional dependencies to be installed."
  69. msgstr ""
  70. #: ../../../docs/configuring-playbook-bot-maubot.md:54
  71. msgid "You can customize the default maubot container image and install your own dependencies."
  72. msgstr ""
  73. #: ../../../docs/configuring-playbook-bot-maubot.md:67
  74. msgid "Consult the [Dockerfile reference](https://docs.docker.com/reference/dockerfile/) for more information about the syntax."
  75. msgstr ""
  76. #: ../../../docs/configuring-playbook-bot-maubot.md:69
  77. msgid "Installing"
  78. msgstr ""
  79. #: ../../../docs/configuring-playbook-bot-maubot.md:71
  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. #: ../../../docs/configuring-playbook-bot-maubot.md:78
  83. msgid "**Notes**:"
  84. msgstr ""
  85. #: ../../../docs/configuring-playbook-bot-maubot.md:80
  86. msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
  87. msgstr ""
  88. #: ../../../docs/configuring-playbook-bot-maubot.md:82
  89. msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
  90. msgstr ""
  91. #: ../../../docs/configuring-playbook-bot-maubot.md:84
  92. 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."
  93. msgstr ""
  94. #: ../../../docs/configuring-playbook-bot-maubot.md:86
  95. 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."
  96. msgstr ""
  97. #: ../../../docs/configuring-playbook-bot-maubot.md:88
  98. msgid "Usage"
  99. msgstr ""
  100. #: ../../../docs/configuring-playbook-bot-maubot.md:90
  101. msgid "By default, you can visit `matrix.example.com/_matrix/maubot/` to manage your available plugins, clients and instances."
  102. msgstr ""
  103. #: ../../../docs/configuring-playbook-bot-maubot.md:92
  104. msgid "You should start in the following order"
  105. msgstr ""
  106. #: ../../../docs/configuring-playbook-bot-maubot.md:93
  107. 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"
  108. msgstr ""
  109. #: ../../../docs/configuring-playbook-bot-maubot.md:94
  110. msgid "**Upload some Plugins**: Plugins can be obtained from [here](https://github.com/maubot/maubot#plugins) or any other source."
  111. msgstr ""
  112. #: ../../../docs/configuring-playbook-bot-maubot.md:95
  113. 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)"
  114. msgstr ""
  115. #: ../../../docs/configuring-playbook-bot-maubot.md:97
  116. msgid "Obtain an access token"
  117. msgstr ""
  118. #: ../../../docs/configuring-playbook-bot-maubot.md:99
  119. 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`."
  120. msgstr ""
  121. #: ../../../docs/configuring-playbook-bot-maubot.md:101
  122. 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)."
  123. msgstr ""
  124. #: ../../../docs/configuring-playbook-bot-maubot.md:103
  125. 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."
  126. msgstr ""