Dokumentation
Konfigurieren Sie Docusaurus, wenn der Mandant eine eigene Dokumentationsoberfläche veröffentlichen oder betreiben soll.
← Zur Übersicht der Mandanten-Komponenten
Dokumentation
Docusaurus
Veröffentlicht eine eigene Dokumentationsinstanz für den Mandanten.
Direkte Voraussetzungen: APISIX und Zugriff auf das Dokumentationsimage
Inventory-Konfiguration
Relevanter Ausschnitt im Mandantenblock
YAML-Ausschnitt und 5 Parameter
documentation:
enable: true
domain: "docs.example.org"
image_project: "registry.gitlab.com/…/documentation"
image_tag: "latest"
gitlab_user: ""
gitlab_token: ""
shared_documentation: false
public: false
| Parameter | Bedeutung | Erwartete Werte |
|---|---|---|
domain | Öffentlicher Hostname der Dokumentation. | Vollständiger Hostname ohne https:// |
image_project / image_tag | Registry-Pfad und auszurollender Stand. | Container-Registry-Pfad und freigegebener Tag |
gitlab_user / gitlab_token | Zugang für ein privates Image. | Deploy Token oder leer bei öffentlichem Image |
shared_documentation | Nutzt eine Dokumentation gemeinsam über Mandanten hinweg. | true oder false |
public | Erlaubt öffentlichen Zugriff ohne Anmeldung. | true oder false |