Aby hostować niestandardowego klienta Element Web na Nginx, pobierz oficjalną, gotową wersję Element Web, umieść jej pliki statyczne na swoim serwerze WWW, skonfiguruj ją config.jsonna serwerze domowym Matrix i udostępnij witrynę przez HTTPS. Nginx nie uruchamia samego Element: udostępnia pliki aplikacji przeglądarki, podczas gdy aplikacja łączy się z serwerem domowym Matrix oddzielnie. Użyj innej nazwy hosta dla klienta i serwera domowego, na przykład " chat.example.comi" matrix.example.com.
W tym przewodniku założono, że korzystasz z systemu Debian lub Ubuntu, serwera Nginx z publiczną nazwą DNS oraz istniejącego serwera domowego Matrix dostępnego przez HTTPS. Wykorzystuje on oficjalne archiwum wydań, a nie kompilację rozwojową. Aktualna dokumentacja projektu Element opisuje wdrożoną aplikację internetową jako zawartość statyczną i wymaga kluczowej konfiguracji oraz adresów URL punktów wejścia, aby uniknąć buforowania. Przed wyborem wydania lub zmianą opcji zapoznaj się z informacjami o wydaniu i aktualną dokumentacją konfiguracji.
1. Przygotuj nazwę hosta i serwer
Utwórz rekord A chat.example.comwskazujący na publiczny adres IPv4 serwera Nginx. Dodaj rekord AAAA tylko wtedy, gdy serwer jest dostępny przez IPv6. Zezwól na przychodzące porty TCP 80 i 443 przez zaporę hosta i zaporę chmurową. Upewnij się, że te porty nie są już zajęte przez inny serwer WWW.
Zainstaluj Nginx i utwórz katalog dla aplikacji internetowej:
sudo apt update
sudo apt install nginx
sudo mkdir -p /var/www/element
Na innym komputerze otwórz oficjalną stronę Element Web Releases i wybierz opublikowaną wersję stabilną. Pobierz jej wstępnie skompilowane archiwum webowe, a następnie przenieś je na serwer. Unikaj korzystania z developgałęzi lub kompilacji nocnej dla usługi publicznej, chyba że zamierzasz uruchamiać oprogramowanie w wersji zapoznawczej.
2. Zainstaluj pliki statyczne i skonfiguruj serwer domowy
Najpierw rozpakuj archiwum wydania do katalogu tymczasowego. Sprawdź układ najwyższego poziomu archiwum, a następnie skopiuj jego pliki webowe do /var/www/element; zachowaj strukturę katalogów wydania. Układ pakietu może się zmienić, więc upewnij się index.html, że , pakiety i18n, i plik konfiguracyjny trafią tam, gdzie wskazuje katalog główny dokumentów 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
Użyj katalogu zawierającego index.htmljako źródło podczas kopiowania zawartości wydania do /var/www/element. Jeśli archiwum ma jeden katalog najwyższego poziomu z wersjonowaną wersją, skopiuj zawartość tego katalogu, zamiast tworzyć dodatkowy poziom zagnieżdżenia. Nie zastępuj wdrożenia na żywo, dopóki nowe pliki nie zostaną ukończone; niekompletna kopia może spowodować brak pakietów JavaScript u użytkowników.
Skopiuj plik wydania config.sample.json, config.jsonjeśli archiwum go udostępnia, a następnie edytuj nowy plik. Element wymaga domyślnego ustawienia połączenia z serwerem domowym, aby uruchomić. Preferowaną, obsługiwaną formą jest default_server_config, używając podstawowego adresu URL interfejsu API klienta. Poniższy przykład jest ilustratywny; zastąp adres URL rzeczywistym adresem URL obsługiwanym przez serwer domowy Matrix:
{
"default_server_config": {
"m.homeserver": {
"base_url": "https://matrix.example.com"
}
},
"brand": "Example Chat"
}
Dokumentacja konfiguracji Elementu obsługuje również default_server_name, który opiera się na .well-knownwykrywaniu Matrix. Użyj default_server_configtej opcji, aby bezpośrednio określić adres URL serwera domowego. Nie umieszczaj haseł, tokenów dostępu, kluczy podpisu ani innych poufnych informacji w tym publicznym pliku JSON. Ta brandopcja zmienia niektóre etykiety aplikacji; nie jest to pełny rebranding białej etykiety.
3. Skonfiguruj Nginx dla aplikacji
Utwórz blok serwera Nginx, taki jak /etc/nginx/sites-available/element. W razie potrzeby zastąp domenę. Ta prosta konfiguracja obsługuje Element jako pliki statyczne i wysyła brakujące ścieżki do index.html, jednocześnie oznaczając wszystkie odpowiedzi do ponownej walidacji. Ta konserwatywna polityka buforowania zapobiega otrzymywaniu przez użytkowników nieaktualnej powłoki aplikacji lub nieaktualnej konfiguracji po wydaniu; możesz później dostosować buforowanie zasobów, jeśli proces wdrażania zachowuje wymagane ścieżki no-cache Elementu.
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;
}
}
Notatki Element dotyczące hostingu zalecają, aby nie buforować /config.*.json, /i18n, /version, lub /index.htmli zalecają ponowną walidację przeglądarki podczas ładowania strony. Przykład ten ma zastosowanie no-cachedo wszystkiego i stanowi prosty punkt wyjścia. Zawiera również nagłówki bezpieczeństwa zalecane przez Element, w tym politykę ramek i ochronę przed podsłuchiwaniem MIME. Jeśli polityka bezpieczeństwa treści została już zdefiniowana gdzie indziej, należy ją frame-ancestors 'self'z nią połączyć, zamiast wysyłać sprzeczne polityki.
Włącz witrynę i sprawdź poprawność Nginx przed ponownym załadowaniem:
sudo ln -s /etc/nginx/sites-available/element /etc/nginx/sites-enabled/element
sudo nginx -t
sudo systemctl reload nginx
4. Dodaj HTTPS i przetestuj klienta
Element powinien być obsługiwany przez HTTPS. Gdy DNS zostanie przekierowany na ten serwer i port 80 będzie dostępny, zainstaluj Certbota zgodnie z aktualnymi instrukcjami dla swojej dystrybucji, a następnie zażądaj i zainstaluj certyfikat z integracją z Nginx. Projekt Certbot dokumentuje certbot --nginxprzepływ i sprawdzanie odnowienia; instalacja pakietu różni się w zależności od systemu operacyjnego, dlatego należy skorzystać z aktualnych instrukcji Nginx dla swojej wersji. Jeśli Certbot edytuje blok serwera, uruchom go sudo nginx -tponownie i upewnij się, że odnowienie jest zaplanowane.
Otwórz https://chat.example.comw prywatnym oknie przeglądarki. Ekran logowania Element powinien załadować się bez żadnych brakujących skryptów ani stylów, wyświetlać oczekiwany serwer domowy i mieć prawidłową ikonę kłódki na pasku adresu przeglądarki. Zaloguj się na konto testowe i sprawdź, czy przeglądarka może połączyć się z serwerem domowym. Jeśli logowanie się nie powiedzie, sprawdź konsolę programisty przeglądarki i panel sieciowy pod kątem zablokowanych żądań, błędów certyfikatów lub nieprawidłowego pliku base_url.
Typowe problemy z wdrażaniem
- Pusta lub w połowie załadowana strona: sprawdź, czy Nginx
rootwskazuje na katalog zawierający index.html, a także czy pakiety i i18nkatalog zostały skopiowane wraz z nim. - Pojawia się nieprawidłowy serwer domowy: sprawdź składnię JSON
config.jsoni upewnij się, że plik znajduje się w katalogu głównym witryny. Jeśli skonfigurujesz plik specyficzny dla domeny config.chat.example.com.json, Element wypróbuje ten plik przed config.json; pliki nie zostaną scalone. - Użytkownicy widzą stare ustawienia po aktualizacji: upewnij się , że pliki JSON
index.html, version, i18ni konfiguracji nie są buforowane. Wyczyść lub ponownie zatwierdź pamięć podręczną przeglądarki po zmianie polityki Nginx. - Logowanie się ładuje, ale żądania API nie powiodły się: sprawdź, czy adres URL serwera domowego jest poprawny, korzysta z protokołu HTTPS i jest skonfigurowany do dostępu przez przeglądarkę, w tym do odpowiedniego działania CORS, jeśli jest to wymagane. Hosting Element na Nginx nie obsługuje serwera domowego Matrix ani nie zastępuje go.
Aby wdrożenie przebiegło pomyślnie, klient ładuje się w domenie niestandardowej przez HTTPS, jego konfiguracja wskazuje na docelowy serwer domowy, a konto testowe może się zalogować bez nieudanych żądań sieciowych. Notatki Element dotyczące hostingu internetowego oraz dokumentacja indeksu Nginx stanowią podstawowe źródła informacji na temat statycznego wdrożenia i zachowania bloku serwera opisanego tutaj.