oPBWeb Handbuch

Architektur

Mon, 01 Jan 0001 00:00:00 +0000

Zielgruppe: Technische Administration

Überblick

oPBWeb läuft als ein Docker-Compose-Projekt mit dem Namen opbweb. Die Datei docker-compose.yml beschreibt den Produktivbetrieb, docker-compose.dev.yml ergänzt sie für die Entwicklung. Dieses Kapitel zeigt, welche Dienste es gibt, wie sie miteinander verbunden sind und wo welche Daten liegen.

Dienste

Dienst	Container	Image	Aufgabe
frontend	`opbweb-frontend`	`opbweb-frontend:latest` (nginx:stable-alpine)	liefert die Weboberfläche und das Handbuch aus, leitet `/api` an die API weiter; einziger Dienst mit veröffentlichten Ports
api	`opbweb-api`	`opbweb-backend:latest` (python:3.13-slim)	REST-API und WebSocket (FastAPI/uvicorn auf Port 8000), Anmeldung, Datenbankmigrationen beim Start, erstes Administrator-Konto
worker	`opbweb-worker`	`opbweb-backend:latest`	führt alle Jobs aus (arq auf Redis); einziger Dienst, der mit den opsi-Configservern spricht und deren Passwörter entschlüsselt
db	`opbweb-db`	`mariadb:11.4`	alle Anwendungsdaten (Pakete, Versionen, Benutzer, Jobs, Protokoll, Einstellungen)
redis	`opbweb-redis`	`redis:7-alpine`	Job-Warteschlange, Heartbeat des Workers, Status der opsi-Verbindung, Sperrliste abgemeldeter Tokens, Depot-Sperren
garage	`opbweb-garage`	`dxflrs/garage:v2.2.0`	S3-kompatibler Objektspeicher (ein Knoten, Replikationsfaktor 1) für Dateiinhalte und gebaute Pakete
garage-init	`opbweb-garage-init`	`opbweb-garage-init:1.0.0` (alpine:3.21)	richtet bei jedem Start Layout, Zugangsschlüssel `opbweb` und Bucket `packages` ein und beendet sich dann

API und Worker verwenden dasselbe Image; der Worker startet nur mit einem anderen Befehl (./start-worker.sh). Das Image von garage-init trägt auch im Produktivbetrieb das Tag :dev.

Benutzer und Rollen

Mon, 01 Jan 0001 00:00:00 +0000

Rolle: Administrator

Überblick

Unter Benutzer und Rollen verwaltest du alle Konten, die sich an oPBWeb anmelden können. Jedes Konto hat genau eine Rolle, die festlegt, was es in der Oberfläche darf. Neben lokalen Konten, die du selbst anlegst, gibt es Verzeichniskonten aus LDAP, deren Rolle sich aus den Gruppen im Verzeichnis ergibt.

Den Bereich öffnest du über das Symbol Benutzer und Rollen unten in der Aktivitätsleiste. Er hat zwei Reiter: Benutzer (mit der Anzahl der Konten) und Protokoll. Das Protokoll ist im Kapitel Protokoll beschrieben.

Erste Schritte

Mon, 01 Jan 0001 00:00:00 +0000

Rollen: Leser, Packager, Releaser, Administrator

Überblick

Dieses Kapitel zeigt dir, wie du dich anmeldest, wie die Oberfläche von oPBWeb aufgebaut ist und wie du mit der Suche schnell zu Paketen, Dateien und Befehlen springst. Am Ende findest du eine kurze Übersicht über Rollen und den Lebenszyklus eines Pakets.

Anmelden

Öffne oPBWeb im Browser. Ohne gültige Sitzung landest du auf der Anmeldeseite.
Gib deinen Benutzernamen und dein Passwort ein.
Klick auf Anmelden.

Nach der Anmeldung öffnet sich die Paketliste, oder die Seite, die du ursprünglich aufrufen wolltest. Auf der Anmeldeseite kannst du oben in der Ecke schon die Sprache (DE/EN) und Hell/Dunkel umschalten.

