Implementați Matrix Synapse cu Docker Compose și PostgreSQL

Rulați Synapse ca proiect Docker Compose cu un director de configurare persistent și o bază de date PostgreSQL. Configurarea de mai jos generează cheile de semnare ale Synapse și homeserver.yaml, îl conectează la PostgreSQL și menține listener-ul HTTP pe localhost, astfel încât să puteți plasa HTTPS și federația în spatele unui proxy invers înainte de a deschide serverul la internet.

Synapse este serverul principal Matrix: stochează conturi, camere, evenimente și fișiere media pentru un server. Docker Compose rulează containerele Synapse și PostgreSQL dintr-un singur fișier YAML. Acesta este un punct de plecare pentru o singură mașină, nu o implementare publică completă a Matrix.

Înainte de a începe

Instalați Docker Engine și pluginul Docker Compose, apoi confirmați că docker compose versionfuncționează. Docker Desktop include Compose pe Windows și macOS; utilizatorii Linux pot instala pluginul Compose din depozitul de pachete Docker. Consultați instrucțiunile de instalare Compose din Docker .

Alegeți numele permanent al serverului Matrix înainte de a genera configurația. Acesta apare în ID-urile de utilizator, cum ar fi @alex:matrix.example.org, iar modificarea ulterioară a acestuia nu este o editare de rutină a numelui de gazdă. În acest exemplu, matrix.example.orgreprezintă atât numele serverului Matrix, cât și numele de gazdă public. Pentru un server public, direcționați înregistrarea DNS a acestuia către gazda dvs. și planificați un proxy invers HTTPS. Listener-ul HTTP generat de Synapse pe portul 8008 este potrivit pentru testarea locală; documentația sa de instalare precizează că utilizarea practică necesită HTTPS.

1. Creați un proiect și un secret

Pe gazda Docker, creați un director de lucru și folderele persistente. Folderul synapseva conține cheia de configurare și semnare generată; data/postgresva conține fișierele bazei de date.

mkdir -p ~/matrix-synapse/synapse ~/matrix-synapse/data/postgres
cd ~/matrix-synapse
umask 077
openssl rand -hex 32

Copiați rezultatul comenzii într-un .envfișier nou ca DB_PASSWORD=.... Păstrați acest fișier privat și faceți o copie de rezervă securizată a acestuia. Compose citește .envpentru substituții în fișierul Compose; Synapse nu extinde automat acele variabile din interior homeserver.yaml. Veți introduce aceeași parolă în configurația respectivă la pasul 3.

Vizualizare ilustrativă a unui director de proiect matrix-synapse care conține fișierul docker-compose.yml, un fișier de mediu, un folder de configurare Synapse și un folder de date.
Un folder de proiect separă fișierele de definiție Compose, de configurare Synapse și de bază de date persistentă.

2. Definiți cele două servicii

Creați docker-compose.ymlîn directorul proiectului. Acest exemplu folosește imaginea oficială Synapse publicată de Element HQ și PostgreSQL 16. Portul Synapse este legat la loopback în loc de fiecare interfață de rețea. Verificarea stării de funcționare ajută Compose să aștepte PostgreSQL înainte de a porni Synapse.

services:
  synapse:
    image: ghcr.io/element-hq/synapse:latest
    restart: unless-stopped
    environment:
      SYNAPSE_CONFIG_PATH: /data/homeserver.yaml
    volumes:
      - ./synapse:/data
    ports:
      - "127.0.0.1:8008:8008"
    depends_on:
      db:
        condition: service_healthy

  db:
    image: postgres:16-alpine
    restart: unless-stopped
    environment:
      POSTGRES_USER: synapse
      POSTGRES_PASSWORD: ${DB_PASSWORD}
      POSTGRES_DB: synapse
      POSTGRES_INITDB_ARGS: --encoding=UTF-8 --lc-collate=C --lc-ctype=C
    volumes:
      - ./data/postgres:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U synapse -d synapse"]
      interval: 10s
      timeout: 5s
      retries: 5

Introduceți , folosind valoarea aleatorie de la pasul 1. Nu trimiteți acest fișier către controlul sursei. Dacă modificați ulterior versiunea majoră de PostgreSQL, urmați procedura de actualizare a PostgreSQL în loc să indicați pur și simplu o imagine mai nouă către un director de date existent DB_PASSWORD=your-generated-value..env

