cqrenet/matrix-docker-ansible-deploy
3
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2026-04-24 01:17:34 +00:00
Code Issues Wiki Activity

Synapse Admin is Ketesa now! (#5113)

Browse Source 
* Synapse Admin is Ketesa now!

* i18n changes

* add automatic migration

* fix migration version in vars

* add a note about routing for OIDC Auth

* mention v1.0.0 announcement blog post

* Update docs/container-images.md

Co-authored-by: Suguru Hirahara <luixxiul@users.noreply.github.com>

* Update CHANGELOG.md

Co-authored-by: Suguru Hirahara <luixxiul@users.noreply.github.com>

---------

Co-authored-by: Suguru Hirahara <luixxiul@users.noreply.github.com>
This commit is contained in:
Aine
2026-04-03 15:26:18 +01:00
committed by GitHub
parent 3d40026f93
commit 9049a82945
100 changed files with 19316 additions and 15130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

161
i18n/translation-templates/docs/configuring-playbook-ketesa.pot Normal file
View File

@@ -0,0 +1,161 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2018-2026, 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: 2026-04-03 12:02+0100\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-ketesa.md:14
msgid "Setting up Ketesa (optional)"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:16
msgid "The playbook can install and configure [Ketesa](https://github.com/etkecc/ketesa) for you."
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:18
msgid "Ketesa is a fully-featured admin interface for Matrix homeservers — manage users, rooms, media, sessions, and more from one clean, responsive web UI. It is the evolution of [Awesome-Technologies/synapse-admin](https://github.com/Awesome-Technologies/synapse-admin): what began as a fork has grown into its own independent project with a redesigned interface, comprehensive Synapse and MAS API coverage, and multi-language support."
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:20
msgid "[!NOTE]"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:22
msgid "Ketesa does not work with other homeserver implementations than Synapse due to API's incompatibility."
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:23
msgid "The latest version of Ketesa is hosted by [etke.cc](https://etke.cc/) at [admin.etke.cc](https://admin.etke.cc/). If you only need this service occasionally and trust giving your admin credentials to a 3rd party Single Page Application, you can consider using it from there and avoiding the (small) overhead of self-hosting."
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:24
msgid "This playbook also supports an alternative management UI in the shape of [Element Admin](./configuring-playbook-element-admin.md). Please note that it's currently less feature-rich than Ketesa and requires [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md)."
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:26
msgid "Adjusting DNS records (optional)"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:28
msgid "By default, this playbook installs Ketesa on the `matrix.` subdomain, at the `/synapse-admin` path (https://matrix.example.com/synapse-admin) — the legacy path is kept for backward compatibility. 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-ketesa.md:30
msgid "If you wish to adjust it, see the section [below](#adjusting-the-ketesa-url-optional) for details about DNS configuration."
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:32
msgid "Adjusting the playbook configuration"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:34
msgid "To enable Ketesa, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:40
msgid "**Note**: Ketesa requires Synapse's [Admin APIs](https://element-hq.github.io/synapse/latest/usage/administration/admin_api/index.html) to function. Access to them is restricted with a valid access token, so exposing them publicly should not be a real security concern. Still, for additional security, we normally leave them unexposed, following [official Synapse reverse-proxying recommendations](https://element-hq.github.io/synapse/latest/reverse_proxy.html#synapse-administration-endpoints). Because Ketesa needs these APIs to function, when installing Ketesa, the playbook **automatically** exposes the Synapse Admin API publicly for you. Depending on the homeserver implementation you're using (Synapse, Dendrite), this is equivalent to:"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:42
msgid "for [Synapse](./configuring-playbook-synapse.md) (our default homeserver implementation): `matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true`"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:43
msgid "for [Dendrite](./configuring-playbook-dendrite.md): `matrix_dendrite_container_labels_public_client_synapse_admin_api_enabled: true`"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:45
msgid "By default, Ketesa installation will be [restricted to only work with one homeserver](https://github.com/etkecc/ketesa/blob/main/README.md#restricting-available-homeserver) — the one managed by the playbook. To adjust these restrictions, tweak the `matrix_ketesa_config_restrictBaseUrl` variable."
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:47
msgid "Adjusting the Ketesa URL (optional)"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:49
msgid "By tweaking the `matrix_ketesa_hostname` and `matrix_ketesa_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-ketesa.md:51
msgid "We recommend updating the path prefix to `/ketesa` to align with the new branding, while the default `/synapse-admin` is kept for backward compatibility:"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:57
msgid "Or to change the hostname entirely:"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:65
msgid "If you've changed the default hostname, you may need to create a CNAME record for the Ketesa domain (`admin.example.com`), which targets `matrix.example.com`."
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:67
msgid "When setting, replace `example.com` with your own."
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:69
msgid "Extending the configuration"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:71
msgid "There are some additional things you may wish to configure about the component."
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:73
msgid "Take a look at:"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:75
msgid "`roles/custom/matrix-ketesa/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_ketesa_configuration_extension_json` variable"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:77
msgid "Installing"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:79
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-ketesa.md:86
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md: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. Note these shortcuts run the `ensure-matrix-users-created` tag too."
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:90
msgid "Usage"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:92
msgid "After installation, Ketesa will be accessible at: `https://matrix.example.com/synapse-admin/` (or `/ketesa/` if you updated the path prefix as recommended)"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:94
msgid "To use Ketesa, you need to have [registered at least one administrator account](registering-users.md) on your server."
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:96
msgid "Troubleshooting"
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:98
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-ketesa`."
msgstr ""
#: ../../../docs/configuring-playbook-ketesa.md:100
msgid "If you have questions, you can join this community room and feel free to ask: [#ketesa:etke.cc](https://matrix.to/#/#ketesa:etke.cc)"
msgstr ""