Installation¶

This guide is the recommended starting point for self-hosting Validibot.

Validibot's preferred operator interface is the just command runner. It wraps the underlying Docker Compose commands so the day-to-day workflow stays short and consistent.

The same base installation works for Community, Pro, and Enterprise. Commercial editions add packages on top of the same self-hosted deployment.

What you'll need¶

Before you start, install:

Docker and Docker Compose
just
At least 4 GB RAM for local evaluation

If you plan to run heavier validators regularly, use more memory. The deployment guides cover sizing in more detail.

Quick local setup¶

This is the fastest way to get a working instance on http://localhost:8000.

git clone https://github.com/danielmcquillen/validibot.git
cd validibot

mkdir -p .envs/.local
cp .envs.example/.local/.django .envs/.local/.django
cp .envs.example/.local/.postgres .envs/.local/.postgres

Open .envs/.local/.django and set SUPERUSER_PASSWORD to something real.

Then start the stack:

just up

On first boot, Validibot initializes the local database and creates the admin user from the values in .envs/.local/.django.

Sign in with:

Username: admin
Password: the SUPERUSER_PASSWORD you set

After the app is running¶

Once you can sign in:

Follow the Getting Started guide to create your first workflow.
If you purchased a commercial edition, continue to Self-Hosted Editions to add Pro or Enterprise features.
If you are preparing a real production deployment, use the deployment guides below.

Production deployments¶

For production, keep using the just commands, but switch to the production deployment workflow and environment files.

Start here:

Those guides cover TLS, backups, sizing, and operator responsibilities in more detail than this quick-start page.