Skip to main content
Check out the Resourcing Guide before getting started with Docker.

​
Guide

Note: On Windows, the commands will be slightly different but all the steps are the same.
1

Install Requirements

2

Clone the Onyx repo

git clone --depth 1 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 and start Onyx:
docker compose up -d
Alternatively, to build images from source:
docker compose up -d --build --force-recreate
If you’ve previously launched Onyx with the old onyx-stack service name, you’ll need to add -p onyx-stack to your launch command.For example: docker compose up -p onyx-stack -d.
After the containers come up, the system needs to go through an initialization process after which you can access Onyx at localhost:3000.

​
Enabling Onyx Craft

To enable Onyx Craft (AI-powered artifact builder for web apps, documents, and slides): Run the installation script with the --include-craft flag: 
cd onyx/deployment/docker_compose
./install.sh --include-craft
Then start the services: 
cd onyx_data/deployment
docker compose up -d

​
Option 2: Existing deployments

If you’ve already set up Onyx, you can enable Craft by running: 
ENABLE_CRAFT=true IMAGE_TAG=craft-latest docker compose up -d
See the Craft documentation for full details on capabilities and configuration.

​
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.