Repository files navigation

This repository contains the database documentation of openITCOCKPIT.By default, openITCOCKPIT supports MySQL or MariaDB as database server.

The database schema is inDBML (Database Markup Language) format.

The latest database documentation is online available athttps://dbdocs.io/community/openITCOCKPITThis version gets frequently updated by the openITCOCKPIT team.

The openITCOCKPIT CLI provides a method to generate a fresh version of the currently used database schema as DBML file.Requires openITCOCKPIT >= 4.4.1

oitc Dbml.generate --se

If preferred you can host your own copy of the documentation usingFoliant

Download a.dbml file from this repository or generate a new one like described above.

git clone https://github.com/it-novum/openITCOCKPIT-dbschema.gitcd openITCOCKPIT-dbschema/foliantdocker-compose buildcp /opt/openitc/frontend/tmp/cli/database.dbml schema.dbml# You can also replace slate with mkdocs if preferreddocker-compose run --rm foliant make site --with slate

docker run --rm -it --name my-apache-app -p 9999:80 -v "$PWD/openITCOCKPIT_database_documentation-$(date +'%Y-%m-%d').slate":/usr/local/apache2/htdocs/ httpd:2.4

Openhttp://127.0.0.1:9999 orhttp://<server-address>:9999 in your Browser.

Foliant also supports other backends like mkdocs.

root@dev-foca:~/openITCOCKPIT-dbschema/foliant# docker-compose run --rm foliant make siteCreating foliant_foliant_run ... donePlease pick a backend from ['aglio', 'mdtopdf', 'mkdocs', 'slate']:

More information can be found in the Foliant documentation:https://foliant-docs.github.io/docs/tutorials/db/dbml/

openITCOCKPIT and it's developers are in no way associated todbdiagram,dbdocs orFoliant