mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2026-04-10 08:14:24 +03:00
d4f8d0918a
Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3841 Most of the preparation for this was done by Suguru Hirahara (https://github.com/luixxiul). I've merely reorganized/polished the scripts and instructions in the `i18n/` directory. While translations can happen even now, more work is necessary to - make the translation flow better (integrating Weblate), etc. - restore the Github Actions workflows that Suguru Hirahara had already developed to adapt them to our new workflow
243 lines
11 KiB
Plaintext
243 lines
11 KiB
Plaintext
# 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"
|
|
"POT-Creation-Date: 2024-12-20 07:23+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/registering-users.md:1
|
|
msgid "Registering users"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:3
|
|
msgid "This documentation page tells you how to create user accounts on your Matrix server."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:5
|
|
msgid "Table of contents:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:7
|
|
msgid "[Registering users](#registering-users)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:8
|
|
msgid "[Registering users manually](#registering-users-manually)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:9
|
|
msgid "[Managing users via a Web UI](#managing-users-via-a-web-ui)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:10
|
|
msgid "[Letting certain users register on your private server](#letting-certain-users-register-on-your-private-server)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:11
|
|
msgid "[Enabling public user registration](#enabling-public-user-registration)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:12
|
|
msgid "[Adding/Removing Administrator privileges to an existing user](#addingremoving-administrator-privileges-to-an-existing-user)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:14
|
|
msgid "Registering users manually"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:16
|
|
#: ../../../docs/registering-users.md:118
|
|
msgid "**Notes**:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:17
|
|
msgid "Make sure to adjust `USERNAME_HERE` and `PASSWORD_HERE`"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:18
|
|
msgid "For `USERNAME_HERE`, use a plain username like `alice`, not a full ID (`@alice:example.com`)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:19
|
|
msgid "Use `admin=yes` or `admin=no` depending on whether you wish to make the user an administrator of the Matrix server"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:21
|
|
msgid "After registering a user (using one of the methods below), **you can log in with that user** via the [Element Web](configuring-playbook-client-element-web.md) service that this playbook has installed for you at a URL like this: `https://element.example.com/`."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:23
|
|
msgid "Registering users via the Ansible playbook"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:25
|
|
msgid "It's best to register users via the Ansible playbook, because it works regardless of homeserver implementation (Synapse, Dendrite, etc) or usage of [Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md) (MAS)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:27
|
|
msgid "To register a user via this Ansible playbook:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:35
|
|
msgid "**or** by invoking `ansible-playbook` manually:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:43
|
|
msgid "Feel free to register as many users (for friends, family, etc.) as you want. Still, perhaps you should grant full administrative access to your user account only (with `admin=yes`), and others should be created with `admin=no`."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:45
|
|
msgid "⚠️ **Warning**: If you're registering users against Matrix Authentication Service, do note that it [still insists](https://github.com/element-hq/matrix-authentication-service/issues/1505) on having a verified email address for each user. Upon a user's first login, they will be asked to confirm their email address. This requires that email sending is [configured](./configuring-playbook-email.md). You can also consult the [Working around email deliverability issues](./configuring-playbook-matrix-authentication-service.md#working-around-email-deliverability-issues) section for more information."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:47
|
|
msgid "Registering users manually for Synapse"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:49
|
|
msgid "If you're using the [Synapse](configuring-playbook-synapse.md) homeserver implementation (which is the default), you can register users via the command-line after **SSH**-ing to your server (requires that [all services have been started](installing.md#install-matrix-server-and-services)):"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:57
|
|
msgid "Registering users manually for Dendrite"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:59
|
|
msgid "If you're using the [Dendrite](./configuring-playbook-dendrite.md) homeserver implementation, you can register users via the command-line after **SSH**-ing to your server (requires that [all services have been started](installing.md#install-matrix-server-and-services)):"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:67
|
|
msgid "Registering users manually for Matrix Authentication Service"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:69
|
|
msgid "If you're using the [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md) and your existing homeserver (most likely [Synapse](./configuring-playbook-synapse.md)) is delegating authentication to it, you can register users via the command-line after **SSH**-ing to your server (requires that [all services have been started](installing.md#install-matrix-server-and-services)):"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:77
|
|
msgid "This `register-user` script actually invokes the `mas-cli manage register-user` command under the hood. If you'd like more control over the registration process, consider invoking the `mas-cli` command directly:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:83
|
|
msgid "⚠️ **Warning**: Matrix Authentication Service [still insists](https://github.com/element-hq/matrix-authentication-service/issues/1505) on having a verified email address for each user. Upon a user's first login, they will be asked to confirm their email address. This requires that email sending is [configured](./configuring-playbook-email.md). You can also consult the [Working around email deliverability issues](./configuring-playbook-matrix-authentication-service.md#working-around-email-deliverability-issues) section for more information."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:85
|
|
msgid "Managing users via a Web UI"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:87
|
|
msgid "To manage users more easily (via a web user-interace), you can install [Synapse Admin](configuring-playbook-synapse-admin.md)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:89
|
|
msgid "⚠️ **Warning**: If you're using [Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md), note that user management via synapse-admin is not fully working yet. See the [Expectations](configuring-playbook-matrix-authentication-service.md#expectations) section for more information."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:91
|
|
msgid "Letting certain users register on your private server"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:93
|
|
msgid "If you'd rather **keep your server private** (public registration closed, as is the default), and **let certain people create accounts by themselves** (instead of creating user accounts manually like this), consider installing and making use of [matrix-registration](configuring-playbook-matrix-registration.md)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:95
|
|
msgid "Enabling public user registration"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:97
|
|
msgid "To **open up user registration publicly** (usually **not recommended**), add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:99
|
|
msgid "For Synapse:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:105
|
|
msgid "For Dendrite:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:111
|
|
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:120
|
|
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:122
|
|
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/registering-users.md:124
|
|
msgid "If you're opening up registrations publicly like this, you might also wish to [configure CAPTCHA protection](configuring-captcha.md)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:126
|
|
msgid "Adding/Removing Administrator privileges to an existing user"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:128
|
|
msgid "Adding/Removing Administrator privileges to an existing user in Synapse"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:130
|
|
msgid "To change the admin privileges for a user in Synapse's local database, you need to run an SQL query like this against the `synapse` database:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:136
|
|
msgid "where:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:138
|
|
msgid "`ADMIN_VALUE` being either `0` (regular user) or `1` (admin)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:139
|
|
msgid "`USER` and `example.com` pointing to a valid user on your server"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:141
|
|
msgid "If you're using the integrated Postgres server and not an [external Postgres server](configuring-playbook-external-postgres.md), you can launch a Postgres into the `synapse` database by:"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:143
|
|
msgid "running `/matrix/postgres/bin/cli` - to launch [`psql`](https://www.postgresql.org/docs/current/app-psql.html)"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:144
|
|
msgid "running `\\c synapse` - to change to the `synapse` database"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:146
|
|
msgid "You can then proceed to run the query above."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:148
|
|
msgid "**Note**: directly modifying the raw data of Synapse (or any other software) could cause the software to break. You've been warned!"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:150
|
|
msgid "Adding/Removing Administrator privileges to an existing user in Matrix Authentication Service"
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:152
|
|
msgid "Promoting/demoting a user in Matrix Authentication Service cannot currently (2024-10-19) be done via the [`mas-cli` Management tool](./configuring-playbook-matrix-authentication-service.md#management)."
|
|
msgstr ""
|
|
|
|
#: ../../../docs/registering-users.md:154
|
|
msgid "You can do it via the [MAS Admin API](https://element-hq.github.io/matrix-authentication-service/api/index.html)'s `POST /api/admin/v1/users/{id}/set-admin` endpoint."
|
|
msgstr ""
|