Skip to main content

Quick Start

Get OrbisID running in under 5 minutes using the all-in-one package.

Prerequisites​

  • Docker 24+ and Docker Compose 2.20+ installed
  • The OrbisID release package (orbisid-<version>-all-in-one.tar.gz) — download the latest version from the OrbisID website

Steps​

1. Extract the release package​

tar -xzf orbisid-<version>-all-in-one.tar.gz
cd orbisid-<version>-all-in-one

2. Create the environment file​

cp .env.example .env

Edit .env and set two required values:

# Generate an encryption key (do this once and keep it safe)
openssl rand -base64 32
.env
ENCRYPTION_KEY=<paste your generated key here>
POSTGRES_PASSWORD=<choose a strong database password>

The all-in-one package uses sensible defaults for the other database settings (POSTGRES_DB=orbisid, POSTGRES_USER=orbisid). These only need to be changed if you want to customise the database name or username — see the Configuration Reference for the full list of environment variables.

Important

The ENCRYPTION_KEY is used to encrypt credentials stored in the database. If you lose this key, encrypted credentials cannot be recovered. Back it up securely.

3. Load Docker images​

docker load -i images.tar.gz

This loads the bundled Docker images into your local Docker engine. It only needs to be run once per install — not on every start.

4. Start OrbisID​

docker compose up -d

Wait for all services to become healthy (about 30-60 seconds):

docker compose ps

All services should show healthy or running.

5. Log in​

Open http://localhost in your browser.

FieldValue
Usernameadmin
PasswordChangeMe123!

You will be prompted to change the default password on first login.

6. Add your first system​

  1. Navigate to Systems in the sidebar
  2. Click Add System
  3. Enter connection details for an Active Directory domain controller or Linux server
  4. Click Test Connection to verify connectivity
  5. Save the system

7. Run your first scan​

Option A — Scan Now (all editions):

  1. Navigate to Systems in the sidebar
  2. Find the system you added and click the Scan Now button (▶)
  3. The scan starts immediately and results appear once complete

Option B — Create a Scan Policy (Pro and Enterprise only):

  1. Navigate to Scanning in the sidebar
  2. Click Create Policy
  3. Select the system you just added and configure a schedule (or leave as on-demand)
  4. Click Save, then Scan Now to trigger the first run immediately

OrbisID will connect to the target system, discover accounts and entitlements, and classify privileges using the default policy rules.

8. View results​

  • Dashboard shows KRI summary cards and system statistics
  • Accounts shows all discovered accounts with privilege levels
  • Reports lets you generate compliance reports

Next Steps​