Installation

Sie erhalten den gepackten build Ordner, den Sie direkt auf ihrem Webserver hosten können.

Ohne zusätzliche Anpassungen ist die Anwendung identisch zum Auslieferungszustand, vgl. demo.terratwin.de (opens in a new tab).

Installation auf Linux Server

Verwenden Sie einen geeigneten Webserver, wie nginx (opens in a new tab) oder Apache (opens in a new tab).

Die aktuelle Version der Dokumentation bezieht sich auf diese beiden Webserver, andere werden bei Bedarf ergänzt.

nginx

Für die Konfiguration können Sie sich auch gerne an der Beispielkonfiguration nginx orientieren.

1. Installieren Sie nginx auf Ihrem Server, falls noch nicht geschehen.
2. Entpacken Sie den build Ordner an einem geeigneten Ort auf Ihrem Server (hier: /usr/share/nginx/html).
3. Konfigurieren Sie in Ihrem Konfigurationsfile (bspw. demo.terratwin.de.conf) einen neuen Server-Block:
   • Setzen Sie root auf den Pfad des entpackten build Ordners (hier: /usr/share/nginx/html).
4. Aktivieren Sie Brotli-Komprimierung für relevante Dateitypen gemäß der nginx-Dokumentation (opens in a new tab).
5. Starten Sie nginx neu, um die Änderungen zu übernehmen.

Testen der Brotli Konfiguration

Über den Befehl curl -I -H 'Accept-Encoding: br' http://ihre-domain.de können Sie die Brotli Komprimierung testen.

Alternativ können Sie das Image kiweeteam/nginx-brotli:latest verwenden, das Brotli bereits aktiviert hat. Weitere Informationen finden Sie im GitHub-Repository (opens in a new tab).

Beispielkonfiguration nginx

server {
    listen 80;
    server_name IhrServerName; # bspw. demo.terratwin.de
 
	# Brotli Konfiguration
    brotli on;
    brotli_comp_level 4;
    brotli_types text/plain text/css application/json application/javascript application/x-javascript text/xml application/xml application/xml+rss text/javascript;
 
    # Redirect HTTP to HTTPS
    return 301 https://$host$request_uri;
}
 
server {
    listen 443 ssl http2;
    server_name IhrServerName;
 
	# Brotli Konfiguration
    brotli on;
    brotli_comp_level 4;
    brotli_types text/plain text/css application/json application/javascript application/x-javascript text/xml application/xml application/xml+rss text/javascript;
 
    # SSL Konfiguration
    ssl_certificate /etc/ssl/certs/cert.pem;
    ssl_certificate_key /etc/ssl/private/key.pem;
 
    location / {
        root /usr/share/nginx/html;
        index index.html index.htm;
        try_files $uri $uri/ =404;
    }
}

Apache

Für die Konfiguration können Sie sich auch gerne an der Beispielkonfiguration Apache orientieren.

1. Installieren Sie Apache auf Ihrem Server, falls noch nicht geschehen.
2. Entpacken Sie den build Ordner an einem geeigneten Ort auf Ihrem Server (hier: /var/www/IhrServerName).
3. Erstellen Sie eine neue virtuelle Host-Konfiguration:
   • Setzen Sie den DocumentRoot auf den Pfad des entpackten build Ordners.
   • Aktivieren Sie Brotli-Komprimierung für relevante Dateitypen.
4. Aktivieren Sie das brotli-Modul gemäß der Apache-Dokumentation (opens in a new tab).
5. Starten Sie Apache neu, um die Änderungen zu übernehmen.

Testen der Brotli Konfiguration

Über den Befehl curl -I -H 'Accept-Encoding: br' http://ihre-domain.de können Sie die Brotli Komprimierung testen.

Beispielkonfiguration Apache

<VirtualHost *:80>
    ServerName IhrServerName # bspw. demo.terratwin.de
    Redirect permanent / https://IhrServerName/
</VirtualHost>
 
<VirtualHost *:443>
    ServerName IhrServerName
 
    DocumentRoot /var/www/IhrServerName
 
    <Directory /var/www/IhrServerName>
        Options -Indexes +FollowSymLinks
        AllowOverride All
        Require all granted
    </Directory>
 
    <IfModule mod_brotli.c>
        BrotliCompressionQuality 6
        AddOutputFilterByType BROTLI_COMPRESS text/html text/plain text/xml text/css text/javascript application/javascript
    </IfModule>
 
    ErrorLog ${APACHE_LOG_DIR}/IhrServerName_error.log
    CustomLog ${APACHE_LOG_DIR}/IhrServerName_access.log combined
 
    # SSL-Konfiguration
    SSLEngine on
    SSLCertificateFile /etc/letsencrypt/live/IhrServerName/fullchain.pem
    SSLCertificateKeyFile /etc/letsencrypt/live/IhrServerName/privkey.pem
</VirtualHost>

Probleme mit Module Deflate

Falls die Brotli Kompression nicht direkt funktioniert, können Sie innerhalb des Blocks folgenden Code hinterlegen:

<IfModule mod_deflate.c>
    # Deaktivieren von gzip für MIME-Typen, die von Brotli gehandhabt werden
    SetEnvIfNoCase Request_URI \.(html|css|js|xml|json)$ no-gzip dont-vary
</IfModule>
 

Installation auf Windows Server (IIS)

1. Entpacken Sie den Ordner build in einem geeigneten Verzeichnis auf Ihrem Server
2. Öffnen Sie den IIS-Manager (Internet Information Services (IIS) Manager)
3. Navigieren Sie zu Default Website und stellen Sie sicher, dass ihre diese an den Port 443 gebunden ist. Alternativ können Sie mit Rechtsklick auf Sites eine Neue Site hinzufügen.
4. Erstellen Sie mit Rechtsklick auf die gewählte Site ein Neues virtuelles Verzeichnis an. Legen Sie den physischen Pfad zum Ordner build fest und für den virtuellen Pfad einen beliebigen Pfad unter der die Terratwin-Instanz unterhalb erreichbar sein soll.
5. Wählen Sie Ihre Site aus und navigieren Sie im Bereich Inhalt zu MIME-Types. Überprüfen Sie, ob der MIME-Type text/markdown mit der Dateiendung .md hinterlegt sind und legen Sie diesen ggf. an.

brotli für IIS konfigurieren

Befolgen Sie die Anleitung von Microsoft (opens in a new tab) zur Konfiguration von brotli für IIS. Beachten Sie, dass im Vorfeld die Rollen Static Content Compression und Dynamic Content Compression installiert sind.