Documentation
Pipedash installation, CI/CD provider setup and deployment on desktop, in Docker or on iOS.
Getting started
Introduction
What Pipedash does and the 3 ways to run it.
Installation
Installers for macOS, Linux, Windows, iOS and Docker.
Quick start
Adding a provider and the first pipelines on the dashboard.
How it works
A refresh cycle from the provider API to the table.
Providers
All providers
Compare auth, config fields, parameters and cancel support.
GitHub Actions
Personal access token, GitHub Enterprise base URL.
GitLab CI
Personal access token, self-hosted base URL.
Bitbucket Pipelines
Atlassian email and API token.
Buildkite
API access token, agents and artifacts.
Jenkins
Server URL, username and API token, nested folders.
Tekton CD
Kubeconfig, context and namespace selection.
ArgoCD
Server URL, token and sync options.
Features
Dashboard
Grouping, filters, status badges and table columns.
Run history
Runs, details and rerun with the same inputs.
Trigger and cancel
Parameter forms and permission checks.
Metrics
Duration, success rate and frequency per pipeline.
Refresh
Adaptive polling and active or idle modes.
Cache
What Pipedash caches and the ways to clear it.
Configuration
Config file and env vars
TOML reference, discovery order and every PIPEDASH_* variable.
Storage backends
SQLite or PostgreSQL.
Token storage
Keyring, encrypted database or environment variables.
Setup wizard
First run and data migration between backends.
Deployment
Desktop
Tauri app for macOS, Windows and Linux.
Docker
Compose stacks with SQLite or PostgreSQL.
REST API
Routes, bearer auth and WebSocket events.
Mobile
iOS app and the mobile layout.