Welcome to Onyx

To set up Onyx there are several options, Onyx supports the following for deployment:

1. Quick guided install via the install.sh script
2. Pulling the repo and running docker compose up -d from the deployment/docker_compose directory

• Note, it is recommended to copy over the env.template file to .env and edit the necessary values

3. For large scale deployments leveraging Kubernetes, there are two options, Helm or Terraform.

This README focuses on the easiest guided deployment which is via install.sh.

For more detailed guides, please refer to the documentation: https://docs.onyx.app/deployment/overview

install.sh script

curl -fsSL https://raw.githubusercontent.com/onyx-dot-app/onyx/main/deployment/docker_compose/install.sh > install.sh && chmod +x install.sh && ./install.sh

The script installs the Onyx CLI (onyx-cli) and hands over to onyx-cli deploy install, which is where the guided installation lives. Any flags you pass are forwarded to it. If you already have the CLI (pip install onyx-cli), skip the script and run onyx-cli deploy install directly.

This provides a guided installation of Onyx via Docker Compose. It will deploy the latest version of Onyx and set up the volumes to ensure data is persisted across deployments or upgrades.

The deployment files are stored in ~/.config/onyx (an existing onyx_data directory from an older install is detected and kept in place; --dir targets another location). Note that no application critical data is stored in that directory so even if you delete it, the data needed to restore the app will not be destroyed.

The data about chats, users, etc. are instead stored as named Docker Volumes. This is managed by Docker and where it is stored will depend on your Docker setup. You can always delete these as well by running onyx-cli deploy uninstall.

To shut down the deployment without deleting, use onyx-cli deploy stop.

Managing the deployment

Beyond installing, the CLI covers the rest of the lifecycle:

Upgrading the deployment

Onyx maintains backwards compatibility across all minor versions following SemVer, so upgrading is onyx-cli deploy upgrade (add --tag vX.Y.Z to pin a version). It rewrites only IMAGE_TAG, preserves your .env edits, and backs up hand-edited files.

If you are more comfortable running docker compose commands, you can also run commands directly from the directory with the docker-compose.yml file. First bring the containers down (docker compose down), verify the version you want in the environment file (see below), (if using latest tag, be sure to run docker compose pull) and run docker compose up to restart the services on the latest version

Environment variables

The Docker Compose files try to look for a .env file in the same directory. The installer sets it up from a file called env.template. Feel free to edit the .env file to customize your deployment. The most important / common changed values are located near the top of the file. Later onyx-cli deploy runs keep your edits.

IMAGE_TAG is the version of Onyx to run. It is recommended to leave it as latest to get all updates with each redeployment.

Every image publishes a -dev twin for each of its tags (e.g. latest-dev, v1.2.3-dev), so a single IMAGE_TAG=latest-dev selects the dev variant of the whole deployment. Today only the backend image actually differs: its -dev twin adds interactive debugging tools (vim, nano, curl, ps, psql) that the default image leaves out to stay minimal. The web-server, model-server, and sandbox -dev tags are identical to their plain counterparts and exist so that one version string covers every image.