Gitlab CI Pipeline Dashboard

A dynamic Gitlab CI pipeline dashboard
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact

About The Project

I created this Gitlab CI pipeline dashboard to monitor the pipelines on a TV or computer screen. This dashboard helps to overview your projects in a glimpse, here's why:

• You can monitor the activity of your projects
• You can check for latest releases
• Pipelines pending, running, failed or manual are highlighted
• Access a project, a pipeline or even a job from the dashboard
• Check for test coverage of your projects after a pipeline succeeds
• Successful pipelines remain highlighted for 15 minutes
• Works with Gitlab's self-managed community edition

Of course, this dashboard may not suit your needs if you itend to monitor a lot of projects, but it will be very useful for smaller teams with a few active projects. You may also suggest changes by forking this repo and creating a pull request or opening an issue.

This project has been developed for an enterprise use on my spare time and automating tests is not properly done yet.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• NodeJS Install NodeJS

• docker
  Install Docker Engine

Installation

1. Configure Gitlab as an OAuth 2.0 authentication identity provider

   This dashboard needs at least the following scopes:

   • read_repository

   If you want to run this project locally, also add http://localhost:3000/oauth/redirect to the redirect URIs

2. Clone the repo

   git clone https://github.com/SimonSerrano/gitlab-pipelines.git

3. Install NPM packages

   npm install
   npm run bootstrap

4. Enter your domain and APP ID in .env in packages/backend

   GITLAB_DOMAIN=yourdomain.com
   GITLAB_APP_ID=Your app Id
   

5. Build Docker images

   npm run docker:build
   

6. Start Docker images

   npm run docker:start
   

7. (Optional) If you want to host this dashboard behind Gitlab's Nginx, add this to your gitlab.rb

   nginx['custom_gitlab_server_config'] = "location /pipelines {\n  proxy_cache off;\n  proxy_pass http://localhost:3000;    \n}\n"
   

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Simon Serrano - LinkedIn

• simon.serrano@hotmail.fr

Project Link: https://github.com/SimonSerrano/gitlab-pipelines

(back to top)