Is synapse still maintained?

Yes, active. Last change 3 days ago. Latest release v1.164.2, 7 days ago.

Widely used. 4.8k stars, 2 years old, by an organization. As with any download, get it from the official repo.

gitmanual

Reading the repo

Opening the box…

How to set up synapse (element-hq/synapse) · gitmanual

Assembly instructions

element-hq/synapse

Synapse: Matrix homeserver written in Python/Twisted + Rust

PythonRust

Difficulty: Moderate
Time: about 15 min
Stars: ★ 4,771
Activity: Updated this month

Before you start

Is it free?: YesOpen source (AGPL-3.0).
Still maintained?: Yes, activeLast change 3 days ago. Latest release v1.164.2, 7 days ago.
Can I trust it?: Widely used4.8k stars, 2 years old, by an organization. As with any download, get it from the official repo.

Saved setup from 11 h ago

Will it work on macOS?

Yes, it runs on macOS

You'll build it yourself with Python, Rust.
It also needs PostgreSQL running (Docker handles this).

Your system

macOS Windows Linux

Start here

Website ↗element-hq.github.ioThe project's own site.

Heads-upBuilding it yourself? It also needs PostgreSQL.

From the maintainers

Install guide: `INSTALL.md`

Installation Instructions

This document has moved to the Synapse documentation website. Please update your links.

The markdown source is available in docs/setup/installation.md.

Open INSTALL.md on GitHub ↗

5 steps on macOS

Download setup.sh

Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.

Clone the repository

Needs Git: xcode-select --install

git clone https://github.com/element-hq/synapse.git
cd synapse

Install the required runtimes

Python >=3.11.0,<4.0.0, Rust stable

brew install python@3.11
pipx install poetry
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Start backing services
Needs: PostgreSQL (no compose file — install locally or run via Docker)
4
Install dependencies
```
poetry install
cargo build
```
5
Run the tests
```
cargo test
```

Did you get it running?

No reports for macOS yet.

Still stuck? Ask an AI

Opens a chat with this manual already filled in, for macOS. It uses your own account; gitmanual sends nothing.

Ask Claude Ask ChatGPT

Parts list

1×Python >=3.11.0,<4.0.0runtime
1×Rust stableruntime
1×poetry package manager
1×PostgreSQL service

Share this manual

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/element-hq/synapse/badge.svg)](https://gitmanual.com/element-hq/synapse)

Good to know

Cargo workspace — pick a crate with cargo run -p <name>.
Nested projects: complement/go.mod, rust/Cargo.toml

Details

License: AGPL-3.0
Open issues: 2,111
Branch: develop

Files we read (10)

.github/workflows/complement_tests.yml

.github/workflows/docker.yml

.github/workflows/docs-pr.yaml

.github/workflows/fix_lint.yaml

.github/workflows/latest_deps.yml

.github/workflows/tests.yml

Cargo.toml

INSTALL.md

README.rst

pyproject.toml

1,954 files in the repo