Voraussetzungen

Mon, 01 Jan 0001 00:00:00 +0000

Zielgruppe: Technische Administration

Überblick

Dieses Kapitel listet alles, was vor der Installation bereitstehen muss: ein Docker-Host, freie Ports, eine Netzwerkverbindung zum opsi-Configserver und ein technischer opsi-Benutzer. Prüfe die Punkte der Reihe nach, bevor du mit der Installation beginnst.

Host

oPBWeb läuft auf jedem Linux-Host mit Docker. Du kannst den Stack direkt auf dem opsi-Configserver betreiben oder auf einem eigenen Host, der den Configserver per HTTPS erreicht.

Betriebssystem: Linux mit aktuellem Docker Engine.
Docker Compose: das Compose-Plugin (Version 2, Aufruf docker compose). Das alte eigenständige docker-compose (Version 1) reicht nicht, weil die Compose-Datei Funktionen wie Datei-Secrets und service_completed_successfully nutzt.
Bash und OpenSSL: Die Skripte setup-opbweb.sh, start.sh, stop.sh und scripts/init-secrets.sh sind Bash-Skripte, die Secrets werden mit openssl erzeugt.
Git: zum Holen der Quellen.
Speicherplatz: Der Objektspeicher wächst mit den Paketdateien. Plane genug Platz für die Docker-Volumes ein (Datenbank, Objektspeicher). Feste Mindestwerte für CPU, Arbeitsspeicher oder Plattenplatz gibt es nicht; die Container laufen ohne Ressourcenlimits.

Ports

Nach außen öffnet der Stack nur den Frontend-Container. Alle anderen Dienste kommunizieren in internen Docker-Netzen.

Installation

Mon, 01 Jan 0001 00:00:00 +0000

Zielgruppe: Technische Administration

Überblick

Die Installation besteht aus wenigen Schritten: Quellen holen, ./setup-opbweb.sh ausführen (es schreibt die Konfigurationsdatei .env und erzeugt die Secrets), optional ein TLS-Zertifikat ablegen und den Stack starten. Die Images baust du dabei entweder lokal mit ./start.sh --build oder ziehst sie fertig aus einer Registry. Danach prüfst du, ob alle Dienste laufen, und machst mit der Ersteinrichtung in der Oberfläche weiter.

Alle Befehle führst du im Projektverzeichnis auf dem Docker-Host aus. Prüfe vorher die Voraussetzungen .

Konfiguration

Mon, 01 Jan 0001 00:00:00 +0000

Zielgruppe: Technische Administration

Überblick

oPBWeb trennt die Konfiguration in drei Ebenen:

.env im Projektverzeichnis: nicht geheime Einstellungen wie Ports, LDAP-Server, Zeitlimits. Docker Compose liest die Datei und setzt die Werte in docker-compose.yml ein.
secrets/: alle Passwörter und Schlüssel als einzelne Dateien. Sie erreichen die Container als Docker-Secrets und werden nie in der .env abgelegt.
Oberfläche: die Verbindungen zu den opsi-Configservern (URL, technischer Benutzer, Passwort, Stufe, CA-Zertifikat; in der Ansicht Depots) und die Vorgaben für neue Pakete. Diese Einstellungen liegen in der Datenbank, siehe Configserver und Einstellungen für neue Pakete .

Die .env und die fehlenden Secrets erzeugt ./setup-opbweb.sh, siehe Installation . Du kannst die .env danach direkt bearbeiten oder das Skript erneut aufrufen; die vorhandenen Werte sind dann die Vorgaben. Änderungen an .env werden mit dem nächsten ./start.sh wirksam; Docker Compose erzeugt dabei die betroffenen Container neu.

Pakete

Mon, 01 Jan 0001 00:00:00 +0000

Rollen: Leser, Packager, Releaser, Administrator

Überblick

