Zum Inhalt springen

Kaeso auf CapRover ausrollen

Betreiben Sie Kaeso auf Ihrem eigenen CapRover-Server als One-Click-App aus der Vorlage im Repository. Sechs Apps, ein öffentlicher Edge hinter dem nginx von CapRover, und PostgreSQL, ClickHouse und Valkey neben Kaeso.

Veröffentlicht
Lesezeit
3 Min.
Autor
Kaeso Team
Ein tiefer Verlauf aus Orange, Rosa und Violett, in senkrechten Falten wie ein Vorhang, mit warmem Licht in einer Ecke

CapRover (öffnet in einem neuen Tab) installiert Apps aus One-Click-Vorlagen, und Sie können eine eigene einfügen. deploy/caprover/kaeso.yml im Kaeso-Repository ist eine solche Vorlage. Sie legt sechs Apps auf Ihrem CapRover-Server an: einen öffentlichen Edge hinter dem nginx von CapRover, ein privates Gateway und eine private Konsole, und PostgreSQL, ClickHouse und Valkey des Compose-Pakets, alle auf ein Release festgelegt.

Was Sie bekommen

  • kaeso
    Image
    Das Konsolen-Image, das kaeso-edge ausführt
    Erreicht von
    Allen, über nginx auf der Domain der App
  • kaeso-gateway
    Image
    Das Gateway-Image
    Erreicht von
    Dem Edge
  • kaeso-console
    Image
    Das Konsolen-Image
    Erreicht von
    Dem Edge
  • kaeso-postgres, kaeso-clickhouse, kaeso-valkey
    Image
    Die Releases, die das Compose-Paket betreibt
    Erreicht von
    Dem Gateway

Die Namen folgen dem App-Namen, den Sie angeben, hier kaeso. Nur der Edge ist eine Web-App; die anderen sind nur im Overlay-Netz von CapRover erreichbar. Das Gateway meldet sich bei PostgreSQL als kaeso an, dem seine Datenbank gehört, der aber kein Superuser ist. Valkey hält seine Daten innerhalb von 512 MB und verdrängt nie einen Schlüssel.

Das nginx von CapRover hängt an das X-Forwarded-For des Aufrufers an, also liest der Edge X-Real-IP, das nginx setzt, und das Gateway vertraut nur privaten Adressen. Die Vorlage schaltet die WebSocket-Unterstützung für den Edge ein, wodurch nginx mit ihm HTTP/1.1 spricht.

Ausrollen

  1. Erzeugen Sie einen Hauptschlüssel, und bewahren Sie ihn in einem Passwort-Manager auf:

    docker run --rm ghcr.io/logicplanes/kaeso-gateway:0.6.0 master-key generate
  2. Öffnen Sie in CapRover Apps, dann One-Click Apps/Databases, und wählen Sie >> TEMPLATE << am Ende der Liste.

  3. Fügen Sie die Vorlage vom Branch prod ein, der das neueste Release enthält:

    https://raw.githubusercontent.com/logicplanes/kaeso/prod/deploy/caprover/kaeso.yml
  4. Füllen Sie das Formular aus:

    FeldWas einzutragen ist
    App namekaeso, oder ein eigener Name
    Public URLDie Adresse der App unter Ihrer Root-Domain, die das Formular einträgt, oder Ihre eigene Domain
    Master keyDer Schlüssel aus Schritt 1
    PasswordsZufällige, die das Formular einträgt
    Mail transportsmtp, um E-Mails zu senden; log, der Standard, protokolliert nur die Art jeder E-Mail
    Setup email, SMTP host, port, user, password, senderIhr SMTP-Server, falls Sie einen haben
  5. Rollen Sie aus, und warten Sie, bis die Apps angelegt sind. Das Gateway startet neu, bis PostgreSQL und Valkey antworten.

  6. Öffnen Sie die App kaeso, schalten Sie HTTPS und Force HTTPS ein, und verbinden Sie Ihre Domain, wenn die öffentliche URL eine nennt.

  7. Öffnen Sie den Einrichtungslink, um den ersten Benutzer anzulegen. Mit SMTP kommt er an die Einrichtungs-E-Mail-Adresse. Ohne geben Sie ihn auf dem Server aus:

    docker exec $(docker ps --quiet --filter name=srv-captain--kaeso-gateway) kaeso setup-link

Aktualisieren und zurückrollen

Ein Release ändert die Image-Tags in kaeso.yml. Öffnen Sie in jeder der Apps kaeso-gateway, kaeso-console und kaeso den Bereich Deployment und rollen Sie per Image-Name mit dem neuen Tag aus, etwa ghcr.io/logicplanes/kaeso-gateway:0.6.0, das Gateway zuerst. Das Gateway migriert die Datenbanken beim Start, nur vorwärts. Zum Zurückrollen rollen Sie das frühere Tag auf dieselbe Weise aus.

Gut zu wissen

  • CapRover liest aus einer One-Click-App nur einige Compose-Felder. Health-Checks, entzogene Capabilities, ein schreibgeschütztes Root-Dateisystem und Speicherlimits erreichen die Apps nicht, also laufen sie mit den Standards der Images. Wenn Sie die volle Härtung auf Ihrem eigenen Server möchten, bekommen Sie sie mit dem Installationsskript.
  • nginx wartet standardmäßig 60 Sekunden auf eine Antwort. Streams senden Keepalives, aber eine Anfrage ohne Streaming, die länger dauert, bekommt 504. Erhöhen Sie proxy_read_timeout in der nginx-Konfiguration der Edge-App, wenn Sie mehr brauchen.
  • Der Updater von Kaeso läuft hier nicht; Sie rollen jedes Release in CapRover aus.

Was getestet wurde

Die Vorlage lässt sich lesen und nutzt nur Felder, die CapRover liest. Auf einem CapRover-Server wurde sie noch nicht ausgerollt. Wenn Sie es tun, sagen Sie uns, wie es lief.

Nächste Schritte

Von Kaeso Team

Auf dieser Seite

Ihr Gateway.Ihre Request-Logs.

curl -fsSLhttps://kaeso.app/install.sh | sh