Harvey UI

The UI for Harvey, the lightweight Docker Compose deployment runner.

Harvey is the lightweight Docker Compose deployment runner. This project serves as a UI on top of the underlying API and service. View your deployment statuses, logs, and runtime history. Lock and unlock deployments as well as redeploy a project with the click of a button.

Install

# Copy the env files, and edit as needed
cp src/.env-example src/.env && cp .env-example .env

# Run the setup script which will bootstrap all the requirements, spin up the service, and migrate the database
just setup

Environment Variables

Required

• HARVEY_DOMAIN (eg: example.com)

Optional

• HARVEY_SECRET (leave blank if not securing your endpoints)
• HARVEY_DOMAIN_PROTOCOL (http vs https - defaults to http)
• HARVEY_TIMEOUT (defaults to 10 seconds)
• HARVEY_PAGE_SIZE (defaults to 20 records)

Usage

Visit harvey.localhost in a browser to get started.

Default Login

The default login is admin@harvey.com and password. Make sure to update the email/password after first login!

Deploy

# Deploy the project locally
just run

# Deploy the project in production
just prod

Development

# Get a comprehensive list of development tools
just --list