Der Bereich Pakete ist die Startseite von oPBWeb. Hier siehst du alle Pakete mit ihrer neuesten Version, prüfst in den Paketdetails, auf welchen Depots sie installiert sind, und legst neue Pakete an. Als Leser kannst du die Liste und die Details ansehen; Anlegen, Importieren und alle ändernden Aktionen brauchen mindestens die Rolle Packager.

Die Paketliste

Die Tabelle zeigt pro Paket die neueste Version:

Protokoll

Mon, 01 Jan 0001 00:00:00 +0000

Rolle: Administrator

Überblick

Das Protokoll hält fest, wer wann welche wichtige Aktion in oPBWeb ausgelöst hat: Anmeldungen, Änderungen an Konten, Paketen, Depots und Einstellungen. Du findest es unter Benutzer und Rollen im Reiter Protokoll. Nur Administratoren können es lesen.

Einträge lassen sich in der Oberfläche weder ändern noch löschen. Auch wenn du ein Benutzerkonto löschst, bleiben seine Einträge mit dem Benutzernamen erhalten.

Das Protokoll lesen

Configserver

Mon, 01 Jan 0001 00:00:00 +0000

Rolle: Administrator

Überblick

oPBWeb arbeitet mit beliebig vielen opsi-Configservern, zum Beispiel einem Test-, einem Staging- und einem Produktivsystem. Über jeden Configserver liest oPBWeb dessen Depots, installiert Pakete und greift auf /repository, /workbench und /depot zu. Jedes Depot gehört zu genau einem Configserver.

Die Configserver verwaltest du in der Ansicht Depots in der Aktivitätsleiste. Solange kein Configserver eingerichtet ist, funktionieren Depots, Installieren und die Workbench nicht, und die Statusleiste zeigt „Kein Configserver eingerichtet“.

Ersteinrichtung

Mon, 01 Jan 0001 00:00:00 +0000

Rolle: Administrator

Überblick

Nach der Installation ist oPBWeb erreichbar, kennt aber noch keinen opsi-Server und hat nur ein Konto: den ersten Administrator. In der Ersteinrichtung meldest du dich mit diesem Konto an, änderst sein Passwort, verbindest oPBWeb mit einem oder mehreren opsi-Configservern, legst die Stufen der Depots fest und richtest die ersten Benutzer ein.

Du brauchst dafür das Admin-Passwort aus secrets/admin_password.txt, die Zugangsdaten des technischen opsi-Benutzers und einen Shell-Zugang zum Configserver, um den Fingerabdruck des CA-Zertifikats zu prüfen.

LDAP-Anmeldung

Mon, 01 Jan 0001 00:00:00 +0000

Zielgruppe: Technische Administration

Überblick

Neben lokalen Konten kann oPBWeb Benutzer gegen ein LDAP-Verzeichnis oder Active Directory anmelden. Die Rolle in oPBWeb ergibt sich dann aus den Gruppenmitgliedschaften im Verzeichnis. Du konfigurierst die Anbindung über LDAP_*-Variablen in der .env und das Passwort des Dienstkontos in secrets/ldap_bind_password.txt. In der Oberfläche gibt es dafür keine Einstellungen.

So läuft die Anmeldung ab

Gibt es in oPBWeb ein lokales Konto mit dem eingegebenen Benutzernamen, meldet oPBWeb ausschließlich lokal an. Das Verzeichnis wird nicht gefragt, auch wenn das Passwort falsch ist.
Sonst, bei LDAP_ENABLED=true, verbindet sich oPBWeb mit dem Dienstkonto (LDAP_BIND_DN) oder anonym, wenn kein Bind-DN gesetzt ist.
oPBWeb sucht mit LDAP_USER_FILTER unterhalb von LDAP_USER_SEARCH_BASE (leer: LDAP_BASE_DN). Die Suche muss genau einen Eintrag liefern.
Mit dem gefundenen DN und dem eingegebenen Passwort meldet sich oPBWeb als Benutzer an und prüft so das Passwort.
Aus dem Attribut memberOf bestimmt oPBWeb die Rolle (siehe unten). Ohne passende Gruppe gibt es keinen Zugang.
Beim ersten erfolgreichen Login legt oPBWeb das Konto mit der Herkunft „Verzeichnis (LDAP)“ an. Anzeigename (displayName), E-Mail (mail) und Rolle werden bei jeder Anmeldung neu aus dem Verzeichnis übernommen.

