Repository files navigation

Feature-packed and visually customizable: A better way to manage your Synapse homeserver.

• Fork differences
  • Availability
    • IPFS
  • Changes
    • exclusive for etke.cc customers
  • Development
  • Support
• Configuration
  • Prefilling login form
  • Restricting available homeserver
  • Configuring CORS credentials
  • Protecting appservice managed users
  • Adding custom menu items
  • Enabling external auth provider-compatible mode
• Usage
  • Supported Synapse
  • Prerequisites
  • Use without install
  • Step-By-Step install
    • Steps for 1)
    • Steps for 2)
    • Steps for 3)
  • Serving Synapse Admin on a different path
• Development

WithAwesome-Technologies/synapse-admin as the upstream,this fork introduces numerous enhancements to improve usability and extend functionality,including support for authenticated media, advanced user management options, and visual customization.The full list is described below in theChanges section.

• As a core/default component onetke.cc
• As a standalone app onadmin.etke.cc
• As a prebuilt distribution onGitHub Releases
• As a Docker container onDocker Hub andGitHub Container Registry
• As a component inMatrix-Docker-Ansible-Deploy Playbook
• As aNix package maintained by@Defelo
• As aArch Linux AUR package maintained by@drygdryg

Maintained byFеnикs (@fenuks:sibnsk.net)

Latest version

/ipns/synapse-admin.sibnsk.net (dnslink key/ipns/k51qzi5uqu5dj91scsxoqu0ebmy7uqajrt9ohl98vs7fl7l429h0chgozk58i2)

Archive

/ipns/synapse-admin-archive.sibnsk.net (dnslink key/ipns/k51qzi5uqu5dhxwc36sld1hn6jn935k71ww8rdyqomrnqcqucixy7re08qeu7z)

the list will be updated as new changes are added

The following changes are already implemented:

• 🛑Prevent admins from deleting themselves
• 🐛Fix user's default tab not being shown
• 🔑Add identifier when authorizing with password
• 🔒Add ability to toggle whether to show locked users
• 🖊️Fix user's display name in header on user's page
• 🧹Fix footer overlapping content
• 🐋 Switch from nginx toSWS for serving the app, reducing the size of the Docker image
• 🔄Fix redirect URL after user creation
• 🔍Display actual Synapse errors
• ⚠️Fix base_url being undefined on unsuccessful login
• 📜Put the version into manifest.json (later replaced with a proper manifest.json generation on build)
• 📊Federation page improvements (using icons)
• 🚪Add UI option to block deleted rooms from being rejoined
• 🛠️Fix required fields check on Bulk registration CSV upload
• 🛡️Fix requests with invalid MXIDs on Bulk registration
• 🖼️Expose user avatar URL field in the UI
• 🚀Upgrade react-admin to v5
• 🔒Restrict actions on specific users
• 📞AddContact support menu item
• 🧹Provide options to delete media and redact events on user erase
• 🎞️Authenticated Media support
• 👁️Better media preview/download
• 🔐Login with access token
• 📏Fix footer causing vertical scrollbar
• 🍴Custom Menu Items
• 🧑‍💻Add user profile to the top menu
• 🎨Enable visual customization
• 🛋️Fix room state events display
• 🧹Sanitize CSV on import
• ⚙️ Allow setting version usingSYNAPSE_ADMIN_VERSION environment variable on build (if git is not available)
• 🧪Add option to control user's experimental features
• 🔑Add random password generation on user create/edit form
• 🚦Add option to set user's rate limits
• 🌐Support configuration via /.well-known/matrix/client
• 🛑Prevent accidental user overwrites
• 🔍Allow providing login form details via GET params
• 🎨Add preferred theme colors to login page and footer
• 🛡️Add "Assign Admin" button to the rooms
• 🖼️Add rooms' avatars
• 🏷️User Badges
• 🔄Allow prefilling any fields on the login form via GET params
• 🎞️Add "Media" tab for rooms
• 📞Support E.164-based Matrix IDs (MSC4009)
• 🛑Add support for Account Suspension (MSC3823)
• 🗑️Add "Purge Remote Media" button
• 📁Respect base url (BASE_PATH /vite build --base) when loadingconfig.json
• 🗂️Add Users' Account Data tab
• 🧾Make bulk registration CSV import more user-friendly
• 🌐Configurable CORS Credentials
• 🧪Do not check homeserver URL during typing in the login form
• 🔧Improve user account status toggles
• 🛡️Validate that password is entered upon reactivation of account
• 🇯🇵Add Japanese localization
• 🗣️Correctly set document language based on the selected locale
• 📇Support 3pids in CSV users import (bulk registration)
• 🇺🇦Add Ukrainian localization
• 🧩External Auth Provider-compatible mode
• 🪪OIDC Auth Support
• 🗂️Add Public Rooms and Empty Rooms filters

We atetke.cc attempting to develop everything open-source, but some things are too specific to be used by anyone else.The following list contains such features - they are only available foretke.cc customers.

• 📊Server Status indicator and page
• 📬Server Notifications indicator and page
• 🛠️Server Commands panel
• 🚀Server Actions page
• 💳Billing page
• ⚙️Instance config

just run-dev to start the development stack (depending on your system speed, you may want to re-run this command ifuser creation fails)

This command initializes the development environment (local Synapse server, Element Web client app, and Postgres DB),and launches the app in a dev mode athttp://localhost:5173

After that openhttp://localhost:5173 in your browser,login using the following credentials:

