Administrationshandbuch
Dieser Bereich richtet sich an Administratoren, die Semaphore für andere Personen installieren und betreiben. Alles hier setzt Zugriff auf den Server selbst voraus: auf die Konfigurationsdatei, die Umgebungsvariablen, die Kommandozeile oder die Maschine, auf der Semaphore läuft. Die Arbeit, die innerhalb eines Projekts über die Weboberfläche erledigt wird, behandelt das Benutzerhandbuch.
Semaphore ist eine einzelne Go-Binärdatei mit einer Weboberfläche und einer REST-API. Die Daten werden in SQLite, MySQL oder PostgreSQL gespeichert, Zugangsdaten liegen verschlüsselt vor, und Tasks laufen entweder auf dem Server selbst oder auf separaten Runnern. Eine funktionierende Installation läuft damit auf vier Entscheidungen hinaus: wie Sie Semaphore installieren, wo die Datenbank liegt, wie sich Benutzer anmelden und wo Tasks ausgeführt werden.
Einrichten
Alles, was Sie vor dem Start des Servers und rund um ihn konfigurieren.
| Seite | Inhalt |
|---|---|
| Installation | Paketmanager, Docker, Binärdatei, Kubernetes und eine manuelle Einrichtung. |
| Konfiguration | Die Datei config.json, Umgebungsvariablen und jede unterstützte Option. |
| Aktualisieren | Der Wechsel auf eine neuere Version und was Sie vorher prüfen sollten. |
| Reverse-Proxy | Semaphore hinter nginx, Apache oder Caddy betreiben, mit TLS. |
| Sicherheit | Passwort-Hashing, Verschlüsselung von Geheimnissen, Netzwerkhärtung und Task-JWTs. |
| Authentifizierung | Lokale Konten und Zwei-Faktor-Authentifizierung, LDAP und Active Directory sowie Single Sign-on mit zwölf OpenID-Connect-Anbietern. |
| Runner | Tasks auf anderen Maschinen als dem Server ausführen. |
| Hochverfügbarkeit | Mehrere Semaphore-Knoten gegen eine Datenbank betreiben. |
Betreiben
Alles, was Sie auf einem bereits laufenden Server tun.
| Seite | Inhalt |
|---|---|
| CLI | Benutzer, Projekte, Vaults, Runner und Datenbankmigrationen über die Shell verwalten. |
| API | Authentifizierung mit einem Token und programmatische Steuerung von Semaphore. |
| CI/CD-Integration | Semaphore-Tasks aus einer externen Pipeline starten. |
| Protokolle | Serverprotokolle, Task-Protokolle und deren Weiterleitung an andere Systeme. |
| Metriken | Der Prometheus-Endpunkt und die Metriken, die er bereitstellt. |
| Benachrichtigungen | Zustellkanäle für Alerts: E-Mail, Telegram, Slack und andere. |
| Lizenz | Ein Pro- oder Enterprise-Abonnement aktivieren. |
Womit Sie beginnen
Wenn Sie Semaphore zum ersten Mal installieren, lesen Sie Installation und wählen Sie eine Methode, danach Konfiguration, um zu erfahren, wie Optionen übergeben werden. Stellen Sie den Server hinter einen Reverse-Proxy mit TLS, bevor ihn andere nutzen.
Was ein kostenpflichtiges Abonnement zusätzlich bietet, zeigt Editionen.