Docker

Check out the Resourcing Guide before getting started with Docker.

This guide covers managing the compose files manually. For a guided install with managed upgrades, use the Nexus CLI instead. it can also adopt an existing manual setup later.

Guide#

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

Install Requirements#

• Git

• Docker (with compose)

Clone the Nexus repo#

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

Navigate to the compose files#

  cd onyx/deployment/docker_compose

Launch Nexus#

To pull images from Docker Hub and start Nexus:

  docker compose up -d

Alternatively, to build images from source:

  docker compose up -d --build --force-recreate

If you've previously launched Nexus 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 Nexus at localhost:3000.

Enabling Nexus Craft#

Craft adds isolated sandbox containers and an egress proxy to the Docker Compose deployment. Use the dedicated guide for both new and existing installations.

Deploy Craft on Docker Compose#

Install the Craft overlay, configure the sandbox API URL, plan host capacity, and verify the runtime.

Next Steps#

Configure Authentication#

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

More Nexus Configuration Options#

Learn about all available configuration options for your Nexus deployment.