Matrix

Docker 应用程序 from junkerderprovinz Repository

概述

All-in-one Matrix homeserver for Unraid: Synapse + coturn + Element Web (/element/) + Synapse-Admin (/admin/). Plug-and-play — just fill in SERVER_NAME and Postgres connection, everything else is generated automatically. PREREQUISITES (before starting the container): 1) PostgreSQL database — connect to your Postgres container and run: CREATE USER matrix WITH PASSWORD 'yourpass'; CREATE DATABASE matrix ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' TEMPLATE template0 OWNER matrix; (UTF8 + LC_COLLATE='C' is mandatory — Synapse will refuse to start otherwise.) 2) Reverse proxy (Nginx Proxy Manager) for matrix.yourdomain.tld → Unraid-IP:8008. In the proxy host → Advanced tab, add: client_max_body_size 100m; proxy_read_timeout 600s; (Without these, media uploads fail and long-running requests time out.) 3) For federation: two extra Custom Locations on the SAME proxy host for /.well-known/matrix/server and /.well-known/matrix/client → Unraid-IP:8080. Full step-by-step guide (NPM screenshots, well-known, first user): https://github.com/junkerderprovinz/matrix#readme

要求

PostgreSQL container with a database: ENCODING UTF8, LC_COLLATE=C, LC_CTYPE=C

运行时参数

网络用户界面: http://[IP]:[PORT:8080]/element/
网络: bridge
外壳: sh
特权: false

模板配置

Matrix HTTP APIPorttcp

Synapse HTTP API. Expose via reverse proxy with HTTPS — never directly to the internet.

目标: 8008
默认值: 8008
价值: 8008

Element Web + Synapse-AdminPorttcp

Serves Element Web (/element/), Synapse-Admin (/admin/) and /.well-known/matrix/* endpoints.

目标: 8080
默认值: 8080
价值: 8080

TURN TCPPorttcp

TURN/STUN over TCP for voice/video calls. Open this port in your router/firewall.

目标: 3478
默认值: 3478
价值: 3478

TURN UDPPortudp

TURN/STUN over UDP for voice/video calls. Open this port in your router/firewall.

目标: 3478
默认值: 3478
价值: 3478

TURN TLS TCPPorttcp

TURN over TLS (TCP). Optional — only if TLS certs are mounted.

目标: 5349
默认值: 5349
价值: 5349

TURN TLS UDPPortudp

TURN over TLS (UDP). Optional — only if TLS certs are mounted.

目标: 5349
默认值: 5349
价值: 5349

Prometheus MetricsPorttcp

Prometheus metrics at /_synapse/metrics. Bind to a private network only.

目标: 9090
默认值: 9090
价值: 9090

Data DirectoryPath

Persistent data: homeserver.yaml, media, signing keys. Never delete — destroys keys and breaks federation.

目标: /data
默认值: /mnt/user/appdata/matrix/
价值: /mnt/user/appdata/matrix/

TURN-TLS CertsPathro

Optional. Mount a folder containing fullchain.pem + privkey.pem to enable TURN-TLS on 5349.

目标: /data/certs

Matrix Server DomainVariable

Your Matrix domain, e.g. matrix.yourdomain.tld. Used in Matrix IDs (@user:matrix.yourdomain.tld). Cannot be changed later without wiping the DB.

目标: SERVER_NAME
价值: matrix.yourdomain.tld

Anonymous Usage ReportingVariable

Send anonymous usage stats to Matrix.org. 'yes' or 'no'. Recommended: no.

目标: REPORT_STATS
默认值: no
价值: no

Enable FederationVariable

true = chat with the public Matrix network (requires /.well-known/matrix/* on your proxy, see README). false = private island.

目标: ENABLE_FEDERATION
默认值: true
价值: true

PostgreSQL HostVariable

IP of your PostgreSQL server (e.g. Unraid host IP). IP+port is more reliable than container names.

目标: POSTGRES_HOST
默认值: 192.168.x.x
价值: 192.168.x.x

PostgreSQL PortVariable

PostgreSQL port. Default 5432.

目标: POSTGRES_PORT
默认值: 5432
价值: 5432

PostgreSQL UsernameVariable

Postgres user for Synapse. Must already exist (see README — Postgres setup).

目标: POSTGRES_USER
默认值: admin
价值: admin

PostgreSQL PasswordVariable

Password for the Postgres user above.

目标: POSTGRES_PASSWORD

PostgreSQL DatabaseVariable

Synapse database name. Must be created with ENCODING UTF8, LC_COLLATE='C', LC_CTYPE='C' — see Overview.

目标: POSTGRES_DB
默认值: matrix
价值: matrix

Matrix Admin Username (Element / Synapse-Admin login)Variable

Optional. Localpart of the admin user to auto-create on first boot (e.g. 'admin' → @admin:SERVER_NAME). Logs into Element Web + Synapse-Admin. Clear after creation.

目标: ADMIN_USER

Matrix Admin Password (Element / Synapse-Admin login)Variable

Optional. Password for the admin user above. Clear after first boot.

目标: ADMIN_PASSWORD

TimezoneVariable

Container timezone (affects log timestamps).

目标: TZ
默认值: Europe/Vienna
价值: Europe/Vienna

User ID (PUID)Variable

UID Synapse runs as. Default 99 (nobody on Unraid).

目标: PUID
默认值: 99
价值: 99

Group ID (PGID)Variable

GID Synapse runs as. Default 100 (users on Unraid).

目标: PGID
默认值: 100
价值: 100

类别

Network > Messenger Network > Other Productivity

链接

模板支持难民署 Pro连接

详细信息

存储库

ghcr.io/junkerderprovinz/matrix:latest

登记处

https://ghcr.io/junkerderprovinz/matrix

最后更新2026-06-01

初见2026-05-13

在Unraid 上运行 Matrix 。

Matrix 已被列入Unraid OS 的社区应用程序。探索Unraid ，构建灵活的家庭服务器、NAS 或家庭实验室。

探索Unraid OS