Docker

The recommended and easiest way to get started is with Docker.

docker-compose

Pre-requisite: You have either docker-compose or Docker Desktop installed

1. Create a directory docgraf
   1. Inside this folder create a docker-compose.yaml file in the directory
   2. Also create a configuration.local.json file in the directory.
2. Edit the config file to set your Grafana host and Service Account token
3. Open a terminal in this folder
4. Run: docker-compose pull && docker-compose up -d

You can learn more about customizing your configuration over in the Configuration Section.

Docker Daemon

It is recommened to run DocGraf against a docker proxy like the provided tecnativa/docker-socket-proxy.

Repositories

DockerHub

docker run -v /full/path/to/configuration.local.json:/app/configuration.local.json -v /full/path/to/output:/app/output philosowaffle/docgraf:stable

GitHub Package

docker run -v /full/path/to/configuration.local.json:/app/configuration.local.json -v /full/path/to/output:/app/output ghcr.io/philosowaffle/docgraf:stable

Tags

1. stable - Always points to the latest release
2. latest - The bleeding edge of the master branch, breaking changes may happen
3. X.Y.Z - For using a specific released version

Docker User

The images run the process under the user and group docgraf:docgraf with uid and gid 1019:1019. To access files created by docgraf:

1. Create a group on the local machine docgraf with group id 1019
2. Add your user on the local machine to the docgraf group