Pentru a găzdui un client Element Web personalizat pe Nginx, descărcați o versiune oficială predefinită de Element Web, plasați fișierele sale statice pe serverul web, configurați-l config.jsoncu serverul de acasă Matrix și serviți site-ul prin HTTPS. Nginx nu rulează Element în sine: acesta servește fișierele aplicației browserului, în timp ce aplicația se conectează separat la serverul de acasă Matrix. Folosiți un nume de gazdă diferit pentru client și serverul de acasă, cum ar fi chat.example.comși matrix.example.com.
Acest ghid presupune Debian sau Ubuntu, un server Nginx cu un nume DNS public și un server Matrix existent, accesibil prin HTTPS. Folosește arhiva oficială a versiunilor, nu o versiune de dezvoltare. Documentația actuală a proiectului Element descrie aplicația web implementată ca și conținut static și necesită configurații cheie și adrese URL pentru puncte de intrare pentru a evita memorarea în cache. Verificați notele de lansare și documentația actuală de configurare atunci când alegeți o versiune sau modificați opțiunile.
1. Pregătiți numele de gazdă și serverul
Creați o înregistrare A pentru chat.example.coma indica adresa IPv4 publică a serverului Nginx. Adăugați o înregistrare AAAA numai dacă serverul este accesibil prin IPv6. Permiteți porturile TCP de intrare 80 și 443 prin firewall-ul gazdă și firewall-ul cloud. Confirmați că aceste porturi nu sunt deja ocupate de un alt server web.
Instalați Nginx și creați un director pentru aplicația web:
sudo apt update
sudo apt install nginx
sudo mkdir -p /var/www/element
Pe o altă mașină, deschideți pagina oficială de versiuni Element Web și alegeți o versiune stabilă publicată. Descărcați arhiva web precompilată, apoi transferați arhiva pe server. Evitați să utilizați developramura sau o versiune nocturnă pentru un serviciu public, cu excepția cazului în care intenționați să rulați software de previzualizare.
2. Instalați fișierele statice și setați serverul de acasă
Mai întâi extrageți arhiva versiunii într-un director temporar. Inspectați aspectul de nivel superior al arhivei, apoi copiați fișierele sale web în /var/www/element; păstrați structura directoarelor versiunii. Aspectul pachetului se poate schimba, așa că asigurați-vă că index.html, pachetele i18n, și fișierul de configurare se află acolo unde va indica rădăcina documentului 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
Folosiți directorul care conține index.htmlca sursă atunci când copiați conținutul versiunii în /var/www/element. Dacă arhiva are un director de nivel superior versionat, copiați conținutul acelui director în loc să creați un nivel imbricat suplimentar. Nu înlocuiți o implementare live până când noile fișiere nu sunt complete; o copie incompletă poate lăsa utilizatorii cu pachete JavaScript lipsă.
Copiați versiunile config.sample.jsonîn config.jsondacă arhiva o oferă, apoi editați noul fișier. Elementul necesită o setare implicită de conexiune la serverul de acasă pentru a porni. Forma preferată acceptată este default_server_config, folosind adresa URL de bază a API-ului clientului. Exemplul de mai jos este ilustrativ; înlocuiți adresa URL cu adresa URL reală servită de serverul dvs. de acasă Matrix:
{
"default_server_config": {
"m.homeserver": {
"base_url": "https://matrix.example.com"
}
},
"brand": "Example Chat"
}
Documentația de configurare a Element acceptă și default_server_name, care se bazează pe Matrix .well-knowndiscovery. Folosește-l default_server_configatunci când dorești să specifici direct adresa URL a serverului de domiciliu. Nu pune parole, token-uri de acces, chei de semnare sau alte secrete în acest fișier JSON public. Opțiunea brandmodifică unele etichete ale aplicațiilor; nu este o rebranding completă pentru etichete albe.
3. Configurați Nginx pentru aplicație
Creați un bloc de server Nginx, cum ar fi /etc/nginx/sites-available/element. Înlocuiți domeniul dacă este necesar. Această configurație simplă servește Element ca fișiere statice și trimite căile lipsă către index.html, în timp ce marchează toate răspunsurile pentru revalidare. Această politică conservatoare de cache evită ca utilizatorii să primească un shell de aplicație învechit sau o configurație învechită după o lansare; puteți ajusta memoria cache a resurselor ulterior dacă procesul de implementare păstrează căile fără cache obligatorii ale 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;
}
}
Notele de găzduire web ale Element spun să nu se stocheze în cache /config.*.json, /i18n, /version, sau /index.htmlși recomandă revalidarea browserului la încărcarea paginii. Exemplul se aplică no-cachela orice, ca punct de plecare simplu. De asemenea, include anteturi de securitate recomandate de Element, inclusiv o politică de frame și protecție MIME-sniffing. Dacă definiți deja o Politică de securitate a conținutului în altă parte, integrați-o frame-ancestors 'self'în acea politică în loc să trimiteți politici conflictuale.
Activați site-ul și validați Nginx înainte de a-l reîncărca:
sudo ln -s /etc/nginx/sites-available/element /etc/nginx/sites-enabled/element
sudo nginx -t
sudo systemctl reload nginx
4. Adăugați HTTPS și testați clientul
Elementul ar trebui servit prin HTTPS. După ce DNS-ul se rezolvă la acest server și portul 80 este accesibil, instalați Certbot folosind instrucțiunile actuale pentru distribuția dvs., apoi solicitați și instalați un certificat cu integrarea sa Nginx. Proiectul Certbot documentează fluxul certbot --nginxși verificările de reînnoire; instalarea pachetului diferă în funcție de sistemul de operare, așadar utilizați instrucțiunile Nginx actuale pentru versiunea dvs. Dacă Certbot editează blocul serverului, rulați sudo nginx -tdin nou și confirmați că reînnoirea este programată.
Deschideți https://chat.example.comîntr-o fereastră privată a browserului. Ecranul de conectare Element ar trebui să se încarce fără scripturi sau stiluri lipsă, să afișeze serverul de acasă așteptat și să aibă o pictogramă de lacăt validă în bara de adrese a browserului. Conectați-vă cu un cont de testare și confirmați că browserul poate accesa serverul de acasă. Dacă conectarea eșuează, verificați consola dezvoltatorului browserului și panoul de rețea pentru solicitări blocate, erori de certificat sau un fișier . greșit base_url.
Probleme comune de implementare
- O pagină goală sau pe jumătate încărcată: verificați dacă Nginx
rootindică directorul care conține index.htmlși dacă pachetele și i18ndirectorul au fost copiate odată cu acesta. - Apare serverul de domiciliu greșit: validați sintaxa JSON în
config.jsonși confirmați că fișierul se află la rădăcina web. Dacă configurați un config.chat.example.com.jsonelement specific domeniului, acesta încearcă fișierul respectiv înainte config.json; fișierele nu sunt îmbinate. - Utilizatorii văd setările vechi după o actualizare: asigurați-vă că
index.html, version, i18nși fișierele JSON de configurare nu sunt memorate în cache. Ștergeți sau revalidați memoriile cache ale browserului după modificarea politicii Nginx. - Autentificarea se încarcă, dar cererile API eșuează: verificați dacă adresa URL a serverului de domiciliu este corectă, utilizează HTTPS și este configurată pentru acces prin browser, inclusiv comportamentul CORS adecvat acolo unde este necesar. Elementul de găzduire pe Nginx nu face proxy și nu înlocuiește serverul de domiciliu Matrix.
Pentru o implementare reușită, clientul încarcă pe domeniul personalizat prin HTTPS, configurația sa indică serverul de bază dorit, iar un cont de test se poate conecta fără solicitări de rețea eșuate. Notele de găzduire web Element și documentația indexului Nginx sunt principalele referințe pentru implementarea statică și comportamentul blocurilor de server descrise aici.