Lokale Konten bleiben also immer lokal, auch das erste Administrator-Konto. So kommst du auch bei einem Ausfall des Verzeichnisses noch an oPBWeb heran.

Paket-Editor

Mon, 01 Jan 0001 00:00:00 +0000

Rollen: Leser, Packager, Releaser, Administrator

Überblick

Im Paket-Editor bearbeitest du eine Paketversion: die control-Daten (Produktangaben, Scripte, Abhängigkeiten, Properties), den Changelog und die Dateien des Pakets. Dieses Kapitel beschreibt den Reiter control. Wie du mit Dateien und Scripten arbeitest, steht in Dateien des Pakets und Scripteditor .

Bearbeiten kannst du nur Entwürfe, und nur mit mindestens der Rolle Packager. Als Leser und bei freigegebenen Versionen sind alle Felder gesperrt; ansehen kannst du alles.

Editor öffnen

Du öffnest den Editor auf einem dieser Wege:

Betrieb und Aktualisierung

Mon, 01 Jan 0001 00:00:00 +0000

Zielgruppe: Technische Administration

Überblick

Für den täglichen Betrieb brauchst du zwei Skripte im Projektverzeichnis: start.sh und stop.sh. Dieses Kapitel beschreibt außerdem, wo du Logs und Zustand der Dienste findest, wie du oPBWeb aktualisierst und was du auf der opsi-Seite beachten musst. Alle Befehle führst du im Projektverzeichnis aus.

Stack starten und stoppen

start.sh

./start.sh [--build] [--logs] [--dev | --test] [--lang de|en]

Option	Wirkung
(keine)	startet den Produktiv-Stack (`docker-compose.yml`) mit den vorhandenen Images
`--build`	baut die eigenen Images vor dem Start neu
`--logs`	folgt nach dem Start den Logs aller Container (`logs -f --tail=50`); Strg+C beendet nur die Anzeige
`--dev`	nimmt `docker-compose.dev.yml` hinzu (Entwicklungs-Stack, siehe unten); nur im Klon mit Quellen
`--test`	nimmt `docker-compose.test.yml` hinzu: zwei opsi-Mocks als Configserver Test und Produktion, siehe Testumgebung
`--lang de` bzw. `--lang en`	Sprache der Ausgaben für diesen Aufruf (sonst `OPBWEB_LANG` aus der `.env`)
`-h`, `--help`	zeigt die Hilfe

Ablauf: Das Skript bricht ab, wenn .env fehlt („.env fehlt – bitte ./setup-opbweb.sh ausführen (im Entwickler-Checkout: ./setup-opbweb.sh –dev).“), ruft scripts/init-secrets.sh auf, führt docker compose up -d aus und zeigt mit docker compose ps den Status. Laufende Container, deren Konfiguration sich nicht geändert hat, bleiben dabei unberührt. start.sh holt keine neuen Fremd-Images; dafür siehe Aktualisieren .

Dateien des Pakets

Mon, 01 Jan 0001 00:00:00 +0000

Rolle: Packager

Überblick

Jede Paketversion besteht aus den drei Bereichen OPSI/, CLIENT_DATA/ und SERVER_DATA/. Im Paket-Editor siehst du sie links unter dem Reiter Dateien. Dort legst du Dateien und Ordner an, lädst Installer hoch, benennst um, verschiebst und löschst. Der Reiter Struktur daneben zeigt, welche Scripte welche anderen Scripte einbinden.

Ändern kannst du Dateien nur in einer Version mit dem Status Entwurf und mit mindestens der Rolle Packager. In freigegebenen Versionen und mit der Rolle Leser ist der Dateibaum schreibgeschützt: Öffnen und Herunterladen funktionieren weiterhin, alle ändernden Einträge im Kontextmenü sind ausgegraut.

Einstellungen für neue Pakete

Mon, 01 Jan 0001 00:00:00 +0000

Rolle: Administrator

Überblick

Unter Einstellungen legst du fest, mit welchen Werten neue Pakete und Meta-Pakete starten und welche Mail-Adresse Changelog-Einträge ohne E-Mail bekommen. Die Werte gelten für alle Benutzer. Ändern dürfen sie nur Administratoren.

Die Vorgaben wirken nur beim Anlegen. Bestehende Pakete und importierte Pakete (.opsi oder Workbench) behalten ihre eigenen Werte, und jeder Packager kann die Vorgaben im Paket-Editor überschreiben.

Die Verbindung zu den opsi-Configservern richtest du nicht hier ein, sondern in der Ansicht Depots, siehe Configserver .

Testumgebung

Mon, 01 Jan 0001 00:00:00 +0000

Zielgruppe: Technische Administration, alle, die oPBWeb ausprobieren wollen

Überblick

Die Testumgebung startet oPBWeb zusammen mit zwei nachgebauten opsi-Servern (opsiconfd-Mocks). Damit probierst du den Editor und den ganzen Ablauf aus, vom Import aus der Workbench über das Bauen bis zur Übernahme von Test nach Produktion, ohne einen echten opsi-Server.

Configserver in oPBWeb	Stufe	Depots	Mock-Container
`opsi-test`	Test	`opsi-test.mock` (Configserver), `depot-test.mock`	`opbweb-opsi-mock-test`
`opsi-prod`	Produktion	`opsi-prod.mock` (Configserver), `depot-prod.mock`	`opbweb-opsi-mock-prod`

Die Mocks laufen mit dem Backend-Image von oPBWeb, ihr Code kommt aus tools/opsi-mock/opsi_mock.py. Beides liegt im Klon des Repositorys und im Stack-ZIP . Die Kurzfassung dieser Anleitung steht als START-TEST-ENVIRONMENT_de.md daneben.

Depot-Verwaltung

Mon, 01 Jan 0001 00:00:00 +0000

Rolle: Administrator

Überblick

Welche Depots es gibt, liest oPBWeb von den eingerichteten opsi-Configservern. Jedes Depot gehört zu genau einem Configserver. Als Administrator legst du für jedes Depot fest, in welcher Stufe es läuft, unter welcher Dienst-URL oPBWeb es erreicht und ob es überhaupt verwendet wird (Aktiv). Die Stufe entscheidet, welche Rolle auf dem Depot installieren darf.

Du findest die Einstellungen unter Depots. Die linke Liste ist nach Configservern gegliedert: Jeder Configserver steht als fett gedruckte Zeile, darunter eingerückt seine Depots mit Stufen-Abzeichen und der Zahl der Produkte, beim Depot des Configservers selbst zum Beispiel „Configserver · 120 Produkte“. Zusätze wie „deaktiviert“ oder „nicht mehr vorhanden“ stehen ebenfalls in der zweiten Zeile. Wie du Configserver anlegst und pflegst, steht in Configserver .

Scripteditor

Mon, 01 Jan 0001 00:00:00 +0000

Rolle: Packager

Überblick

Textdateien des Pakets öffnest du per Klick im Dateibaum (siehe Dateien des Pakets ). Sie erscheinen als eigener Reiter neben dem Reiter control im Scripteditor. Für opsi-Scripte bietet der Editor Vervollständigung, Fehlerprüfung, Hilfe zu den Befehlen und Snippets. Alle anderen Textformate bekommen eine Syntaxhervorhebung. Die Farben der Hervorhebung legst du pro Dateityp unter Mein Konto fest.

Bearbeiten kannst du Dateien nur in einer Version mit dem Status Entwurf und mindestens mit der Rolle Packager. Sonst ist der Editor schreibgeschützt; Lesen, Suchen, Hilfe und das Kopieren von Text funktionieren trotzdem.

