From d8ca00c9f3ebfbaea7ba07cb14992d3e7a84c9f3 Mon Sep 17 00:00:00 2001 From: Wonderfall Date: Wed, 2 Jun 2021 19:36:21 +0200 Subject: [PATCH] add README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0ee327f --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# wonderfall/synapse + +[Synapse](https://github.com/matrix-org/synapse) is a [Matrix](https://matrix.org/) implementation written in Python. + +### Notes +- Prebuilt images are available at `ghcr.io/wonderfall/synapse`. +- Don't trust random images: build yourself if you can. +- Always keep your software up-to-date: manage versions with [build-time variables](https://github.com/Wonderfall/docker-synapse/blob/main/Dockerfile#L1-L6). +- Images from `ghcr.io` are built every week, and scanned every day for critical vulnerabilities. + +### 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. +- Based on [Alpine](https://alpinelinux.org/), which provides more recent packages while having less attack surface. +- Comes with a [hardened memory allocator](https://github.com/GrapheneOS/hardened_malloc), protecting against some heap-based buffer overflows. \ No newline at end of file