mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2025-10-30 23:07:57 +01:00
202 lines
9.4 KiB
Plaintext
202 lines
9.4 KiB
Plaintext
# SOME DESCRIPTIVE TITLE.
|
|
# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members
|
|
# This file is distributed under the same license as the matrix-docker-ansible-deploy package.
|
|
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
|
#
|
|
#, fuzzy
|
|
msgid ""
|
|
msgstr ""
|
|
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
|
"Report-Msgid-Bugs-To: \n"
|
|
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
|
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
|
"Language-Team: LANGUAGE <LL@li.org>\n"
|
|
"MIME-Version: 1.0\n"
|
|
"Content-Type: text/plain; charset=UTF-8\n"
|
|
"Content-Transfer-Encoding: 8bit\n"
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:1
|
|
msgid "Setting up Cactus Comments (optional)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:3
|
|
msgid "The playbook can install and configure the [Cactus Comments](https://cactus.chat) system for you."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:5
|
|
msgid "Cactus Comments is a **federated comment system** built on Matrix. It respects your privacy, and puts you in control."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:7
|
|
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."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:9
|
|
msgid "The playbook contains 2 roles for configuring different pieces of the Cactus Comments system:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:11
|
|
msgid "`matrix-cactus-comments` — the backend appservice integrating with the Matrix homeserver"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:13
|
|
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`)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:15
|
|
msgid "You can enable whichever component you need (typically both)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:17
|
|
msgid "Adjusting DNS records (optional)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:19
|
|
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."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:21
|
|
msgid "If you wish to adjust it, see the section [below](#adjusting-the-cactus-comments-client-url-optional) for details about DNS configuration."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:23
|
|
msgid "Adjusting the playbook configuration"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:25
|
|
msgid "To enable Cactus Comments, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:45
|
|
msgid "Adjusting the Cactus Comments' client URL (optional)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:47
|
|
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."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:49
|
|
msgid "Example additional configuration for your `vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:58
|
|
msgid "If you've changed the default hostname, you may need to create a CNAME record for the Cactus Comments' client domain (`cactus.example.com`), which targets `matrix.example.com`."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:60
|
|
msgid "When setting, replace `example.com` with your own."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:62
|
|
msgid "Extending the configuration"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:64
|
|
msgid "There are some additional things you may wish to configure about the components."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:66
|
|
msgid "For `matrix-cactus-comments`, take a look at:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:68
|
|
msgid "`roles/custom/matrix-cactus-comments/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:70
|
|
msgid "For `matrix-cactus-comments-client`, take a look at:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:72
|
|
msgid "`roles/custom/matrix-cactus-comments-client/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:74
|
|
msgid "Installing"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md: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:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:83
|
|
msgid "**Notes**:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:85
|
|
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:87
|
|
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:89
|
|
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."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:91
|
|
msgid "Usage"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:93
|
|
msgid "To use the component, you need to start a chat with `@bot.cactusbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:95
|
|
msgid "Then, register a site by sending `register YOUR_SITE_NAME_HERE` (where `YOUR_SITE_NAME_HERE` is a unique identifier you choose. It does not have to match your domain). You will then be invited into a moderation room."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:97
|
|
msgid "Now you are good to go and can embed the comment section on your website!"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:99
|
|
msgid "Embed Cactus Comments"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:101
|
|
msgid "The official [documentation](https://cactus.chat/docs/getting-started/quick-start/) provides a useful guide to embed Cactus Comments on your website."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:103
|
|
msgid "After including the JavaScript and CSS asset files, insert a `<div>` where you'd like to display the comment section:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:109
|
|
msgid "Then, you need to initialize the comment section. Make sure to replace `example.com` with your base domain and `YOUR_SITE_NAME_HERE` with the one that has been registered above:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:123
|
|
msgid "Adjust the domain name for self-hosting"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:125
|
|
msgid "To have the assets served from your homeserver (not from `cactus.chat`), you need to adjust the domain name on the official documentation."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:127
|
|
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:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:134
|
|
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."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:136
|
|
msgid "Troubleshooting"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:138
|
|
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-cactus-comments` for the backend appservice or `journalctl -fu matrix-cactus-comments-client` for the server serving the client assets, respectively."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:140
|
|
msgid "Increase logging verbosity"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/configuring-playbook-cactus-comments.md:142
|
|
msgid "It is possible to increase logging verbosity for `matrix-cactus-comments-client`. The default logging level for this component is `error`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
|
|
msgstr ""
|