overmind
/
matrix-docker-ansible-deploy
peilaus alkaen https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Fork 0
Koodi Ongelmat 0 Julkaisut 0 Wiki Toiminta
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.
8904 Commitit
14 Branchit
919 MiB
 
 
Puu: af0dfd99cd
Branchit Tagit
${ item.name }
Create branch ${ searchTerm }
from 'af0dfd99cd'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-bot-bu...

138 rivejä
6.1 KiB
Raaka Blame Historia 

  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-23 13: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-buscarron.md:1

  20. msgid "Setting up Buscarron (optional)"

  21. msgstr ""

  22. 

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

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

  25. msgstr ""

  26. 

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

  28. msgid "Buscarron is bot that receives HTTP POST submissions of web forms and forwards them to a Matrix room."

  29. msgstr ""

  30. 

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

  32. msgid "Adjusting the playbook configuration"

  33. msgstr ""

  34. 

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

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

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-bot-buscarron.md:32

  40. msgid "Adjusting the Buscarron URL"

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-bot-buscarron.md:34

  44. msgid "By default, this playbook installs Buscarron on the `buscarron.` subdomain (`buscarron.example.com`) and requires you to [adjust your DNS records](#adjusting-dns-records)."

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-bot-buscarron.md:36

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

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-bot-buscarron.md:38

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

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-bot-buscarron.md:49

  56. msgid "Adjusting DNS records"

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-bot-buscarron.md:51

  60. msgid "Once you've decided on the domain and path, **you may need to adjust your DNS** records to point the Buscarron domain to the Matrix server."

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-bot-buscarron.md:53

  64. msgid "By default, you will need to create a CNAME record for `buscarron`. See [Configuring DNS](configuring-dns.md) for details about DNS changes."

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-bot-buscarron.md:55

  68. msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration."

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-bot-buscarron.md:57

  72. msgid "Installing"

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-bot-buscarron.md:59

  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. 

  79. #: ../../../docs/configuring-playbook-bot-buscarron.md:66

  80. msgid "**Notes**:"

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-bot-buscarron.md:68

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

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-bot-buscarron.md:70

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

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-bot-buscarron.md:72

  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. 

  95. #: ../../../docs/configuring-playbook-bot-buscarron.md:74

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

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-bot-buscarron.md:76

  100. msgid "Usage"

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-bot-buscarron.md:78

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

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-bot-buscarron.md:80

  108. msgid "After the bot joins the room, anyone can call the web form via HTTP POST method."

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-bot-buscarron.md:82

  112. msgid "Here is an example for the `contact` form:"

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-bot-buscarron.md:90

  116. msgid "**Note**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if:"

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-bot-buscarron.md:92

  120. msgid "you hit the homepage (HTTP `GET` request to `/`)"

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-bot-buscarron.md:93

  124. msgid "you submit a form to the wrong URL (`POST` request to `/non-existing-form`)"

  125. msgstr ""

  126. 

  127. #: ../../../docs/configuring-playbook-bot-buscarron.md:94

  128. msgid "`hasemail` is enabled for the form (like in the example above) and you don't submit an `email` field"

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-bot-buscarron.md:96

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

  133. msgstr ""

  134. 

  135. #: ../../../docs/configuring-playbook-bot-buscarron.md:98

  136. msgid "You can also refer to the upstream [documentation](https://github.com/etkecc/buscarron)."

  137. msgstr ""