Einrichtung von Standalone Uptime Kuma auf Ubuntu mit einem Reverse-Proxy

Einleitung

Dieses Tutorial beschreibt, wie man eine Uptime Kuma Instanz unter Ubuntu 20.04 einrichtet. Uptime Kuma ist ein freier und quelloffener Uptime-Monitor. Es ist eine selbstgehostete Alternative zu Diensten wie Uptime Robot oder StatusCake. Uptime Kuma ist als Docker-Image verfügbar, aber dieses Tutorial beschreibt, wie man eine Instanz ohne Docker (als Standalone) einrichtet.

Es ist sehr praktisch, benachrichtigt zu werden, wenn ein Dienst ausgefallen ist.

Der Zeitbedarf für dieses Tutorial liegt bei etwa 10 - 20 Minuten.

Das Tutorial wurde auf Ubuntu 22.04 (November 2023) getestet.

Das Tutorial verwendet die Beispiel-IP 123.123.123.123.
Dieser Hostname muss durch den Namen deines eigenen Servers ersetzt werden, wenn du dem in diesem Tutorial beschriebenen Arbeitsablauf folgst.
Wir werden in diesem Lehrgang auch die Domain example.com verwenden. Ersetze diese durch deine eigene Domain.

Wir werden nicht das von Uptime Kuma bereitgestellte Installationsskript verwenden, da es manchmal Fehler verursacht.

Anforderungen

Für eine "kleine Instanz" (bis zu 20 überwachte Dienste) ist ein VPS 200 ausreichend.

Ich empfehle, die Instanz auf einem VPS 200 einzurichten.
Wenn du das Gefühl hast, dass die Instanz zu langsam ist, kannst du jederzeit über das CCP auf einen größeren Server updaten.

Auf dem Server müssen Ubuntu 20.04 und SSH bereits installiert sein.

Außerdem brauchst du eine Domain, wobei eine Domain aus einem Webhosting-Paket ausreicht. (Du kannst die Domain trotzdem mit deinem Webhosting nutzen, da wir eine Subdomain verwenden werden.)

Schritt 1 - IP deines Servers ermitteln

1. Melde dich im SCP (ServerControlPanel) unter https://www.servercontrolpanel.de an.
2. Klicke auf den Server, den du verwenden möchtest.
3. Wenn du dich bereits im Tab "Allgemein" befindest, gibt es unten rechts ein "Netzwerk"-Fenster.
4. Hier kannst du die IP deines Servers finden (unter IPv4).
5. Notiere dir diese Adresse.

Schritt 2 - DNS konfigurieren

1. Melde dich im CCP (CustomerControlPanel) unter https://www.customercontrolpanel.de an.
2. Klicke in der Seitenleiste auf der linken Seite auf "Domains".
3. Suche die gewünschte Domain und klicke auf die Lupe neben der Domain.
4. In dem neuen Fenster klicke auf "DNS".
5. Scrolle nach unten, bis es leere Felder gibt.
6. Schreibe in das erste Feld deinen Subdomain-Namen (ich empfehle "status" oder einen anderen leicht merkbaren Namen).
7. Wähle im Dropdown-Menü "A".
8. In das letzte Feld schreibst du die IP deines Servers (aus Schritt 1).
9. Klicke auf "DNS-Einträge speichern".

Schritt 3 - Server vorbereiten

Zuerst musst du dich über SSH in deinen Server einloggen.

1. Gib sudo -s ein, um Root-Rechte zu erhalten.
2. Gib dein Passwort ein und drücke Enter.
3. Gib nun apt update -y && apt upgrade -y ein, um den Server zu aktualisieren.
4. Falls ein rosafarbenes Fenster erscheint, drücke einmal Enter um fortzufahren.
5. Gib apt install curl nginx git -y ein, um alle benötigte Software zu installieren.
6. Gib adduser uptimekuma --gecos "" --disabled-password && su uptimekuma ein, um einen neuen Benutzer zu erstellen und zu diesem zu wechseln.

Schritt 4 - NodeJS installieren

1. Gib cd && curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash ein, um NVM zu installieren.
2. Gib source ~/.bashrc ein, um alle benötigte Software zu installieren.
3. Gib nvm install 18 && nvm use 18 ein, um NodeJS 18 zu installieren und zu aktivieren.
4. Gib npm install npm pm2 -g && pm2 completion install ein, um pm2 und seine Autovervollständigung zu installieren.

Schritt 5 - Uptime Kuma installieren

Gib den folgenden Befehl ein, um Uptime Kuma zu installieren:

1. Gib git clone https://github.com/louislam/uptime-kuma.git ein, um das Repository zu klonen.
2. Wechsle das Verzeichnis, indem du cd uptime-kuma ausführst.
3. Gib npm run setup ein, um alle Abhängigkeiten zu installieren.
4. Gib npm run start-server ein, um Kuma zu starten.

Sobald du "Listening on 3001" im Terminal siehst, gehe zu deiner IP auf Port 3001 (z.B. 123.123.123.123:3001) in deinem Browser. Wenn du den Einrichtungsbildschirm von Uptime Kuba siehst, hast du Uptime Kuma erfolgreich installiert. Bitte stoppe den Server, indem du einmal Strg + C im Terminal drückst und kurz wartest, bis der Server stoppt.

Schritt 6 - Reverse Proxy mit nginx einrichten

1. Gib exit ein, um Root-Rechte zu erhalten.
2. Wenn du nach deinem Passwort gefragt wirst, gib es ein und drücke Enter.
3. Gib nano /etc/nginx/sites-available/uptimekuma ein, um eine neue nginx-Konfigurationsdatei zu erstellen.
4. Füge den folgenden Code in diese Datei ein:

