Repository files navigation

Gitlab CI Dashboard will provide you with aglobal overview of all pipelines, schedules, and their statuses within asingle group.The default functionality of Gitlab is limited at the project level. This can become hard to manage when you have a lotofprojects, potentially resulting in undetected failed pipelines.

• View all pipeline statuses per group (e.g: failed/canceled/success)
• View all pipeline schedules per group
• You won't get rate limited by the Gitlab API, due to server-side caching
• Communication to the Gitlab API happens only server side
• Only 1read only token is needed to serve a whole team
  • Optionally use aread/write token to perform actions like restarting failed pipelines, create new pipelines orcancel pipelines.

• Overview of all latest pipeline statuses within a group
• Overview of all pipeline statuses within a group
• Overview of all schedules within a group
• Navigate to Gitlab
• Shows jobs and their status per pipeline
• Download artifacts from jobs directly
• Search for projects within a group
• Filter pipelines by status
• Filter pipelines by projects and topic
• Filter pipelines by failed jobs
• Add projects to favorites
• Start a new pipeline (requires read/write API token)
• Restart failed pipelines (requires read/write API token)
• Cancel pipelines (requires read/write API token)

• Overview of all registries (container/package) within a group
• ... suggestions are welcome

• Gitlab server (v4 API)
• API token (read only or read/write)
• Docker

1. Generate aread_api orapi access token in Gitlab, depending on your requirements (e.g:https://gitlab.com/-/profile/personal_access_tokens)

2. Run docker with the required environment variables (GITLAB_BASE_URL, GITLAB_API_TOKEN)

docker run \  -p 8080:8080 \  -e GITLAB_BASE_URL=https://gitlab.com \  -e GITLAB_API_TOKEN=my_token \  larscom/gitlab-ci-dashboard:latest

Or you can run it with a TOML configration file

docker run \  -p 8080:8080 \  -v ./config.toml:/app/config.toml \  larscom/gitlab-ci-dashboard:latest

3. Dashboard should be available at:http://localhost:8080/ showing (by default) all available groups and theirprojects

You are able to perform write operations like creating,canceling,retrying pipelines, but you need to set the environmentvariable:API_READ_ONLY tofalse and provide a validread/write access token.

You are able to hide the ellipsis (...) when you just want to useREAD_ONLY mode. Set theUI_HIDE_WRITE_ACTIONS totrue.

Prometheus metrics are exposed on the following endpoint

http://localhost:8080/metrics/prometheus

You have the option to set the configuration via environment variables or a TOML file.A TOML file takes precedence over environment variables, except for theRUST_LOG variable.

An example TOML file can be found inside the./api folder.

Mount theconfig.toml inside the container (/app/config.toml)

docker run \  -p 8080:8080 \  -v ./config.toml:/app/config.toml \  larscom/gitlab-ci-dashboard:latest

If you are running a gitlab instance that is using a TLS certificate signed with a private CA you are able to provide that CA as mount (PEM encoded)

This is needed when the dashboard backend is unable to make a connection to the gitlab API over HTTPS.

Mount theca.crt inside the container (/app/certs/ca.crt)

docker run \  -p 8080:8080 \  -e GITLAB_BASE_URL=https://gitlab.com \  -e GITLAB_API_TOKEN=my_token \  -v ./ca.crt:/app/certs/ca.crt \  larscom/gitlab-ci-dashboard:latest

If you are still unable to connect with a custom CA cert, be sure that the gitlab server certificate contains a valid SAN (Subject Alternative Name)

If there is a mismatch the HTTP client is still unable to make a proper connection.