Quick start

Pull the Omnimatch image, start a container and finish setup in your browser. Use a Linux server or cloud VM with Docker Compose.

You need Docker Compose v2 and a tool-capable LLM connection. The image supports Linux AMD64 and ARM64; the model runs separately.

1. Start Omnimatch

The public image is ghcr.io/omnimatch/omnimatch-agents:onprem-stable. No registry login or product key is required to start with one user and one agent.

Open a terminal on your server and run:

mkdir omnimatch # Create the installation folder
cd omnimatch    # Enter the folder
curl --fail -O https://omnimatch.ai/on-prem/compose.yaml # Download the Compose configuration
docker compose pull    # Download the latest image
docker compose up -d   # Start in the background
docker compose logs -f # Follow startup logs

Press Ctrl+C to stop following the logs. Omnimatch keeps running in the background.

Keep this omnimatch folder for your compose.yaml configuration. Return to it to run update, log or stop commands. Your database, documents and settings are stored separately in a persistent Docker volume.

Already running a cluster? Use the Kubernetes reference.

2. Open your installation

Docker on your own computer: open http://localhost:8787. Localhost always means the computer running your browser, not a remote server.

Remote server or cloud VM: configure an HTTPS reverse proxy and open your chosen address, for example https://agents.example.com. Complete the wizard at this address. Keep access restricted to the administrator until setup is complete.

3. Connect your model and data

No installation code needed. The wizard creates your administrator account and tests your model connection. Then create an agent and upload documents. The database, documents and settings persist when the container is replaced.

For licensed document connections, follow the OneDrive or Google Drive guide. For a disconnected network, use the air-gapped guide.

Compose configuration

The commands above download this compose.yaml. Copy it directly if you prefer:

# Public image. Run docker compose pull, then docker compose up -d.
name: omnimatch-onprem

services:
  app:
    image: ghcr.io/omnimatch/omnimatch-agents:onprem-stable
    init: true
    restart: unless-stopped
    ports:
      - "127.0.0.1:8787:8787"
    volumes:
      - omnimatch-state:/data
    security_opt:
      - no-new-privileges:true

volumes:
  omnimatch-state: