Ospita Element Web su Nginx con un Homeserver personalizzato

Per ospitare un client Element Web personalizzato su Nginx, scarica una versione ufficiale precompilata di Element Web, posiziona i suoi file statici sul tuo server web, configuralo config.jsoncon il tuo homeserver Matrix e servi il sito tramite HTTPS. Nginx non esegue Element direttamente: serve i file dell'applicazione browser, mentre l'applicazione si connette separatamente al tuo homeserver Matrix. Utilizza un hostname diverso per il client e l'homeserver, ad esempio chat.example.come matrix.example.com.

Questa guida presuppone l'utilizzo di Debian o Ubuntu, un server Nginx con un nome DNS pubblico e un homeserver Matrix esistente raggiungibile tramite HTTPS. Utilizza l'archivio di rilascio ufficiale anziché una build di sviluppo. La documentazione attuale del progetto Element descrive l'applicazione web distribuita come contenuto statico e richiede la configurazione di URL chiave e punti di ingresso per evitare la memorizzazione nella cache. Consultare le note di rilascio e la documentazione di configurazione corrente quando si sceglie una versione o si modificano le opzioni.

1. Preparare il nome host e il server

Crea un record A che chat.example.compunti all'indirizzo IPv4 pubblico del server Nginx. Aggiungi un record AAAA solo se il server è raggiungibile tramite IPv6. Consenti il ​​traffico in entrata sulle porte TCP 80 e 443 attraverso il firewall dell'host e il firewall del cloud. Verifica che queste porte non siano già occupate da un altro server web.

Installa Nginx e crea una directory per l'applicazione web:

sudo apt update
sudo apt install nginx
sudo mkdir -p /var/www/element

Su un'altra macchina, apri la pagina ufficiale delle release di Element Web e scegli una release stabile pubblicata. Scarica l'archivio web precompilato, quindi trasferiscilo sul server. Evita di utilizzare il developbranch o una nightly build per un servizio pubblico, a meno che tu non intenda eseguire un software di anteprima.

2. Installa i file statici e configura l'homeserver

Innanzitutto, estrai l'archivio della release in una directory temporanea. Esamina la struttura di directory di livello superiore dell'archivio, quindi copia i suoi file web al suo interno /var/www/element; preserva la struttura di directory della release. La struttura del pacchetto può cambiare, quindi assicurati index.htmlche i bundle, i18ne il file di configurazione si trovino nella posizione a cui punterà la directory radice di Nginx.

sudo mkdir -p /tmp/element-release
tar -xzf /tmp/element-web-REPLACE_WITH_RELEASE.tar.gz -C /tmp/element-release
find /tmp/element-release -maxdepth 2 -name index.html

Utilizzare la directory contenente index.htmlcome origine quando si copiano i contenuti della release in /var/www/element. Se l'archivio ha una directory di primo livello con versione, copiare il contenuto di tale directory anziché creare un ulteriore livello annidato. Non sostituire un'implementazione in produzione finché i nuovi file non sono completi; una copia incompleta può lasciare gli utenti con bundle JavaScript mancanti.

Copia il file della release config.sample.jsonse config.jsonl'archivio lo fornisce, quindi modifica il nuovo file. Element necessita di un'impostazione di connessione predefinita per l'homeserver per iniziare. Il formato preferito supportato è default_server_config, utilizzando l'URL di base dell'API client. L'esempio seguente è illustrativo; sostituisci l'URL con l'URL effettivo fornito dal tuo homeserver Matrix:

{
  "default_server_config": {
    "m.homeserver": {
      "base_url": "https://matrix.example.com"
    }
  },
  "brand": "Example Chat"
}

La documentazione di configurazione di Element supporta anche default_server_name, che si basa sul .well-knownrilevamento di Matrix. Usa default_server_configquando vuoi specificare direttamente l'URL del server principale. Non inserire password, token di accesso, chiavi di firma o altri segreti in questo file JSON pubblico. L' brandopzione modifica alcune etichette dell'app; non si tratta di un rebranding white-label completo.

3. Configurare Nginx per l'applicazione

Crea un blocco server Nginx come /etc/nginx/sites-available/element. Sostituisci il dominio se necessario. Questa semplice configurazione serve Element come file statici e invia i percorsi mancanti a index.html, contrassegnando tutte le risposte per la rivalidazione. Questa politica di cache conservativa evita che gli utenti ricevano una shell dell'app o una configurazione obsolete dopo un rilascio; puoi ottimizzare la cache delle risorse in seguito se il tuo processo di distribuzione preserva i percorsi senza cache richiesti da Element.

server {
    listen 80;
    listen [::]:80;
    server_name chat.example.com;

    root /var/www/element;
    index index.html;

    location / {
        try_files $uri $uri/ =404;
        add_header Cache-Control "no-cache" always;
        add_header X-Frame-Options SAMEORIGIN always;
        add_header X-Content-Type-Options nosniff always;
        add_header Content-Security-Policy "frame-ancestors 'self'" always;
    }
}

Le note di Element sull'hosting web sconsigliano di memorizzare nella cache /config.*.json, /i18n, /version, o /index.html, e raccomandano la convalida del browser al caricamento della pagina. L'esempio si applica no-cachea tutto come punto di partenza semplice. Include anche le intestazioni di sicurezza consigliate da Element, tra cui una policy sui frame e la protezione contro il MIME sniffing. Se hai già definito una Content Security Policy altrove, uniscila frame-ancestors 'self'a quella policy invece di inviare policy in conflitto.

Abilita il sito e verifica Nginx prima di ricaricarlo:

sudo ln -s /etc/nginx/sites-available/element /etc/nginx/sites-enabled/element
sudo nginx -t
sudo systemctl reload nginx

4. Aggiungere HTTPS e testare il client

L'elemento deve essere servito tramite HTTPS. Una volta che il DNS risolve questo server e la porta 80 è raggiungibile, installa Certbot seguendo le istruzioni correnti per la tua distribuzione, quindi richiedi e installa un certificato con la sua integrazione Nginx. Il progetto Certbot documenta il certbot --nginxflusso e i controlli di rinnovo; l'installazione del pacchetto varia a seconda del sistema operativo, quindi usa le istruzioni Nginx correnti per la tua versione. Se Certbot modifica il blocco server, esegui sudo nginx -tnuovamente il comando e verifica che il rinnovo sia pianificato.

Apri https://chat.example.comin una finestra di navigazione privata. La schermata di accesso di Element dovrebbe caricarsi senza script o stili mancanti, mostrare il tuo homeserver previsto e avere un'icona di lucchetto valida nella barra degli indirizzi del browser. Accedi con un account di prova e verifica che il browser possa raggiungere l'homeserver. Se l'accesso non riesce, controlla la console per sviluppatori del browser e il pannello di rete per richieste bloccate, errori di certificato o un base_url.

Problemi comuni di distribuzione

  • Una pagina vuota o caricata solo parzialmente: verifica che Nginx rootpunti alla directory contenente index.htmle che i bundle e i18nla directory siano stati copiati insieme ad essa.
  • Viene visualizzato il server home errato: convalida la sintassi JSON config.jsone conferma che il file si trovi nella directory principale del sito web. Se si configura un file specifico per il dominio config.chat.example.com.json, Element prova quel file prima di config.json; i file non vengono uniti.
  • Gli utenti visualizzano le vecchie impostazioni dopo un aggiornamento: assicurarsi che index.html, version, i18n, e il JSON di configurazione non siano memorizzati nella cache. Cancellare o convalidare nuovamente le cache del browser dopo aver modificato la policy di Nginx.
  • La pagina di login si carica ma le richieste API falliscono: verificare che l'URL del server principale sia corretto, che utilizzi HTTPS e che sia configurato per l'accesso tramite browser, incluso il comportamento CORS appropriato ove richiesto. Hosting Element su Nginx non funge da proxy né sostituisce il server principale di Matrix.

Per una corretta implementazione, il client si carica sul dominio personalizzato tramite HTTPS, la sua configurazione punta al server di destinazione e un account di test può accedere senza errori di rete. Le note sull'hosting web di Element e la documentazione sull'indicizzazione di Nginx sono i principali riferimenti per l'implementazione statica e il comportamento del blocco server descritti in questo documento.

Lascia un commento

Esegui Mjölnir come bot di moderazione per le stanze Matrix con Docker

Esegui Mjölnir come bot di moderazione per le stanze Matrix con Docker

Configura Mjölnir con un account Matrix dedicato, una sala di gestione crittografata, Docker Compose, un elenco di policy e controlli di autorizzazione.

Attiva la sincronizzazione nativa dello scorrimento della matrice per un caricamento più rapido sui dispositivi mobili.

Attiva la sincronizzazione nativa dello scorrimento della matrice per un caricamento più rapido sui dispositivi mobili.

Ignora il proxy obsoleto e configura Sliding Sync, la funzione integrata di Synapse. Verifica il rilevamento dei client, quindi misura il caricamento dell'elenco delle stanze e il comportamento di riconnessione su un telefono compatibile.

Ospita Element Web su Nginx con un Homeserver personalizzato

Distribuisci Element Web come sito statico, puntalo al tuo homeserver Matrix, aggiungi HTTPS e configura Nginx per servire gli aggiornamenti senza file obsoleti.

Eseguire un server domestico Matrix leggero su Raspberry Pi 4

Configura Conduit su un Raspberry Pi 4 a 64 bit con dati persistenti, federazione HTTPS, registrazione protetta e verifica del corretto funzionamento dell'homeserver.

Configura un alias personalizzato per una stanza Matrix sul tuo dominio

Assegna a una stanza Matrix un indirizzo facile da condividere sul tuo dominio utilizzando Element o l'API Matrix, con controlli per le autorizzazioni, la denominazione Synapse e la federazione.

Configura coturn per chiamate vocali e video Matrix affidabili.

Configurare coturn e Synapse con le credenziali TURN corrispondenti, aprire le porte relay necessarie e verificare che i client Matrix possano ottenere i candidati relay.

Distribuisci Matrix Synapse con Docker Compose e PostgreSQL

Distribuisci Matrix Synapse con Docker Compose e PostgreSQL

Configura un server domestico Synapse persistente con Docker Compose, PostgreSQL, una configurazione privata ed effettua i controlli necessari prima di esporlo tramite HTTPS.

Personalizza il tema e l'immagine coordinata di Element Web

Imposta un nome personalizzato, colori e elementi di accesso per la tua implementazione di Element Web, tenendo presente quali parti rimangono a marchio Element.

Aumenta il limite di file di Systemd in Synapse senza dover fare supposizioni.

Aumenta il limite di file di Systemd in Synapse senza dover fare supposizioni.

Diagnostica se Synapse ha raggiunto il limite di file aperti per processo, imposta un comando systemd specifico per il servizio o il worker corretto e verifica il limite effettivo.

Element mostra "Decrittazione non riuscita"? Ripristina la chiave della stanza mancante

Element mostra "Decrittazione non riuscita"? Ripristina la chiave della stanza mancante

Scopri se l'errore è limitato a un singolo browser o a un singolo evento, quindi utilizza la chiave di ripristino di Element o un dispositivo attendibile senza rischiare di perdere la cronologia crittografata rimanente.