Sicherung und Wiederherstellung

Mon, 01 Jan 0001 00:00:00 +0000

Zielgruppe: Technische Administration

Überblick

Die Daten von oPBWeb liegen an zwei Stellen, die zusammengehören: In der Datenbank stehen alle Metadaten, im Objektspeicher die Dateiinhalte. Die Datenbank verweist über SHA-256-Prüfsummen und Schlüssel auf Objekte im Speicher (blobs/…, artifacts/…). Eine Sicherung ist nur brauchbar, wenn beide Teile aus demselben Zeitpunkt stammen und die passenden Secrets dabei sind.

Hinweis

Die Befehle in diesem Kapitel sind Beispiele. Die Datenbank-Sicherung mit mariadb-dump und das Sichern der Garage-Volumes bei gestopptem Stack sind der vorgesehene Weg; die konkreten Befehle für Volumes und Wiederherstellung sind daraus abgeleitet. Passe Pfade und Namen an deine Umgebung an und teste die Wiederherstellung, bevor du dich darauf verlässt.

Bauen und verteilen

Mon, 01 Jan 0001 00:00:00 +0000

Rollen: Packager, Releaser

Überblick

Dieses Kapitel beschreibt den Weg einer Paketversion vom Entwurf bis auf die Depots: Bauen erzeugt die .opsi-Datei, Installieren … bringt sie auf ein oder mehrere Depots und gibt die Version dabei frei, Übernehmen … bringt eine getestete Version unverändert auf die Depots der nächsten Stufe. Alle Aktionen findest du in der Werkzeugleiste des Reiters control im Paket-Editor und im Menü ⋯ (Weitere Aktionen).

Bauen, Installieren auf Test- und Staging-Depots und die übrigen Aktionen in diesem Kapitel brauchen mindestens die Rolle Packager. Für produktive Depots ist die Rolle Releaser nötig. Mit der Rolle Leser kannst du gebaute Pakete nur herunterladen.

Fehlersuche

Mon, 01 Jan 0001 00:00:00 +0000

Zielgruppe: Technische Administration

Überblick

Dieses Kapitel ordnet typische Störungen nach Symptom. Zu jedem Symptom findest du die wahrscheinliche Ursache und die Abhilfe. Am Ende steht eine Tabelle mit wichtigen Fehlermeldungen. Die Meldungen des Servers erscheinen in der Sprache der Oberfläche; dieses Kapitel zitiert sie in der deutschen Fassung.

Erste Anlaufstellen

Quelle	Inhalt
Seite Systemstatus	Zustand von Datenbank, Redis, Objektspeicher, Worker und opsi-Server, siehe Systemstatus
Seite Jobs	vollständiges Protokoll jedes Jobs mit Fehlermeldung, siehe Jobs
`docker compose ps -a`	welche Container laufen, welche beendet sind (mit Exit-Code)
`docker logs opbweb-api`	Start, Migrationen, Anmeldung, LDAP
`docker logs opbweb-worker`	Jobs, opsi-Verbindung
`docker logs opbweb-garage-init`	Einrichtung des Objektspeichers
Statusleiste der Oberfläche	„Backend nicht verbunden“, wenn die API nicht antwortet; orangefarbener Hinweis bei Problemen mit dem opsi-Server

Stack startet nicht

