Det här sätter du upp
Matrix är ett öppet chattnätverk. Precis som med e-post kan vem som helst köra en server, och människor på olika servrar pratar med varandra som om de vore på samma server. Här består din server av två containrar i en pod, under en egen användare som heter matrix:
- Synapse, referensservern för Matrix,
- PostgreSQL, dess databas.
Caddy, som du satte upp i Podman-guiden, sköter HTTPS framför den. Adresserna ser ut som @anna:example.com, medan själva servern körs på matrix.example.com, så att example.com kan fortsätta vara din webbplats.
Varje steg nedan har körts på en nyinstallerad VC-P Alloy (2 vCPU, 8 GB) hos Melonslab med Debian 13. Federationstestet från Matrix godkände servern över IPv4 och IPv6, en användare på testservern gick med i ett publikt rum på matrix.org och tog emot dess meddelanden, och allt startade igen av sig självt efter en omstart av servern. Via en SMTP-server för test på port 587 med STARTTLS skickade Synapse länken som bekräftar en tillagd adress, en återställning av lösenord som fungerade och ett mejl om ett missat meddelande. En säkerhetskopia återställdes till tomma volymer, med kontot, dess meddelanden och en uppladdad fil kvar. Med servern ansluten till det rummet använde Synapse och PostgreSQL under 200 MB minne. Röst- och videosamtal kräver mer resurser och sätts upp i samtalsguiden.
Innan du börjar
Du behöver:
- en server uppsatt som i Podman-guiden, med Caddy igång;
- en domän, till exempel
example.com, med en A-post och en AAAA-post förmatrix.example.comsom pekar på din server; - ett sätt att publicera två små filer på
https://example.com, antingen via Caddy på den här servern eller där din webbplats ligger (steg 6).
Exemplen använder example.com. Byt genomgående ut det mot ditt eget.
1. Skapa användaren
Som root:
useradd -m -s /bin/bash matrix
loginctl enable-linger matrix
machinectl shell matrix@
Allt fram till steg 6 körs som matrix.
2. Skapa Synapses konfiguration
podman run --rm -v matrix-data:/data \
-e SYNAPSE_SERVER_NAME=example.com -e SYNAPSE_REPORT_STATS=no \
docker.io/matrixdotorg/synapse:latest generate
Det skapar en volym, matrix-data, med Synapses konfiguration, dess hemligheter och serverns signeringsnyckel, som är dess identitet i Matrix-nätverket. Servernamnet blir en del av varje adress och kan inte ändras senare, så välj det med omsorg.
3. Skapa databaslösenordet
pw=$(openssl rand -hex 24)
printf %s "$pw" | podman secret create matrix-db-password -
printf 'database:\n name: psycopg2\n args:\n user: synapse\n password: "%s"\n dbname: synapse\n host: 127.0.0.1\n' "$pw" | podman secret create synapse-database -
unset pw
Den första hemligheten går till PostgreSQL. Den andra är databasdelen av Synapses konfiguration, som Synapse läser som en fil, så lösenordet skrivs inte in i någon av filerna nedan.
4. Definiera podden
mkdir -p ~/.config/containers/systemd ~/matrix
Skapa ~/.config/containers/systemd/matrix.pod:
[Pod]
PodName=matrix
# Only Caddy, on this server, can reach Synapse: the port is not open to the internet.
PublishPort=127.0.0.1:8082:8008
[Install]
WantedBy=default.target
Skapa ~/.config/containers/systemd/matrix-db.container:
[Container]
ContainerName=matrix-db
Image=docker.io/library/postgres:18-alpine
Pod=matrix.pod
Volume=matrix-db:/var/lib/postgresql
Environment=POSTGRES_USER=synapse POSTGRES_DB=synapse
Environment="POSTGRES_INITDB_ARGS=--encoding=UTF-8 --lc-collate=C --lc-ctype=C"
Secret=matrix-db-password,type=env,target=POSTGRES_PASSWORD
AutoUpdate=registry
[Service]
Restart=always
Synapse kräver en databas med sorteringsordningen C, som POSTGRES_INITDB_ARGS ställer in när databasen skapas första gången.
Skapa ~/.config/containers/systemd/matrix-synapse.container:
[Unit]
After=matrix-db.service
[Container]
ContainerName=matrix-synapse
Image=docker.io/matrixdotorg/synapse:latest
Pod=matrix.pod
Volume=matrix-data:/data
Volume=%h/matrix/synapse.yaml:/config/synapse.yaml:ro
Secret=synapse-database,type=mount,target=/config/database.yaml,uid=991,gid=991,mode=0400
Exec=run --config-path /data/homeserver.yaml --config-path /config/synapse.yaml --config-path /config/database.yaml
AutoUpdate=registry
[Service]
Restart=always
Och ~/matrix/synapse.yaml, dina egna inställningar:
public_baseurl: https://matrix.example.com/
Synapse läser de tre konfigurationsfilerna i tur och ordning, och en inställning i en senare fil ersätter samma inställning i en tidigare. På så sätt hamnar dina ändringar utanför den genererade filen: här den publika adressen och bytet från den inbyggda SQLite-databasen till PostgreSQL. Synapse släpps med några veckors mellanrum, och latest med AutoUpdate håller den uppdaterad; den uppdaterar sin databas själv när den startar.
5. Starta den
systemctl --user daemon-reload
systemctl --user start matrix-pod
podman logs -f matrix-synapse
När loggen visar Synapse now listening on TCP port 8008 trycker du Ctrl+C. En varning strax innan, om att Synapse inte kunde lyssna på 0.0.0.0, är ofarlig: den lyssnar på [::], som även täcker IPv4.
6. Sätt Caddy framför
Gå tillbaka till root med exit och byt till Caddys användare:
machinectl shell caddy@
Lägg till det här blocket sist i ~/Caddyfile:
matrix.example.com {
reverse_proxy /_matrix/* 127.0.0.1:8082
reverse_proxy /_synapse/client/* 127.0.0.1:8082
}
Bara de sökvägar som Matrix-appar och andra servrar använder skickas vidare, så Synapses admingränssnitt går bara att nå från själva servern.
Nu till de två filerna på https://example.com. De talar om för andra servrar och appar att Matrix-servern för example.com är matrix.example.com. Om example.com pekar på den här servern lägger du till:
example.com {
header /.well-known/matrix/* Content-Type application/json
header /.well-known/matrix/* Access-Control-Allow-Origin *
respond /.well-known/matrix/server `{"m.server": "matrix.example.com:443"}`
respond /.well-known/matrix/client `{"m.homeserver": {"base_url": "https://matrix.example.com"}}`
}
Om example.com redan har ett block i Caddyfile lägger du de fyra raderna i det blocket i stället: Caddy godtar inte två block för samma adress. Om din webbplats körs någon annanstans publicerar du samma två filer där, på /.well-known/matrix/server och /.well-known/matrix/client, med samma två headers.
Starta om Caddy, vilket kort avbryter alla webbplatser den serverar:
systemctl --user restart caddy
7. Skapa ditt konto
Gå tillbaka till root med exit, byt till användaren matrix med machinectl shell matrix@ och kör:
podman exec -it matrix-synapse register_new_matrix_user -c /data/homeserver.yaml http://localhost:8008
Den frågar efter användarnamn och lösenord, och om kontot ska vara admin. Ingen kan registrera sig på servern på egen hand, så skapa konton åt andra på samma sätt.
Logga in med en Matrix-app, till exempel Element från element.io. Elements inloggningssida visar matrix.org som server: välj Edit bredvid, ange example.com under Other account provider och välj Continue. Appen hittar matrix.example.com själv. I Element är privata chattar end-to-end-krypterade som standard.
8. E-post
Synapse skickar e-post för att bekräfta en adress som en användare lägger till på sitt konto, för återställning av lösenord och om meddelanden som en användare har missat. Utan e-post misslyckas det att lägga till en adress i appens inställningar, med "Adding an email to your account is disabled on this server", och att återställa ett glömt lösenord misslyckas med "Email-based password resets have been disabled on this server". Konton, chatt och federation fungerar som vanligt.
Skicka via din e-postleverantörs SMTP-server. Precis som databasinställningarna hamnar e-postinställningarna i en hemlighet som Synapse läser som en fil, så lösenordet finns inte i någon fil. Som matrix, med din egen server, ditt konto och din avsändaradress:
read -rsp 'SMTP password: ' pw; echo
printf 'email:\n smtp_host: smtp.example.com\n smtp_port: 587\n require_transport_security: true\n smtp_user: matrix@example.com\n smtp_pass: "%s"\n notif_from: "Matrix <matrix@example.com>"\n enable_notifs: true\n' "$pw" | podman secret create synapse-email -
unset pw
Kommandot frågar efter SMTP-lösenordet utan att visa det. Om lösenordet innehåller " eller \ skriver du ett \ framför varje. Port 587 med require_transport_security använder STARTTLS, och Synapse vägrar skicka utan det. För port 465, som använder TLS från början, byter du port och ersätter require_transport_security: true med force_tls: true.
Lägg till den här raden i ~/.config/containers/systemd/matrix-synapse.container, under raden Secret=synapse-database:
Secret=synapse-email,type=mount,target=/config/email.yaml,uid=991,gid=991,mode=0400
och lägg till --config-path /config/email.yaml sist på raden Exec=. Starta sedan om Synapse:
systemctl --user daemon-reload
systemctl --user restart matrix-synapse
Varje användare lägger till sin adress i appens inställningar och bekräftar den med länken som Synapse skickar. Sedan fungerar Forgot password? på inloggningssidan för dem. E-post om missade meddelanden skickas när en användare har slagit på e-postaviseringar i appen, ungefär 10 minuter efter ett meddelande de inte har läst.
9. Kontrollera federationen
Öppna https://federationtester.matrix.org, ange example.com och kontrollera att den rapporterar att allt fungerar. Gå sedan med i ett publikt rum på en annan server från din app. Första gången du går med i ett stort rum kan det ta några minuter, eftersom din server hämtar rummets historik.
10. Håll den uppdaterad
Slå på Podmans dagliga uppdateringar för den här användaren:
systemctl --user enable --now podman-auto-update.timer
11. Säkerhetskopiera
umask 077
mkdir -p ~/backup
podman exec matrix-db pg_dump -U synapse synapse > ~/backup/synapse-db.sql
podman volume export matrix-data > ~/backup/matrix-data.tar
Det sparar databasen i en egen fil och konfigurationen, signeringsnyckeln och uppladdade filer i ett arkiv. umask 077 gör att bara matrix kan läsa nya filer. Kopiera sedan ~/backup till en annan maskin och förvara kopian säkert: den som har signeringsnyckeln kan uppträda som din server.
För att återställa på en ny server gör du steg 1, 3 och 4, och steg 8 om du använder e-post, men inte steg 2: arkivet innehåller konfigurationen och signeringsnyckeln. Sedan, som matrix, med säkerhetskopian i ~/backup:
podman volume create matrix-data
podman volume import matrix-data ~/backup/matrix-data.tar
systemctl --user daemon-reload
systemctl --user start matrix-db
systemctl --user stop matrix-synapse
until podman exec matrix-db pg_isready -q -h 127.0.0.1; do sleep 2; done
podman exec matrix-db dropdb -U synapse synapse
podman exec matrix-db createdb -U synapse -E UTF8 --lc-collate=C --lc-ctype=C -T template0 synapse
podman exec -i matrix-db psql -q -U synapse -d synapse < ~/backup/synapse-db.sql > /dev/null
systemctl --user start matrix-synapse
När databasen startar startar hela podden, och Synapse fyller den nya, tomma databasen direkt. Därför stoppar raderna Synapse, väntar tills PostgreSQL är redo och byter ut databasen mot en tom med sorteringsordningen C innan säkerhetskopian läses in. Fortsätt sedan med steg 6. I vårt test kom kontot, dess rum och meddelanden och en uppladdad fil tillbaka.
Felsökning
Federationstestet rapporterar ett problem med .well-known. Öppna https://example.com/.well-known/matrix/server i en webbläsare; den ska visa JSON-texten från steg 6.
Synapse avbryter starten med ett meddelande om databasens sorteringsordning (collation). Databasen skapades utan sorteringsordningen C, och POSTGRES_INITDB_ARGS gäller bara för en tom volym. På en ny server stoppar du podden, raderar databasen med podman volume rm matrix-db och startar igen.
Sökningen hittar inte ett ord med å, ä eller ö som du skrivit med andra versaler. Sorteringsordningen C, som Synapse kräver, gör att PostgreSQL:s sökning bara bortser från skillnaden mellan stora och små bokstäver för A till Z. En sökning på älvsjö hittar inte ett meddelande med Älvsjö, medan stockholm hittar Stockholm. Sök med samma versaler som i meddelandet. Det gäller sökningen på servern, som omfattar rum som inte är end-to-end-krypterade.
Synapse meddelar att konfigurationsfilen inte finns. Steg 2 har inte körts som den här användaren, eller så har volymen i steg 2 och i matrix-synapse.container olika namn.
Samtal och mer
Röst- och videosamtal kräver en egen samtalstjänst. Samtalsguiden lägger till en på den här servern, för Elements appar och för äldre appar. Hermes Agent kan ansluta till den som en AI-assistent du chattar med.
Med din Matrix-server på en server hos Melonslab lagras dina konton, rum och meddelanden i Sverige, på en server du själv styr över, där svensk lag och EU-rätt gäller.