Skip to content

Displays CI statuses on a dashboard and triggers fun modules representing the status!

License

Notifications You must be signed in to change notification settings

FuturePortal/CIMonitor

Repository files navigation

image CIMonitor v4

release MIT docker pulls read-the-docs stars

CIMonitor is a place where all your CI statuses come together. Check if all tests have passed, and if deployments are successful. All in one overview. This is all done via webhooks, so no complex configuration. Get started!

Supported webhooks

Security / privacy

  • No index requests are made by the CIMonitor (for search/index bots)
  • Webhooks may require a secret token provided via environment variable WEBHOOK_SECRET
  • The dashboard can be password protected by providing environment variable DASHBOARD_PASSWORD and DASHBOARD_LOCK=dashboard
  • Settings can be password protected by providing environment variable DASHBOARD_PASSWORD and DASHBOARD_LOCK=settings

Example

Dashboard demonstration

Getting started

The easiest and quickest way to run CIMonitor is via docker. But there are other options available for you. Check the options below in the documentation:

Development

To start development, run the following commands on your terminal:

  • ./Taskfile: See all available make commands.
  • ./Taskfile init: Set up the project for local development (required to run locally).
  • ./Taskfile start: Run the development server.

Contributors

A big thanks to all the contributors who make CIMonitor what it is today!

contirubtor avatars

Sponsor this project

Contributors 3

  •  
  •  
  •