server  {
    listen 80;
    listen [::]:80;
    server_name    sub.domain.com;
    location / {
        proxy_pass         http://localhost:3001;
        proxy_http_version 1.1;
        proxy_set_header   Upgrade $http_upgrade;
        proxy_set_header   Connection "upgrade";
        proxy_set_header   Host $host;
    }
}

5. Ersetze "sub.domain.com" durch deine Subdomain (z.B. "status.example.com").
6. Verlasse die Datei durch Drücken von Strg + X und dann Y und dann Enter.
7. Gib ln -s /etc/nginx/sites-available/uptimekuma /etc/nginx/sites-enabled/uptimekuma ein, um die Konfigurationsdatei zu aktivieren.
8. Gib nginx -t ein, um die Konfigurationsdatei zu testen.
9. Wenn du siehst, dass Test erfolgreich ist, kannst du nginx neu laden, indem du systemctl reload nginx eingibst.

Schritt 7 - Uptime Kuma zum Starten beim Booten einrichten

Wir wollen Uptime Kuma automatisch starten, wenn der Server startet.
Dies ist nützlich, wenn der Server neu gestartet wird.
Vor allem, weil wir den Server, auf dem Kuma läuft, nicht selbst überwachen können. Wenn er also neu gestartet wird, startet auch Kuma neu.

1. Gib nano /etc/systemd/system/uptimekuma.service ein, um eine neue systemd-Dienstdatei zu erstellen.
2. Füge den folgenden Code in diese Datei ein:

[Unit]
Description=Uptime-Kuma - A free and open source uptime monitoring solution
Documentation=https://github.com/louislam/uptime-kuma
After=network.target

[Service]
Type=simple
User=uptimekuma
WorkingDirectory=/home/uptimekuma/uptime-kuma
ExecStart=/home/uptimekuma/.nvm/versions/node/v18.18.2/bin/node /home/uptimekuma/uptime-kuma/server/server.js
Restart=on-failure

[Install]
WantedBy=multi-user.target

3. Verlasse die Datei, indem du "Strg + X" und dann "Y" und dann "Enter" drückst.
4. Gib systemctl daemon-reload ein, um den systemd-Daemon neu zu laden.
5. Gib systemctl enable uptimekuma ein, um den Dienst zu aktivieren.
6. Gib systemctl start uptimekuma ein, um den Dienst zu starten.

Schritt 8 - HTTPS einrichten

1. Gib snap install --classic certbot ein, um certbot zu installieren.
2. Gib certbot --nginx ein, um das certbot-Setup zu starten.
3. Ich schlage vor, diese Einstellungen zu verwenden:
   1. Gib deine E-Mail-Adresse ein.
   2. Ja (Servicebedingungen)
   3. Nein (Werbung)
   4. Drücke "Enter", um die einzige Option auszuwählen (deine Domain).
   5. Dieser Vorgang kann eine Weile dauern, also bitte hab etwas Geduld.

Schritt 9 - Firewall einrichten

Wir brauchen eine Firewall, um unseren Server vor unerwünschten Verbindungen zu schützen.

Wir werden ufw (Uncomplicated Firewall) verwenden, um die Firewall einzurichten, da sie einfach zu benutzen und zu konfigurieren ist und außerdem auf Ubuntu vorinstalliert ist.

1. Gib ufw allow ssh && ufw allow http && ufw allow https && ufw enable ein um die Firewall einzurichten und zu starten.
2. Drücke zur Bestätigung Y und dann Enter.

Schritt 10 - Uptime Kuma einrichten

1. Öffne deinen Browser und gehe zu deiner Subdomain (z.B. https://status.example.com).
2. Du solltest nun den Uptime Kuma Einrichtungsbildschirm sehen.
3. Gib deinen Benutzernamen und dein Passwort ein und wähle die richtige Sprache aus (beim Benutzernamen wird zwischen Groß- und Kleinschreibung unterschieden).
4. Klicke auf "Erstellen".
5. Klicke in der oberen rechten Ecke auf das Dropdown-Menü und wähle "Einstellungen".
6. Klicke auf der Registerkarte "Allgemein" unter "Primäre Basis-URL" auf "Auto Get", damit die URL automatisch festgelegt wird.

Wenn dies funktioniert, solltest du nun den Server neu starten und überprüfen, ob alles so startet, wie es sollte. Führe dazu "shutdown -r now" aus. Nach der Ausführung des Befehls kannst du die SSH-Verbindung schließen.

Fazit

Nun hast du Uptime Kuma erfolgreich installiert und das Tool so eingerichtet, dass es beim Hochfahren gestartet wird.

Deine Uptime Kuma-Instanz wird von nun an unter deiner Subdomain (z.B. https://status.example.com) verfügbar sein.

Wenn du Uptime-Kuma updaten möchtest, kannst du dem Tutorial Aktualisierung der Uptime Kuma Instanz folgen.
Wenn du Alerts einrichten möchtest, kannst du dem Tutorial Konfigurieren von Echtzeit-Benachrichtigungen mit Uptime Kuma folgen.

Vielen Dank für die Nutzung dieses Tutorials!

Licence

MIT

Copyright (c) 2023 Konstantin Protzen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributor's Certificate of Origin

By making a contribution to this project, I certify that:

1. The contribution was created in whole or in part by me and I have the right to submit it under the licence indicated in the file; or

2. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate licence and I have the right under that licence to submit that work with modifications, whether created in whole or in part by me, under the same licence (unless I am permitted to submit under a different licence), as indicated in the file; or

3. The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

4. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the licence(s) involved.