Quickstart

Überblick

Fünf Schritte von diesem Ordner bis zum ersten Backup. Ausführliche Erklärungen stehen in 02_INTEGRATION und 03_CONFIG_REFERENCE.

Relevante Dateien:

manage-client/ – der Ordner, der in das Projekt kopiert wird
manage-client/config.sample.php – Vorlage für die Konfiguration
manage-client/bin/manage-client.php – Kommandozeile
manage-client/ui/panel.php – fertige Oberfläche für den Adminbereich

Voraussetzungen: PHP 8.0 oder neuer, die Erweiterung zip (für Updates), Schreibrechte auf dem Datenverzeichnis des Projekts. Weder Composer noch ein Build-Schritt werden benötigt.

1. Ordner kopieren

cp -r manage-client /pfad/zum/projekt/manage-client

Der Ordner liegt üblicherweise direkt im Projektstamm, also neben index.php. Liegt er woanders, muss MANAGE_APP_ROOT angepasst werden.

2. Instanz auf dem Server anlegen

Im Manage-Server unter Instanzen eine neue Instanz anlegen. Direkt danach wird das Token einmalig angezeigt – zusammen mit einem fertigen Konfigurationsblock zum Kopieren. Danach ist das Token nicht mehr abrufbar; es kann nur neu erzeugt werden.

3. Konfiguration anlegen

cd /pfad/zum/projekt/manage-client
cp config.sample.php config.php

Mindestens diese Werte eintragen:

define("MANAGE_SERVER_URL", "https://manage.example.org");
define("MANAGE_INSTANCE",   "mein-projekt-prod");
define("MANAGE_TOKEN",      "…");

Danach festlegen, was gesichert werden soll:

define("MANAGE_BACKUP_SOURCES", [
    ["as" => "data",         "glob" => "data/*.json"],
    ["as" => "data/uploads", "dir"  => "data/uploads"],
]);

config.php gehört nicht ins Repository des Projekts. Siehe 10_SECURITY.

4. Verbindung prüfen

php manage-client/bin/manage-client.php status

Erwartete Ausgabe:

Instanz:           mein-projekt-prod
Server:            https://manage.example.org
Konfiguriert:      ja
Installierte Ver.: v1.0.0
Aktuelles Release: v1.0.0
Update verfügbar:  nein
Lokale Backups:    0

Steht dort Konfiguriert: NEIN oder erscheint ein Fehler, hilft 09_TROUBLESHOOTING.

5. Erstes Backup

php manage-client/bin/manage-client.php backup

Das Archiv liegt danach lokal unter data/manage/backups/ und ist im Manage-Server unter Backups sichtbar.

Weiter

Oberfläche in den Adminbereich einbinden: 02_INTEGRATION
Regelmäßige Backups per Cron: 02_INTEGRATION
Release-Pakete richtig bauen: 06_UPDATE_PACKAGING

01_QUICKSTART.md 2.6 KB História Raw