Skip to content

Quick Start

Get a local development instance running in under 5 minutes.

Prerequisites

  • Python 3.11+ (3.13 recommended)
  • PostgreSQL 15+ running locally (or use the Docker Compose method below)
  • Git

Option A: Local Python

# Clone
git clone https://github.com/pixelotes/opsdeck.git
cd opsdeck

# Virtual environment
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

# Environment
cp .env.example .env
# Edit .env and set DATABASE_URL to your local PostgreSQL

# Database
flask db upgrade
flask init-db
flask seed-db-prod    # Creates admin user and base data

# Run
flask run --debug

Option B: Docker Compose

git clone https://github.com/pixelotes/opsdeck.git
cd opsdeck
docker-compose up -d --build

This starts both the application and a PostgreSQL 16 container. The database is initialized automatically via entrypoint.sh.

First login

Open http://127.0.0.1:5000 and log in with:

Field Value
Email admin@example.com
Password admin123

You'll be prompted to change the password immediately.

Tip

Customize the initial admin credentials by setting DEFAULT_ADMIN_EMAIL and DEFAULT_ADMIN_INITIAL_PASSWORD in .env before the first run.

What's next