Gitlab CI Dashboard will provide you with a global overview of all pipelines, schedules, and their statuses within a single group. The default functionality of Gitlab is limited at the project level. This can become hard to manage when you have a lot of projects, 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 1
read onlytoken is needed to serve a whole team- Optionally use a
read/writetoken to perform actions like restarting failed pipelines, create new pipelines or cancel pipelines.
- Optionally use a
- 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 and projects by topic
- 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
- Generate a
read_apiorapiaccess token in Gitlab, depending on your requirements ( e.g: https://gitlab.com/-/profile/personal_access_tokens)
- 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- Dashboard should be available at: http://localhost:8080/ showing (by default) all available groups and their projects
You are able to perform write operations like creating,canceling,retrying pipelines, but you need to set the environment variable: API_READ_ONLY to false and provide a valid read/write access token.
You are able to hide the ellipsis (...) when you just want to use READ_ONLY mode. Set the UI_HIDE_WRITE_ACTIONS to true.
Prometheus metrics are exposed on the following endpoint
| Variable | Type | Description | Required | Default |
|---|---|---|---|---|
| GITLAB_BASE_URL | string | The base url to the Gitlab server (e.g: https://gitlab.com) | yes | |
| GITLAB_API_TOKEN | string | A readonly access token generated in Gitlab (see: https://gitlab.com/-/profile/personal_access_tokens) | yes | |
| GITLAB_GROUP_ONLY_IDS | string | Provide a comma seperated string of group ids which will only be displayed (e.g: 123,789,888) | no | |
| GITLAB_GROUP_SKIP_IDS | string | Provide a comma seperated string of group ids which will be ignored (e.g: 123,789,888) | no | |
| GITLAB_GROUP_ONLY_TOP_LEVEL | bool | Show only top level groups | no | false |
| GITLAB_GROUP_CACHE_TTL_SECONDS | int | Expire after write time in seconds for groups (cache) | no | 300 |
| GITLAB_PROJECT_SKIP_IDS | string | Provide a comma seperated string of project ids which will be ignored (e.g: 123,789,888) | no | |
| GITLAB_PROJECT_CACHE_TTL_SECONDS | int | Expire after write time in seconds for projects (cache) | no | 300 |
| GITLAB_PIPELINE_CACHE_TTL_SECONDS | int | Expire after write time in seconds for pipelines (cache) | no | 5 |
| GITLAB_PIPELINE_HISTORY_DAYS | int | How far back in time (days), it should fetch pipelines from gitlab (pipelines tab only) | no | 5 |
| GITLAB_BRANCH_CACHE_TTL_SECONDS | int | Expire after write time in seconds for branches (cache) | no | 60 |
| GITLAB_SCHEDULE_CACHE_TTL_SECONDS | int | Expire after write time in seconds for schedules (cache) | no | 300 |
| GITLAB_JOB_CACHE_TTL_SECONDS | int | Expire after write time in seconds for jobs (cache) | no | 5 |
| GITLAB_ARTIFACT_CACHE_TTL_SECONDS | int | Expire after write time in seconds for artifacts (cache) | no | 1800 |
| API_READ_ONLY | bool | If true, you are not able to perform 'write' operations like retrying a pipeline | no | true |
| UI_HIDE_WRITE_ACTIONS | bool | If true, the ellipsis action button (...) is hidden, handy if you want to use this application in read-only mode | no | false |
| SERVER_LISTEN_IP | string | The IP address where the web server should listen on | no | 0.0.0.0 |
| SERVER_LISTEN_PORT | int | The port where the web server should listen on | no | 8080 |
| SERVER_WORKER_COUNT | int | The amount of worker threads the web server should have | no | CPU specific |
| RUST_LOG | string | The log level of the application, set to "debug" to enable debug logging | no | info |