Skip to content

Install Vidai

Vidai runs in your own network. Vidai Community installs on one host with Docker in a few minutes. Vidai Enterprise adds Docker and a Helm chart for production on Kubernetes, and comes to you from your account manager.

Edition Install with Where you get it
Community Docker Compose, one host The public releases page
Enterprise Docker Compose, or Helm on Kubernetes 1.27+ Your account manager. Contact us if you don't have one yet

Vidai 1.0 is a new installation

1.0 doesn't upgrade a 0.8 installation in place. Running 0.8 today? Contact us and we'll help you plan the move.

Install Community

For: anyone trying Vidai, or a small team running it. You need: a Linux or macOS host with Docker Engine 24+ and Docker Compose 2.20+, openssl, and about 2 CPUs and 4 GB of memory to start with. A licence key is optional to try Vidai: get a free Community key at portal.vidai.uk when you're ready.

  1. Choose the version. The releases page lists every release, newest first; release candidates are marked Pre-release. Set VERSION to the one you want, without the leading v:

    VERSION=1.0.0
    

    Or take the newest release, release candidates included:

    VERSION=$(curl -fsSL "https://api.github.com/repos/vidaiUK/vidai-quickstart/releases?per_page=1" \
      | grep -m1 '"tag_name"' | cut -d'"' -f4 | sed 's/^v//')
    echo "$VERSION"
    

    Every command below uses $VERSION, so run them in the same terminal.

  2. Download the release and its signature.

    curl -LO https://github.com/vidaiUK/vidai-quickstart/releases/download/v${VERSION}/vidai-community-${VERSION}.tar.gz
    curl -LO https://github.com/vidaiUK/vidai-quickstart/releases/download/v${VERSION}/vidai-community-${VERSION}.tar.gz.bundle
    
  3. Check the signature (optional, recommended). See Verify what you downloaded.

  4. Unpack it, add your licence and run setup.

    tar xzf vidai-community-${VERSION}.tar.gz
    cd vidai-community-${VERSION}
    cp /path/to/your/vidai.license .     # optional: setup.sh picks it up
    ./setup.sh
    

    setup.sh asks for:

    • your licence, unless vidai.license is already in the folder: paste the key, give the path to your vidai.license file, or press Enter to try Vidai without one;
    • the address people will open the Control room at, for example https://vidai.example.com, with the port if people type one (no path);
    • two ports on this host: one for the Control room and one for the gateway, where your programs send their AI calls. Choose ports that are free on the host and that your firewall opens to the people and programs that need them;
    • the first admin's email.

    It generates every password and key itself and writes them to .env, readable only by you. Keep a copy of .env somewhere safe: the data keys in it can't be recovered.

  5. Start Vidai.

    docker compose up -d
    docker compose ps      # wait until everything shows healthy, about a minute the first time
    
  6. Sign in. Open the address you gave setup.sh. Sign in with the first admin's email and the initial password setup.sh printed. Vidai then asks you to set up your administrator account: name your organisation and create your own account. The initial password stops working after that.

Next: Set up your organisation, or Try Vidai in 15 minutes.

Point your programs at the gateway

Programs keep the SDK they use. Set its base URL to http://<your host>:<gateway port>/v1, with the gateway port you chose in setup.sh, and use a key issued in the Control room. Connect your first program shows each SDK.

Get Vidai Enterprise

Vidai Enterprise is for production and for larger and regulated organisations. Your account manager gives you access to the Enterprise release, which has:

Folder Use it for
docker/ One host: a pilot, or a smaller production install. Installs the same way as Community, with your Enterprise vidai.license
helm/ Production on Kubernetes 1.27+: an internal admin gateway, public gateways that scale with traffic, and your own Postgres

Each folder has its own README, and the release has a SHA256SUMS file to check what you received:

shasum -a 256 -c SHA256SUMS

Most teams try Vidai with Docker and run production with Helm. Your account manager can help you size it and plan the move between them.

No account manager yet? Contact us.

Verify what you downloaded

Every Vidai release is signed by Vidai UK Limited with cosign, and each signature is recorded on the public Sigstore transparency log. The signing key and its fingerprint are published at vidai.uk/cosign.

curl -o cosign.pub https://vidai.uk/.well-known/cosign.pub

# The release you downloaded
cosign verify-blob --key cosign.pub \
  --bundle vidai-community-${VERSION}.tar.gz.bundle \
  vidai-community-${VERSION}.tar.gz

# The images it runs
for image in gateway console bff-community; do
  cosign verify --key cosign.pub ghcr.io/vidaiuk/${image}:${VERSION}
done

Each command says the signature verified. Verifying is optional: Vidai runs the same either way.

What's running

Part Reached at What it does
Control room the Control room port you chose The web app people use. It passes /api/ to the API server
API server inside Docker only People, teams, policies, prices and reports
Gateway the gateway port you chose Every AI call from your programs (/v1/...)
Postgres inside Docker only One database for everything. Bring your own instead if you prefer

To change a port later, edit CONSOLE_PORT or GATEWAY_PORT in .env, then run docker compose up -d.

If something isn't right

You see Do this
docker compose ps shows a part that isn't healthy docker compose logs <part>, for example docker compose logs gateway
The Control room doesn't open Check the address and port you gave setup.sh, and that your firewall allows them
A model on the same host (Ollama, for example) can't be reached Use http://host.docker.internal:<port> as the provider's address
You want HTTPS Put your reverse proxy or load balancer in front, set VIDAI_PUBLIC_URL in .env to the https:// address, then docker compose up -d

The README inside the release covers HTTPS, your own Postgres, backups and upgrades in full.