3. Generați configurația Synapse și selectați PostgreSQL

Generați configurația inițială și cheia de semnare în synapsedirectorul montat. Folosiți același nume de server pe care l-ați ales mai sus. Setați explicit opțiunea pentru statistici; iată-o no.

docker compose run --rm --no-deps \
  -e SYNAPSE_SERVER_NAME=matrix.example.org \
  -e SYNAPSE_REPORT_STATS=no \
  synapse generate

Modul oficial al containerului generatecreează homeserver.yamlși cheia de semnare necesară. Deschideți synapse/homeserver.yamlși înlocuiți secțiunea bazei de date SQLite cu următoarea. Înlocuiți PASTE_THE_SAME_DB_PASSWORD_HEREcu valoarea exactă stocată în .env. Acest câmp este o valoare literală de configurare Synapse, nu o interpolare Compose.

database:
  name: psycopg2
  args:
    user: synapse
    password: PASTE_THE_SAME_DB_PASSWORD_HERE
    dbname: synapse
    host: db
    port: 5432
    cp_min: 5
    cp_max: 10
Vizualizare ilustrativă a editorului homeserver.yaml cu PostgreSQL configurat prin psycopg2, sinapsa bazei de date, baza de date gazdă, portul 5432 și un pool de conexiuni.
Secțiunea bazei de date Synapse indică numele serviciului Compose, db, pe portul intern al PostgreSQL.

Păstrați datele generate registration_shared_secretprivate. Synapse le folosește pentru instrumentul de înregistrare a utilizatorilor din linia de comandă; oricine le obține poate crea conturi, inclusiv administratori. Lăsați înregistrarea publică dezactivată, cu excepția cazului în care intenționați în mod deliberat să o oferiți și ați revizuit controalele de abuz asociate.

4. Porniți Synapse și inspectați jurnalele

Din directorul care conține docker-compose.yml, validați fișierul Compose și porniți serviciile:

docker compose config
docker compose up -d
docker compose ps
docker compose logs --tail=100 synapse db

Prima comandă verifică dacă Compose poate analiza fișierul și îl poate rezolva DB_PASSWORD. Următoarea pornește baza de date și serverul principal în fundal. Verificați jurnalele pentru erori de conexiune la baza de date sau pentru un fișier de configurare lipsă. Deoarece această configurare montează folderele locale prin bind-mount, configurația bazei de date și a Synapse-ului persistă atunci când containerele sunt recreate.

Ilustrație de prompt de terminal cu comanda docker compose up -d introdusă pentru a porni stiva Synapse.
Porniți serviciile Synapse și PostgreSQL după generarea și revizuirea configurației.

5. Verificați endpoint-ul local și creați un cont

Executați solicitarea de versiuni ale clientului Matrix de la gazda Docker. Un răspuns JSON înseamnă că API-ul clientului răspunde; un răspuns gol, un refuz al conexiunii sau o eroare HTTP înseamnă că ar trebui să inspectați jurnalele Synapse și să confirmați că portul 8008 ascultă.

curl -fsS http://127.0.0.1:8008/_matrix/client/versions

După ce răspunde, creați un utilizator inițial în mod interactiv. Această comandă solicită un nume de utilizator și o parolă; alegeți „nu” pentru administrator, cu excepția cazului în care aveți nevoie în mod specific de un cont de administrator.

docker compose exec synapse register_new_matrix_user \
  -c /data/homeserver.yaml http://localhost:8008
Prompt de terminal ilustrativ cu o cerere curl către endpoint-ul versiunilor clientului Matrix al Synapse pe portul localhost 8008.
Un răspuns reușit la endpoint-ul versiunilor confirmă că Synapse răspunde local; acest exemplu de solicitare arată verificarea, nu un rezultat al testului.

Faceți-l accesibil în siguranță

Maparea porturilor localhost-only este intenționată: previne accesul public direct la listenerul HTTP necriptat. Pentru clienții la distanță, configurați un proxy invers cu un certificat TLS valid și redirecționați căile Matrix către Synapse. Proxy-ul trebuie să transmită anteturile X-Forwarded-Forși X-Forwarded-Proto; în configurația listenerului generat, activați x_forwarded: trueportul 8008. Nu setați un listener Synapse containerizat să se lege doar la 127.0.0.1, deoarece acest lucru împiedică un container proxy să îl ajungă. Dacă proxy-ul invers este, de asemenea, containerizat, plasați-l pe acesta și pe Synapse într-o rețea Docker partajată și conectați-l la serviciul name synapse:8008.