• Login: admin
• Password: admin
• Homeserver URL:http://localhost:8008

Element Web runs onhttp://localhost:8080

If you have any questions or need help, feel free to join thecommunity room or create an issue on GitHub.

You can useconfig.json file to configure Synapse Admin instance,and/.well-known/matrix/client file to provide Synapse Admin configuration specifically for your homeserver.In the latter case, any instance of Synapse Admin will automatically pick up the configuration from the homeserver.Note that configuration inside the/.well-known/matrix/client file should go under thecc.etke.synapse-admin key,and it will override the configuration from theconfig.json file.

In case you usespantaleev/matrix-docker-ansible-deploy oretkecc/ansible,configuration will be automatically added to the/.well-known/matrix/client file.

Configuration options

Theconfig.json can be injected into a Docker container using a bind mount.

services:synapse-admin:...volumes:      -./config.json:/app/config.json:ro...

You can prefill all fields on the login page using GET parameters.

Documentation

You can restrict the homeserver(s), so that the user can no longer define it himself.

Documentation

You can configure the CORS credentials mode for the Synapse Admin instance.

Documentation

To avoid accidental adjustments of appservice-managed users (e.g., puppets created by a bridge) and breaking the bridge,you can specify the list of MXIDs (regexp) that should be prohibited from any changes, except display name and avatar.

Documentation

You can add custom menu items to the main menu by providing amenu array in the config.

Documentation

If you use an external authentication provider (like OIDC, LDAP, etc.) for your Synapse server,you can enable theexternalAuthProvider mode to adjust Synapse Admin's behavior accordingly.

Documentation

It needs at leastSynapse v1.116.0 for all functions to work as expected!

You get your server version with the request/_synapse/admin/v1/server_version.See alsoSynapse version API.

After entering the URL on the login page of synapse-admin the server version appears below the input field.

You need access to the following endpoints:

• /_matrix
• /_synapse/admin

See alsoSynapse administration endpoints

You can use the current version of Synapse Admin without own installation directviaadmin.etke.cc.

Note:If you want to use the deployment, you have to make sure that the admin endpoints (/_synapse/admin) are accessible for your browser.Remember: You have no need to expose these endpoints to the internet but to your network.If you want your own deployment, follow theStep-By-Step Install Guide below.

You have three options:

1. Download the tarball and serve with any webserver
2. Download the source code from github and run using nodejs
3. Run the Docker container

• make sure you have a webserver installed that can serve static files (any webserver like nginx or apache will do)
• configure a vhost for synapse admin on your webserver
• download the .tar.gzfrom the latest release
• unpack the .tar.gz
• move or symlink thesynapse-admin into your vhosts root dir
• open the url of the vhost in your browser

Reverse Proxy Documentation with Examples

• make sure you have installed the following: git, yarn, nodejs
• download the source code:git clone https://github.com/etkecc/synapse-admin.git
• change into downloaded directory:cd synapse-admin
• download dependencies:yarn install
• start web server:yarn start

• run the Docker container from the public docker registry:docker run -p 8080:80 ghcr.io/etkecc/synapse-admin or use thedocker-compose.yml:docker-compose up -d

  note: if you're building on an architecture other than amd64 (for example a raspberry pi), make sure to define a maximum ram for node. otherwise the build will fail.

  note: if you're running on a ipv4-only system, make sure to setSERVER_HOST=0.0.0.0 env var. Otherwise synapse-admin will not be able to start.

  services:synapse-admin:container_name:synapse-adminhostname:synapse-adminbuild:context:https://github.com/etkecc/synapse-admin.gitdockerfile:Dockerfile.buildargs:        -BUILDKIT_CONTEXT_KEEP_GIT_DIR=1#   - NODE_OPTIONS="--max_old_space_size=1024"#   - BASE_PATH="/synapse-admin"ports:      -"8080:80"restart:unless-stopped

• browse tohttp://localhost:8080

The path prefix where synapse-admin is served can only be changed during the build step.

If you downloaded the source code, useyarn build --base=/my-prefix to set a path prefix.

If you want to build your own Docker container, use theBASE_PATH argument.

We do not support directly changing the path where Synapse Admin is served in the pre-built Docker container. Instead please use a reverse proxy if you need to move Synapse Admin to a different base path. If you want to serve multiple applications with different paths on the same domain, you need a reverse proxy anyway.

Example for Traefik:

docker-compose.yml

services:traefik:image:traefik:v3restart:unless-stoppedports:      -80:80      -443:443volumes:      -/var/run/docker.sock:/var/run/docker.sock:rosynapse-admin:image:ghcr.io/etkecc/synapse-admin:latestrestart:unless-stoppedlabels:      -"traefik.enable=true"      -"traefik.http.routers.admin.rule=Host(`example.com`) && PathPrefix(`/admin`)"      -"traefik.http.services.admin.loadbalancer.server.port=80"      -"traefik.http.middlewares.admin-slashless-redirect.redirectregex.regex=(/admin)$$"      -"traefik.http.middlewares.admin-slashless-redirect.redirectregex.replacement=$${1}/"      -"traefik.http.middlewares.admin-strip-prefix.stripprefix.prefixes=/admin"      -"traefik.http.routers.admin.middlewares=admin-slashless-redirect,admin-strip-prefix"

• Seehttps://yarnpkg.com/getting-started/editor-sdks how to setup your IDE
• Useyarn lint to run all style and linter checks
• Useyarn test to run all unit tests
• Useyarn fix to fix the coding style