Symptom	Ursache	Abhilfe
`start.sh` meldet „.env fehlt – bitte ./setup-opbweb.sh ausführen (im Entwickler-Checkout: ./setup-opbweb.sh –dev).“	keine `.env`	`./setup-opbweb.sh` (oder `cp .env.example .env`)
API startet nicht, Log: „Secret file not found: …“	Secret-Datei fehlt, etwa weil der Stack mit `docker compose` statt mit `./start.sh` gestartet wurde	`./start.sh` verwenden oder `./scripts/init-secrets.sh` ausführen
API beendet sich nach etwa 60 Sekunden, Log: „Database not reachable: …“	MariaDB nicht bereit oder Passwort passt nicht zum Volume	`docker logs opbweb-db` prüfen; bei geändertem `db_password.txt` siehe Konfiguration
api, worker und frontend starten nicht, garage-init mit Exit-Code ungleich 0	Einrichtung des Objektspeichers fehlgeschlagen	`docker logs opbweb-garage-init`; „ERROR: No admin token found“ bedeutet fehlendes `secrets/garage_admin_token.txt`
garage-init meldet dauerhaft „Not ready yet, retrying in 2s…“	Garage startet nicht oder das Admin-Token passt nicht	`docker logs opbweb-garage`; Token in `secrets/` nicht nachträglich ändern
Log der API: „No users and no ADMIN_PASSWORD configured - no initial admin created“	`secrets/admin_password.txt` leer oder fehlt bei leerer Benutzertabelle	Datei füllen bzw. von `init-secrets.sh` anlegen lassen, Stack neu starten

Anmeldung

„Benutzername oder Passwort falsch.“ Bei lokalen Konten zählt jeder Fehlversuch. Nach 5 Fehlversuchen von derselben Adresse ist das Konto für diese Adresse 15 Minuten gesperrt: „Konto gesperrt bis HH:MM Uhr.“ Von anderen Adressen kann sich der Benutzer weiter anmelden; für alle gesperrt wird das Konto erst nach 50 Fehlversuchen. Nach 20 Fehlversuchen von einer Adresse (über alle Konten) antwortet oPBWeb mit „Zu viele fehlgeschlagene Anmeldungen von dieser Adresse.“ Ein Administrator hebt die Sperre unter Benutzer und Rollen mit Sperre aufheben auf; auch Passwort setzen entsperrt das Konto. Siehe Benutzer und Rollen .

Systemstatus

Mon, 01 Jan 0001 00:00:00 +0000

Rolle: Administrator

Überblick

Der Bereich Systemstatus zeigt, ob alle Dienste von oPBWeb laufen, und gibt Administratoren Einblick in die Belegung von Datenbank und Objektspeicher. Du öffnest ihn über das Symbol Systemstatus unten in der Aktivitätsleiste.

Die Tabelle der Dienste sehen alle Rollen. Die Abschnitte Datenbank, Objektspeicher mit Bereinigen … und Bucket-Inhalt sehen nur Administratoren.

Dienste prüfen

In der Werkzeugleiste fasst ein Abzeichen den Zustand zusammen: „Alle Dienste erreichbar“, „Mindestens ein Dienst ist nicht erreichbar“ oder „API nicht erreichbar“. Daneben steht „Stand HH:MM:SS“. Die Tabelle aktualisiert sich alle zehn Sekunden von selbst; mit Aktualisieren lädst du sofort neu.

Build und Auslieferung

Mon, 01 Jan 0001 00:00:00 +0000

Zielgruppe: Technische Administration

Überblick

oPBWeb besteht aus drei eigenen Images: Backend (für api und worker), Frontend (nginx mit Oberfläche und Handbuch) und garage-init. Du baust sie entweder lokal mit ./start.sh --build oder lässt sie von der GitLab-CI bauen und in die Projekt-Registry schieben. Die CI erzeugt außerdem das Handbuch als PDF. Dieses Kapitel beschreibt die Images, die Pipeline und wie du das Handbuch lokal baust.

Images

Alle Dockerfiles verwenden das Projektverzeichnis als Build-Kontext. .dockerignore hält unter anderem secrets/, certs/, .env, node_modules/ sowie die Hugo-Ausgaben und manual/.doc-state/ aus dem Kontext heraus.

Snippets

Mon, 01 Jan 0001 00:00:00 +0000

Rollen: Leser, Packager, Releaser, Administrator

Überblick

