Check out our Resourcing Guide before getting started with Docker.

​
Guide

The standard method to launch Onyx is using Docker Compose.
1

Install Requirements

2

Clone the Onyx repo

git clone https://github.com/onyx-dot-app/onyx.git
3

Navigate to the compose files

cd onyx/deployment/docker_compose
4

Launch Onyx

To pull images from Docker Hub:
docker compose -f docker-compose.dev.yml -p onyx-stack up -d --pull always --force-recreate
To build images from source:
docker compose -f docker-compose.dev.yml -p onyx-stack up -d --build --force-recreate
5

Configure your Deployment

Configure your deployment using a .env file.
cd ~/onyx-dot-app/onyx/deployment/docker_compose
cp env.prod.template .env
You’ll need to restart Onyx after changing any .env variables.
docker compose -f docker-compose.dev.yml -p onyx-stack down
docker compose -f docker-compose.dev.yml -p onyx-stack up -d --pull always --force-recreate

​
Next Steps

Configure Authentication

Set up authentication for your Onyx deployment with OAuth, OIDC, or SAML.

More Onyx Configuration Options

Learn about all available configuration options for your Onyx deployment.

Configure SSL and custom domains

See our EC2 guide to configure SSL and custom domains.