Self-Hosted

Install Self-Hosted Dashboard

Deploy on your infrastructure in under 5 minutes with Docker. Full control over your data, air-gapped support, and zero external dependencies.

Prerequisites

Docker Engine 20.0+

Container runtime

Docker Compose v2+

Service orchestration

2 GB RAM, 10 GB disk minimum

Resource requirements

Linux, macOS, or WSL2

Supported platforms

Recommended

Quick Install

Run this single command to download, configure, and start the dashboard automatically.

curl -fsSL https://cidash.dev/api/install?file=install | bash

The installer will create a directory, generate secure secrets, and start the dashboard via Docker Compose.

Manual Installation

Prefer not to pipe curl to bash? Follow these steps to install manually.

1

Download docker-compose.yml

Fetch the Compose file that defines the dashboard service and its dependencies.

curl -fsSL https://cidash.dev/api/install?file=docker-compose -o docker-compose.yml
2

Generate .env file

Create a .env file with secure random secrets for encryption and session management.

cat > .env << EOF
DASHBOARD_PORT=3000
SECRET_KEY=$(openssl rand -hex 32)
ENCRYPTION_KEY=$(openssl rand -hex 16)
DATABASE_URL=file:./data/dashboard.db
EOF
3

Start the dashboard

Launch all services in the background with Docker Compose.

docker compose up -d
4

Access the dashboard

Open your browser and navigate to the dashboard. The default port is 3000.

http://localhost:3000
You should see the login screen within a few seconds.

Advanced Options

Customize the installation with environment variables passed to the installer.

Custom port

Run the dashboard on a different port instead of the default 3000.

DASHBOARD_PORT=8080 curl -fsSL https://cidash.dev/api/install?file=install | bash

With license key

Provide your enterprise license key during installation to unlock all features immediately.

LICENSE_KEY="eyJ..." curl -fsSL https://cidash.dev/api/install?file=install | bash

Custom install directory

Specify a custom directory for the installation instead of the current directory.

INSTALL_DIR=/opt/cidash curl -fsSL https://cidash.dev/api/install?file=install | bash

After Installation

Get the most out of your self-hosted dashboard with these next steps.

Connect GitLab

Add your GitLab instance

  1. 1.Navigate to Settings in the dashboard sidebar.
  2. 2.Open the GitLab Config tab.
  3. 3.Click Add Token and paste your GitLab personal access token with read_api scope.

Update to Latest Version

Pull the latest image and restart

docker compose pull app && docker compose up -d

Uninstall

Remove all containers and volumes

docker compose down -v

This will stop all services and delete all associated data volumes. Make sure to back up any data you want to keep before running this command.

Need more from your self-hosted instance?

Unlock team management, priority support, and advanced features with an enterprise license. Or compare with our fully-managed cloud offering.