2022-12-04 17:09:15 -05:00
# tommytran732/synapse
2021-06-02 13:36:21 -04:00
2022-12-04 17:09:15 -05:00
2022-09-06 14:13:05 -04:00
2021-06-02 13:36:21 -04:00
[Synapse ](https://github.com/matrix-org/synapse ) is a [Matrix ](https://matrix.org/ ) implementation written in Python.
### Notes
2022-12-04 17:09:15 -05:00
- Prebuilt images are available at `ghcr.io/tommytran732/synapse` and `quay.io/tommytran732/synapse` .
2021-06-02 13:36:21 -04:00
- Don't trust random images: build yourself if you can.
2022-12-04 17:09:15 -05:00
- Always keep your software up-to-date: manage versions with [build-time variables ](https://github.com/TommyTran732/Synapse-Docker/blob/main/Dockerfile#L1-L4 ).
- Images from `ghcr.io` are built every week and scanned every day for critical vulnerabilities with Trivy. I recommend that you use these images.
- Images from `quay.io` are built on every push event and scanned for vulnerabilities with Clair.
2021-06-02 13:36:21 -04:00
### Features & usage
- Drop-in replacement for the [official image ](https://github.com/matrix-org/synapse/tree/develop/docker ).
- Unprivileged image: you should check your volumes permissions (eg `/data` ), default UID/GID is 991.
2024-05-28 04:27:21 -04:00
- Based on the latest [Alpine ](https://alpinelinux.org/ ) containers which provide more recent packages while having less attack surface.
- Comes with the [hardened memory allocator ](https://github.com/GrapheneOS/hardened_malloc ) built from the latest tag, protecting against some heap-based buffer overflows.
- [Mjolnir module ](https://github.com/matrix-org/mjolnir/blob/main/docs/synapse_module.md ) support.
### Licensing
- v1.98.0 and prior are under the [Apache License ](https://www.apache.org/licenses/LICENSE-2.0 ). 😇
- Versions after v1.98.0 are under AGPL 3 🤮 to comply with licensing changes by Element.
