Synapse Admin service
maintained by etke.cc

• official website
• full documentation
• source code
• support

Streamlined Homeserver Management

Synapse Admin is a valuable tool for efficiently managing your (Matrix) Synapse homeserver. Whether you’re looking to oversee user accounts, clear media, or handle various administrative tasks, Synapse Admin simplifies the process. Explore this guide to discover how to harness its potential.

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.

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.

Clearing Old Media

To free up valuable disk space, occasionally, you’ll need to remove old 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.