Synapse Admin service
maintained by etke.cc

• official website
• full documentation
• source code
• support

Streamlined Homeserver Management

Synapse Admin is the admin panel for your Matrix homeserver. It uses Synapse Admin API and allows you to manage your server, users, rooms, and more.

Getting Started¶

We offer a CDN version of etke.cc’s Synapse Admin fork, available at admin.etke.cc, and by default we install the same software on your server (at https://matrix.your-server.com/admin). To log in, you’ll find the following fields:

• Username: Input your Matrix user’s login.
• Password: Enter your Matrix user’s password.
• Homeserver URL: This field contains dropdown with the only available option, which is your homeserver’s URL.

CDN vs. Server Installation¶

The CDN version of Synapse Admin is the most up-to-date version, with the latest changes.

We suggest using the version installed on your server, which is available at https://matrix.your-server.com/admin, but if you specifically need the latest version due to some new feature or bugfix, you can use the CDN version.

Features¶

As an etke.cc customer, you have access both to open-source and etke.cc-exclusive features in Synapse Admin.

(etke.cc-exclusive) Server Status¶

You can observe your server’s health and performance by checking the server status indicator and by access the status page inside Synapse Admin. The information on the page is a Monitoring report.

Sidebar menu item:

Top right corner:

Status page:

(etke.cc-exclusive) Server Commands¶

You can run various commands on your server directly from Synapse Admin’s Server Status page. The commands are executed in the background, and you can view their status and output. This feature is the same as the one available in the Scheduler.

(etke.cc-exclusive) Server Notifications¶

You can receive important notifications about your server’s health, performance, updates, and even overdue payments directly in Synapse Admin. The notifications are displayed in the top right corner of the page.

User Management¶

You can manage your Matrix server users using Synapse Admin. You can create, delete, deactivate, lock, and erase users, as well as change their avatars, display names, passwords, admin status, experimental features, rate limits, and more! Additionally, for each user you can view their devices, rooms, and media.

Bulk Registration¶

For registering multiple users simultaneously, Synapse Admin provides a convenient CSV Import feature.

First, prepare a .csv file with user data for import. The file should have the following content:

id,displayname,password,is_guest,admin,deactivated
jane.doe,Jane Doe,secretpassword,false,false,false

NOTE: The second line is an example.

• id: The local part of the Matrix ID (e.g., username from @username:your-server.com).
• displayname: The user’s human-readable name.
• password: The user’s password in plaintext.
• is_guest: Should this be a guest account?
• admin: Should this be a server admin account?
• deactivated: Should this be a deactivated account?

Next, access the CSV Import page (click on the CSV IMPORT button in the top right corner, above the users’ table).

By default, this page is hosted at https://matrix.your-server.com/admin/#/import_users.

On this page, configure the following options:

• Conflict strategy: Optional, with the default setting as Stop on conflict.
• IDs: Mandatory, with the option Update existing records.
• Simulate only (bottom left corner): Mandatory, with the option unchecked.

After selecting these options, click on IMPORT.

Room Management¶

You can manage your Matrix server rooms using Synapse Admin.

You can view any room’s details, members, media, permissions, and state events. You can control the room’s status in Room Directory, assign room administrators, and more!

Media Management¶

You can manage your Matrix server media using Synapse Admin.

You can manage any user’s media, including previewing, quarantining, deleting, and filtering it by various criteria.

Clearing Old Media¶

To free up valuable disk space, occasionally, you’ll need to remove old local media (uploaded files) from your homeserver. Here’s how:

1. Log in to Synapse Admin.
2. Click on the Users' Media button in the sidebar.
3. Select the DELETE MEDIA button in the top right corner, above the table.

A new modal window opens with two available filters:

• Last access before: A commonly used filter. It removes any media that hasn’t been accessed (uploaded, viewed, or downloaded) since the specified date. For instance, if you want to clear media untouched for the last 7 days, select a date 7 days prior to today (as shown in the screenshot).
• Larger then (in bytes) This field is usually not used. However, if specified, it removes media larger than the specified size, including newly uploaded media.

Purging Remote Media Cache¶

To free up disk space, you can also purge the remote media cache. This action will remove all remote media files (i.e., media uploaded to other servers) from your homeserver. Here’s how:

1. Log in to Synapse Admin.
2. Click on the Users' Media button in the sidebar.
3. Select the PURGE REMOTE MEDIA button in the top right corner, above the table.

A new modal window opens with the following available filter:

Last access before: A commonly used filter. It removes any media that hasn’t been accessed (viewed or downloaded) since the specified date. For instance, if you want to clear media untouched for the last 7 days, select a date 7 days prior to today (as shown in the screenshot).

Moderation¶

You can moderate your Matrix server using Synapse Admin, by viewing and resolving reported events.

You can view any reported event’s details, including the reporter, the reported user, the room, the event, and the reason for the report.

Room Directory¶

You can manage your Matrix server’s room directory using Synapse Admin, by viewing and controlling the visibility of rooms in the directory.

Registration Tokens¶

You can manage your Matrix server’s registration tokens using Synapse Admin, by creating, deleting, and viewing tokens.