1
0
mirror of https://github.com/tommytran732/Matrix.to-Docker synced 2024-09-16 14:14:42 -04:00
Matrix.to-Docker/README.md
Tommy d009421abd
Update README.md
Signed-off-by: Tommy <contact@tommytran.io>
2024-06-16 02:48:53 -07:00

20 lines
1.3 KiB
Markdown

# tommytran732/matrix.to
![Build, scan & push](https://github.com/tommytran732/Matrix.to-Docker/actions/workflows/build.yml/badge.svg)
Matrix.to is a simple url redirection service for the Matrix.org ecosystem which lets users share links to matrix entities without being tied to a specific app. Stylistically it serves as a landing page for rooms and communities.
This is my own Docker image building from [the official repository](https://github.com/matrix-org/matrix.to).
### Notes
- Prebuilt images are available at `ghcr.io/tommytran732/matrix.to`.
- Don't trust random images: build yourself if you can.
- Default Element instance is changed from [Element.io](https://app.element.io) to [ArcticFoxes.net](https://element.arcticfoxes.net)
- The Dockerfile builds from the main branch, as releases do not come out frequently.
- `yarn.lock` is ignored, as upstream does not bump dependencies properly.
### Features & usage
- Unprivileged image: default UID/GID is 992.
- Based on the latest [Alpine](https://alpinelinux.org/) container which provide more recent packages while having less attack surface.
- Daily rebuilds keeping the image up-to-date.
- Comes with the [hardened memory allocator](https://github.com/GrapheneOS/hardened_malloc) built from the latest tag, protecting against some heap-based buffer overflows.