Federația este separată de pornirea locală. Alte servere Matrix trebuie să descopere și să ajungă la serverul dvs., de obicei pe portul 8448 sau prin descoperire HTTPS delegată. DNS, rutarea reverse-proxy și orice înregistrări necesare trebuie să corespundă cu numele serverului ales. Urmați documentația și instrucțiunile de instalare.well-known reverse-proxy de la Synapse înainte de a anunța un server public de acasă. Apelurile vocale și video necesită, de asemenea, un server TURN pentru o conectivitate media fiabilă.

Dacă Synapse nu se poate conecta la PostgreSQL, verificați dacă hosteste db(numele serviciului Compose), dacă ambele parole se potrivesc exact și dacă containerul bazei de date este funcțional. Dacă endpoint-ul nu poate fi accesat, verificați docker compose ps, jurnalele Synapse și dacă un alt serviciu utilizează deja portul gazdă 8008. Faceți o copie de rezervă atât a directorului de date PostgreSQL, cât și a cheii de configurare și semnare Synapse; cheia de semnare este esențială pentru identitatea serverului.

Pentru detalii despre configurația PostgreSQL, consultați ghidul PostgreSQL de la Synapse . Pentru opțiunile containerelor și crearea de utilizatori, utilizați documentația oficială Synapse Docker .

Lasă un comentariu

Configurați un alias personalizat pentru camera matricei pe propriul domeniu

Oferă unei camere Matrix o adresă ușor de partajat pe domeniul tău folosind Element sau API-ul Matrix, cu verificări pentru permisiuni, denumire Synapse și federație.

Configurați Coturn pentru apeluri vocale și video Matrix fiabile

Configurați coturn și Synapse cu acreditări TURN corespunzătoare, deschideți porturile de retransmisie necesare și verificați dacă clienții Matrix pot obține candidați de retransmisie.

Implementați Matrix Synapse cu Docker Compose și PostgreSQL

Implementați Matrix Synapse cu Docker Compose și PostgreSQL

Configurați un server de acasă Synapse persistent cu Docker Compose, PostgreSQL, o configurație privată și verificări înainte de expunerea acestuia prin HTTPS.

Personalizați tema și brandingul Element Web

Setați un nume de marcă, culori personalizate și resurse de conectare pentru implementarea Element Web, înțelegând în același timp care părți rămân cu marca Element.

Creșteți limita de fișiere Systemd a Synapse fără a face presupuneri

Creșteți limita de fișiere Systemd a Synapse fără a face presupuneri

Diagnosticați dacă Synapse a atins limita de fișiere deschise per proces, setați un drop-in systemd pentru serviciul sau worker-ul corect și verificați limita de funcționare.

Elementul afișează „Decriptare eșuată”? Restaurați cheia camerei lipsă

Elementul afișează „Decriptare eșuată”? Restaurați cheia camerei lipsă

Află dacă eroarea este limitată la un singur browser sau la un singur eveniment, apoi folosește cheia de recuperare Element sau un dispozitiv de încredere fără a risca istoricul criptat rămas.

Curățați mesajele și fișierele media vechi din sinapse fără a pierde date

Folosește API-urile sau setările de retenție pentru istoric și epurare media ale Synapse pentru a elimina în siguranță datele învechite, apoi verifică finalizarea și recuperarea spațiului pe disc.

Construiți un bot Matrix Echo în Python cu Simple-Matrix-Bot-Lib

Construiți un bot Matrix Echo în Python cu Simple-Matrix-Bot-Lib

Instalați biblioteca curentă, conectați un cont Matrix dedicat și rulați un mic bot !echo cu o gestionare mai sigură a acreditărilor și un test clar.

Conectează Matrix la WhatsApp, Telegram și Discord cu Bridge-uri separate

Conectează Matrix la WhatsApp, Telegram și Discord cu Bridge-uri separate

Configurați trei punți Mautrix cu înregistrări, conectări și teste separate - și evitați surprizele legate de rețelele Docker, politicile de cont și sincronizare.

Recuperați spațiul de pe disc Synapse Media fără a deteriora fișierele partajate

Găsiți ce umple spațiul de stocare Synapse, setați retenția sigură a suporturilor media și goliți memoria cache la distanță fără a șterge fișierele direct de pe disc.