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.
 
 

166 lines
7.6 KiB

  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 23:17+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. #: ../../../docs/configuring-playbook-cactus-comments.md:1
  19. msgid "Setting up Cactus Comments (optional)"
  20. msgstr ""
  21. #: ../../../docs/configuring-playbook-cactus-comments.md:3
  22. msgid "The playbook can install and configure the [Cactus Comments](https://cactus.chat) system for you."
  23. msgstr ""
  24. #: ../../../docs/configuring-playbook-cactus-comments.md:5
  25. msgid "Cactus Comments is a **federated comment system** built on Matrix. It respects your privacy, and puts you in control."
  26. msgstr ""
  27. #: ../../../docs/configuring-playbook-cactus-comments.md:7
  28. msgid "See the project's [documentation](https://cactus.chat/docs/getting-started/introduction/) to learn what it does and why it might be useful to you."
  29. msgstr ""
  30. #: ../../../docs/configuring-playbook-cactus-comments.md:9
  31. msgid "The playbook contains 2 roles for configuring different pieces of the Cactus Comments system:"
  32. msgstr ""
  33. #: ../../../docs/configuring-playbook-cactus-comments.md:11
  34. msgid "`matrix-cactus-comments` - the backend appservice integrating with the Matrix homeserver"
  35. msgstr ""
  36. #: ../../../docs/configuring-playbook-cactus-comments.md:13
  37. msgid "`matrix-cactus-comments-client` - a static website server serving the [cactus-client](https://cactus.chat/docs/client/introduction/) static assets (`cactus.js` and `styles.css`)"
  38. msgstr ""
  39. #: ../../../docs/configuring-playbook-cactus-comments.md:15
  40. msgid "You can enable whichever component you need (typically both)."
  41. msgstr ""
  42. #: ../../../docs/configuring-playbook-cactus-comments.md:17
  43. msgid "Configuration"
  44. msgstr ""
  45. #: ../../../docs/configuring-playbook-cactus-comments.md:19
  46. msgid "To enable Cactus Comments, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
  47. msgstr ""
  48. #: ../../../docs/configuring-playbook-cactus-comments.md:41
  49. msgid "Adjusting the Cactus Comments' client URL"
  50. msgstr ""
  51. #: ../../../docs/configuring-playbook-cactus-comments.md:43
  52. msgid "By default, this playbook installs Cactus Comments' client on the `matrix.` subdomain, at the `/cactus-comments` path (https://matrix.example.com/cactus-comments). 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. #: ../../../docs/configuring-playbook-cactus-comments.md:45
  55. msgid "By tweaking the `matrix_cactus_comments_client_hostname` and `matrix_cactus_comments_client_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."
  56. msgstr ""
  57. #: ../../../docs/configuring-playbook-cactus-comments.md:47
  58. msgid "Example additional configuration for your `inventory/host_vars/matrix.example.com/vars.yml` file:"
  59. msgstr ""
  60. #: ../../../docs/configuring-playbook-cactus-comments.md:56
  61. msgid "Adjusting DNS records"
  62. msgstr ""
  63. #: ../../../docs/configuring-playbook-cactus-comments.md:58
  64. msgid "If you've changed the default hostname, **you may need to adjust your DNS** records to point the Cactus Comments' client domain to the Matrix server."
  65. msgstr ""
  66. #: ../../../docs/configuring-playbook-cactus-comments.md:60
  67. msgid "See [Configuring DNS](configuring-dns.md) for details about DNS changes."
  68. msgstr ""
  69. #: ../../../docs/configuring-playbook-cactus-comments.md:62
  70. msgid "If you've decided to use the default hostname, you won't need to do any extra DNS configuration."
  71. msgstr ""
  72. #: ../../../docs/configuring-playbook-cactus-comments.md:64
  73. msgid "Installing"
  74. msgstr ""
  75. #: ../../../docs/configuring-playbook-cactus-comments.md:66
  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-cactus-comments.md:73
  79. msgid "**Notes**:"
  80. msgstr ""
  81. #: ../../../docs/configuring-playbook-cactus-comments.md:75
  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-cactus-comments.md:77
  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-cactus-comments.md:79
  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-cactus-comments.md:81
  91. msgid "Usage"
  92. msgstr ""
  93. #: ../../../docs/configuring-playbook-cactus-comments.md:83
  94. msgid "Upon starting Cactus Comments, a `bot.cactusbot` user account is created automatically."
  95. msgstr ""
  96. #: ../../../docs/configuring-playbook-cactus-comments.md:85
  97. msgid "To get started, send `help` to the `@bot.cactusbot:example.com` bot to confirm it's working."
  98. msgstr ""
  99. #: ../../../docs/configuring-playbook-cactus-comments.md:87
  100. msgid "Then, register a site by sending `register <YourSiteName>` (where `<YourSiteName>` is a unique identifier you choose. It does not have to match your domain). You will then be invited into a moderation room."
  101. msgstr ""
  102. #: ../../../docs/configuring-playbook-cactus-comments.md:89
  103. msgid "Now you are good to go and can embed the comment section on your website!"
  104. msgstr ""
  105. #: ../../../docs/configuring-playbook-cactus-comments.md:91
  106. msgid "Embed Cactus Comments"
  107. msgstr ""
  108. #: ../../../docs/configuring-playbook-cactus-comments.md:93
  109. msgid "The official [documentation](https://cactus.chat/docs/getting-started/quick-start/) provides a useful guide to embed Cactus Comments on your website."
  110. msgstr ""
  111. #: ../../../docs/configuring-playbook-cactus-comments.md:95
  112. msgid "After including the JavaScript and CSS asset files, insert a `<div>` where you'd like to display the comment section:"
  113. msgstr ""
  114. #: ../../../docs/configuring-playbook-cactus-comments.md:101
  115. msgid "Then, you need to initialize the comment section. Make sure to replace `example.com` with your base domain and `<YourSiteName>` with the one that has been registered above:"
  116. msgstr ""
  117. #: ../../../docs/configuring-playbook-cactus-comments.md:115
  118. msgid "Adjust the domain name for self-hosting"
  119. msgstr ""
  120. #: ../../../docs/configuring-playbook-cactus-comments.md:117
  121. msgid "To have the assets served from your homeserver (not from `cactus.chat`), you need to adjust the domain name on the official documentation."
  122. msgstr ""
  123. #: ../../../docs/configuring-playbook-cactus-comments.md:119
  124. msgid "Make sure to replace `example.com` with your base domain before you include the following lines, instead of the one provided by the official documentation:"
  125. msgstr ""
  126. #: ../../../docs/configuring-playbook-cactus-comments.md:126
  127. msgid "**Note**: if the `matrix_cactus_comments_client_hostname` and `matrix_cactus_comments_client_path_prefix` variables are tweaked, you would need to adjust the URLs of the assets accordingly."
  128. msgstr ""