Snippets sind Textbausteine für opsi-script, die du im Scripteditor per Doppelklick, Autovervollständigung oder Kontextmenü einfügst. Die Ansicht Snippets in der Aktivitätsleiste ist der Ort, an dem du sie verwaltest: Kategorien anlegen, Snippets schreiben und testen, Dateien importieren und exportieren.

Leser sehen alle Snippets, können aber nichts ändern. Ab der Rolle Packager legst du eigene Snippets an und pflegst die gemeinsamen Kategorien.

Globale und eigene Snippets

Jedes Snippet hat eine Sichtbarkeit:

Depots

Mon, 01 Jan 0001 00:00:00 +0000

Rollen: Leser, Packager, Releaser, Administrator

Überblick

Die Ansicht Depots zeigt alle opsi-Configserver, die in oPBWeb eingerichtet sind, und ihre Depots so, wie oPBWeb sie zuletzt gelesen hat. Du siehst, welche Produkte in welcher Version installiert sind, räumst das Repository auf, bearbeitest Dateien direkt auf dem Server und vergleichst die Depots untereinander.

Leser sehen alles, können aber nichts verändern. Was Packager und Releaser auf einem Depot ändern dürfen, hängt von dessen Stufe ab (siehe Stufen und Rollen ). Configserver hinzufügen, bearbeiten und entfernen können nur Administratoren, siehe opsi-Server .

Jobs

Mon, 01 Jan 0001 00:00:00 +0000

Rollen: Leser, Packager, Releaser, Administrator

Überblick

Alles, was länger dauert oder mit einem opsi-Server spricht, führt oPBWeb als Job im Hintergrund aus. Du startest die Aktion, arbeitest weiter und verfolgst den Fortschritt in der Statusleiste, im Paket-Editor oder in der Ansicht Jobs.

Alle Benutzer sehen alle Jobs, auch die der Kollegen, samt Protokoll. So lässt sich nachvollziehen, wer wann was gebaut oder verteilt hat.

Welche Aktionen laufen als Job?

Aktion	Anzeige in der Spalte Aktion
`.opsi`-Paket importieren	Import
Bauen	Bauen
Installieren …, Übernehmen … auf andere Stufe	Installieren
Deinstallieren …	Deinstallieren
Abgleichen der Depots (ein Configserver oder alle)	Depot-Abgleich
Bereinigen … des Objektspeichers (nur Administratoren)	Bereinigung
Workbench einlesen, importieren, exportieren	technischer Name, z. B. `scan_workbench`, `import_workbench`, `import_workbench_many` (Import mehrerer Projektordner), `export_workbench`
Mit Workbench abgleichen …: vergleichen, übernehmen	`compare_workbench`, `apply_workbench`
Repository lesen, Repository-Dateien löschen	`list_repository`, `delete_repository_files`
Produkte entsperren	`unlock_products`
Dateien im Tab Dateien der Depots hoch- und herunterladen	`files_upload`, `files_download`
CA-Zertifikat holen, Verbindung testen (nur Administratoren)	`fetch_opsi_ca`, `check_opsi_server`

Nur die ersten sechs Aktionen haben einen übersetzten Namen; alle anderen erscheinen mit ihrem technischen Namen. Titel und Protokollzeilen der Jobs kommen vom Server und erscheinen in der Sprache der Oberfläche. Jobs, die vor Version 0.15.0 entstanden sind, behalten ihre deutschen Titel und Protokollzeilen.

Konto und Sprache

Mon, 01 Jan 0001 00:00:00 +0000

Rollen: Leser, Packager, Releaser, Administrator

Überblick

Die Einstellungen zu deinem eigenen Konto erreichst du über das Avatar-Symbol mit deinen Initialen ganz rechts in der Kopfleiste. Daneben findest du in der Kopfleiste die Umschalter für Sprache und Hell-/Dunkel-Darstellung sowie den Zugang zu diesem Handbuch.

Diese Funktionen stehen allen Benutzern zur Verfügung, unabhängig von der Rolle.

Das Benutzermenü

Klick auf das Avatar-Symbol, um das Benutzermenü zu öffnen.