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.

170 lines
7.4 KiB

  1. # SOME DESCRIPTIVE TITLE.
  2. # Copyright (C) 2018-2026, 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: 2026-02-13 10:32+0000\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-buscarron.md:9
  19. msgid "Setting up Buscarron (optional)"
  20. msgstr ""
  21. #: ../../../docs/configuring-playbook-bot-buscarron.md:11
  22. msgid "The playbook can install and configure [Buscarron](https://github.com/etkecc/buscarron) for you."
  23. msgstr ""
  24. #: ../../../docs/configuring-playbook-bot-buscarron.md:13
  25. msgid "Buscarron is bot that receives HTTP POST submissions of web forms and forwards them to a Matrix room."
  26. msgstr ""
  27. #: ../../../docs/configuring-playbook-bot-buscarron.md:15
  28. msgid "See the project's [documentation](https://github.com/etkecc/buscarron/blob/main/README.md) to learn what it does and why it might be useful to you."
  29. msgstr ""
  30. #: ../../../docs/configuring-playbook-bot-buscarron.md:17
  31. msgid "Adjusting DNS records"
  32. msgstr ""
  33. #: ../../../docs/configuring-playbook-bot-buscarron.md:19
  34. msgid "By default, this playbook installs Buscarron on the `buscarron.` subdomain (`buscarron.example.com`) and requires you to create a CNAME record for `buscarron`, which targets `matrix.example.com`."
  35. msgstr ""
  36. #: ../../../docs/configuring-playbook-bot-buscarron.md:21
  37. msgid "When setting, replace `example.com` with your own."
  38. msgstr ""
  39. #: ../../../docs/configuring-playbook-bot-buscarron.md:23
  40. msgid "Adjusting the playbook configuration"
  41. msgstr ""
  42. #: ../../../docs/configuring-playbook-bot-buscarron.md:25
  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-buscarron.md:48
  46. msgid "Adjusting the Buscarron URL (optional)"
  47. msgstr ""
  48. #: ../../../docs/configuring-playbook-bot-buscarron.md:50
  49. msgid "By tweaking the `matrix_bot_buscarron_hostname` and `matrix_bot_buscarron_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."
  50. msgstr ""
  51. #: ../../../docs/configuring-playbook-bot-buscarron.md:52
  52. msgid "Example additional configuration for your `vars.yml` file:"
  53. msgstr ""
  54. #: ../../../docs/configuring-playbook-bot-buscarron.md:63
  55. msgid "After changing the domain, **you may need to adjust your DNS** records to point the Buscarron domain to the Matrix server."
  56. msgstr ""
  57. #: ../../../docs/configuring-playbook-bot-buscarron.md:65
  58. msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration."
  59. msgstr ""
  60. #: ../../../docs/configuring-playbook-bot-buscarron.md:67
  61. msgid "Extending the configuration"
  62. msgstr ""
  63. #: ../../../docs/configuring-playbook-bot-buscarron.md:69
  64. msgid "There are some additional things you may wish to configure about the bot."
  65. msgstr ""
  66. #: ../../../docs/configuring-playbook-bot-buscarron.md:71
  67. msgid "Take a look at:"
  68. msgstr ""
  69. #: ../../../docs/configuring-playbook-bot-buscarron.md:73
  70. msgid "`roles/custom/matrix-bot-buscarron/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
  71. msgstr ""
  72. #: ../../../docs/configuring-playbook-bot-buscarron.md:75
  73. msgid "Installing"
  74. msgstr ""
  75. #: ../../../docs/configuring-playbook-bot-buscarron.md:77
  76. 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:"
  77. msgstr ""
  78. #: ../../../docs/configuring-playbook-bot-buscarron.md:84
  79. msgid "**Notes**:"
  80. msgstr ""
  81. #: ../../../docs/configuring-playbook-bot-buscarron.md:86
  82. msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
  83. msgstr ""
  84. #: ../../../docs/configuring-playbook-bot-buscarron.md:88
  85. msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
  86. msgstr ""
  87. #: ../../../docs/configuring-playbook-bot-buscarron.md:90
  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."
  89. msgstr ""
  90. #: ../../../docs/configuring-playbook-bot-buscarron.md:92
  91. msgid "If you change the bot password (`matrix_bot_buscarron_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_buscarron_password` to let the bot know its new password."
  92. msgstr ""
  93. #: ../../../docs/configuring-playbook-bot-buscarron.md:94
  94. msgid "Usage"
  95. msgstr ""
  96. #: ../../../docs/configuring-playbook-bot-buscarron.md:96
  97. msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.buscarron:example.com` where `example.com` is your base domain, not the `matrix.` domain)."
  98. msgstr ""
  99. #: ../../../docs/configuring-playbook-bot-buscarron.md:98
  100. msgid "After the bot joins the room, anyone can call the web form via HTTP POST method."
  101. msgstr ""
  102. #: ../../../docs/configuring-playbook-bot-buscarron.md:100
  103. msgid "Here is an example for the `contact` form:"
  104. msgstr ""
  105. #: ../../../docs/configuring-playbook-bot-buscarron.md:108
  106. msgid "**Note**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if:"
  107. msgstr ""
  108. #: ../../../docs/configuring-playbook-bot-buscarron.md:110
  109. msgid "you hit the homepage (HTTP `GET` request to `/`)"
  110. msgstr ""
  111. #: ../../../docs/configuring-playbook-bot-buscarron.md:111
  112. msgid "you submit a form to the wrong URL (`POST` request to `/non-existing-form`)"
  113. msgstr ""
  114. #: ../../../docs/configuring-playbook-bot-buscarron.md:112
  115. msgid "`hasemail` is enabled for the form (like in the example above) and you don't submit an `email` field"
  116. msgstr ""
  117. #: ../../../docs/configuring-playbook-bot-buscarron.md:114
  118. msgid "If you get banned, you'd need to restart the process by running the playbook with `--tags=start` or running `systemctl restart matrix-bot-buscarron` on the server."
  119. msgstr ""
  120. #: ../../../docs/configuring-playbook-bot-buscarron.md:116
  121. msgid "Troubleshooting"
  122. msgstr ""
  123. #: ../../../docs/configuring-playbook-bot-buscarron.md:118
  124. 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-buscarron`."
  125. msgstr ""
  126. #: ../../../docs/configuring-playbook-bot-buscarron.md:120
  127. msgid "Increase logging verbosity"
  128. msgstr ""
  129. #: ../../../docs/configuring-playbook-bot-buscarron.md:122
  130. msgid "The default logging level for this component is `INFO`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
  131. msgstr ""