tibi-docs/README.md

21 lines
1.2 KiB
Markdown
Raw Normal View History

2022-11-02 07:40:25 +01:00
# TibiCMS Dokumentation
2022-11-03 11:05:44 +01:00
Anleitung zum *TibiCMS* (*tibi-server* und *tibi-admin*)
2022-11-02 07:40:25 +01:00
## Einleitung
2022-11-03 11:05:44 +01:00
*TibiCMS* ist der Sammelbegriff für die Komponenten *tibi-server* und *tibi-admin*, welche einen Rest-API Server und eine Administrationsoberfläche zur Verfügung stellen. Auf Basis dieser beiden Komponenten und der *MongoDB* als Abhängigkeit lassen sich WebCMS Anwendungen abbilden.
2022-11-02 07:40:25 +01:00
Das CMS ist multi-mandanten-fähig, d.h. es kann mehrer Projekte mit unterschiedlichen Zugriffsbeschränkungen verwalten.
### tibi-server
2022-11-03 11:05:44 +01:00
Der Server selbst kommt ohne grafische Oberfläche oder WebUI. Er ist ausschließlich nach außen über eine Rest-API erreichbar.
2022-11-02 07:40:25 +01:00
2022-11-03 11:05:44 +01:00
Als einzige Abhängigkeit ist eine *MongoDB* zu erwähnen. Da der Server in Go geschrieben ist, sind keine externen Bibliotheken notwendig. Er lässt sich daher prima via Docker-Container verteilen.
2022-11-02 07:40:25 +01:00
### tibi-admin
2022-11-03 11:05:44 +01:00
Die Administrationsoberfläche ist wie jeder andere Service, der die Rest-API des Servers nutzt, nur ein Frontend. *tibi-admin* läuft vollständig im Browser und benötigt nur einen Webserver, der statischen Content ausliefert.
2022-11-02 07:40:25 +01:00
2022-11-03 11:05:44 +01:00
Die Version des *tibi-admin* sollte synchron zur *tibi-server* Version gehalten werden, damit alle Datentypen bedient werden können.