# 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 , YEAR. # #, fuzzy msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2024-12-20 07:23+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #: ../../../docs/configuring-playbook-matrix-registration.md:1 msgid "Setting up matrix-registration (optional)" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:3 msgid "The playbook can install and configure [matrix-registration](https://github.com/ZerataX/matrix-registration) for you." msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:5 msgid "**WARNING**: this is a poorly maintained and buggy project. It's better to avoid using it." msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:7 msgid "**WARNING**: this is not related to [matrix-registration-bot](configuring-playbook-bot-matrix-registration-bot.md)" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:9 msgid "matrix-registration is a simple python application to have a token based Matrix registration." msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:11 msgid "Use matrix-registration to **create unique registration links**, which people can use to register on your Matrix server. It allows you to **keep your server's registration closed (private)**, but still allow certain people (these having a special link) to register a user account." msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:13 msgid "**matrix-registration** provides 2 things:" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:15 msgid "**an API for creating registration tokens** (unique registration links). This API can be used via `curl` or via the playbook (see [Usage](#usage) below)" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:17 msgid "**a user registration page**, where people can use these registration tokens. By default, exposed at `https://matrix.example.com/matrix-registration`" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:19 msgid "Adjusting the playbook configuration" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:21 msgid "To enable matrix-registration, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:30 msgid "Adjusting the matrix-registration URL" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:32 msgid "By default, this playbook installs the matrix-registration on the `matrix.` subdomain, at the `/matrix-registration` path (https://matrix.example.com/matrix-registration). 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-matrix-registration.md:34 msgid "By tweaking the `matrix_registration_hostname` and `matrix_registration_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-matrix-registration.md:36 msgid "Example additional configuration for your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:44 msgid "Adjusting DNS records" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:46 msgid "If you've changed the default hostname, **you may need to adjust your DNS** records to point the matrix-registration domain to the Matrix server." msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:48 msgid "See [Configuring DNS](configuring-dns.md) for details about DNS changes." msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:50 msgid "If you've decided to use the default hostname, you won't need to do any extra DNS configuration." msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:52 msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:54 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-matrix-registration.md:61 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:63 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. Note these shortcuts run the `ensure-matrix-users-created` tag too." msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:65 msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:67 msgid "**matrix-registration** gets exposed at `https://matrix.example.com/matrix-registration`" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:69 msgid "It provides various [APIs](https://github.com/ZerataX/matrix-registration/wiki/api) - for creating registration tokens, listing tokens, disabling tokens, etc. To make use of all of its capabilities, consider using `curl`." msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:71 msgid "We make the most common APIs easy to use via the playbook (see below)." msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:73 msgid "Creating registration tokens" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:75 msgid "To **create a new user registration token (link)**, use this command:" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:83 msgid "The above command creates and returns a **one-time use** token, which **expires** on the 31st of December 2021. Adjust the `one_time` and `ex_date` variables as you see fit." msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:85 msgid "Share the unique registration link (generated by the command above) with users to let them register on your Matrix server." msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:87 msgid "Listing registration tokens" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:89 msgid "To **list the existing user registration tokens**, use this command:" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:96 msgid "The shortcut command with `just` program is also available: `just run-tags list-matrix-registration-tokens`" msgstr ""