matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-matrix-corporal.pot

126 lines
6.2 KiB
Plaintext
Raw Normal View History

# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2018-2024, 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"
2024-12-20 07:53:46 +00:00
"POT-Creation-Date: 2024-12-20 09:53+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-matrix-corporal.md:1
msgid "Setting up Matrix Corporal (optional, advanced)"
msgstr ""
#: ../../../docs/configuring-playbook-matrix-corporal.md:5
msgid "**WARNING**: This is an advanced feature! It requires prior experience with Matrix and a specific need for using [Matrix Corporal](https://github.com/devture/matrix-corporal). If you're unsure whether you have such a need, you most likely don't."
msgstr ""
#: ../../../docs/configuring-playbook-matrix-corporal.md:9
msgid "The playbook can install and configure [matrix-corporal](https://github.com/devture/matrix-corporal) for you."
msgstr ""
#: ../../../docs/configuring-playbook-matrix-corporal.md:11
2024-12-20 07:53:46 +00:00
msgid "In short, it's a sort of automation and firewalling service, which is helpful if you're instaling Matrix services in a controlled corporate environment."
msgstr ""
#: ../../../docs/configuring-playbook-matrix-corporal.md:13
2024-12-20 07:53:46 +00:00
msgid "See the project's [documentation](https://github.com/devture/matrix-corporal/blob/main/README.md) to learn what it does and why it might be useful to you."
msgstr ""
#: ../../../docs/configuring-playbook-matrix-corporal.md:15
msgid "If you decide that you'd like to let this playbook install it for you, you'd need to also:"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:16
msgid "(required) [set up the Shared Secret Auth password provider module](configuring-playbook-shared-secret-auth.md)"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:17
msgid "(optional, but encouraged) [set up the REST authentication password provider module](configuring-playbook-rest-auth.md)"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:19
msgid "Adjusting the playbook configuration"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:21
msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:74
msgid "Matrix Corporal operates with a specific Matrix user on your server. By default, it's `matrix-corporal` (controllable by the `matrix_corporal_reconciliation_user_id_local_part` setting, see above)."
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:76
msgid "No matter what Matrix user ID you configure to run it with, make sure that:"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:78
msgid "the Matrix Corporal user is created by [registering it](registering-users.md) **with administrator privileges**. Use a password you remember, as you'll need to log in from time to time to create or join rooms"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:80
msgid "the Matrix Corporal user is joined and has Admin/Moderator-level access to any rooms you want it to manage"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:82
msgid "Using a locally-stored static policy"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:84
msgid "If you'd like to use a [static policy file](https://github.com/devture/matrix-corporal/blob/master/docs/policy-providers.md#static-file-pull-style-policy-provider), you can use a configuration like this:"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:116
msgid "To learn more about what the policy configuration, see the matrix-corporal documentation on [policy](https://github.com/devture/matrix-corporal/blob/master/docs/policy.md)."
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:118
msgid "Installing"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:120
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:127
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just run-tags setup-aux-files,setup-corporal,start` or `just setup-all`"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:129
msgid "`just run-tags setup-aux-files,setup-corporal,start` is useful for maintaining your setup quickly 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. Note `just setup-all` runs the `ensure-matrix-users-created` tag too."
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:131
msgid "Matrix Corporal files"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:133
msgid "The following local filesystem paths are mounted in the `matrix-corporal` container and can be used in your configuration (or policy):"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:135
msgid "`/matrix/corporal/config` is mounted at `/etc/matrix-corporal` (read-only)"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:137
msgid "`/matrix/corporal/var` is mounted at `/var/matrix-corporal` (read and write)"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:139
msgid "`/matrix/corporal/cache` is mounted at `/var/cache/matrix-corporal` (read and write)"
msgstr ""
2024-12-20 07:53:46 +00:00
#: ../../../docs/configuring-playbook-matrix-corporal.md:141
msgid "As an example: you can create your own configuration files in `/matrix/corporal/config` and they will appear in `/etc/matrix-corporal` in the Docker container. Your configuration (stuff in `matrix_corporal_policy_provider_config`) needs to refer to these files via the local container paths - `/etc/matrix-corporal` (read-only), `/var/matrix-corporal` (read and write), `/var/cache/matrix-corporal` (read and write)."
msgstr ""