OrcaCD LogoOrcaCD

Installation

Get OrcaCD running quickly with Docker

Project state

OrcaCD is in early development and not yet production-ready. There are no stable releases. Expect breaking changes at any time.

Start Hub and Agent

Download the docker-compose.yml and .env file:

curl -o docker-compose.yml https://raw.githubusercontent.com/OrcaCD/orca-cd/main/docker-compose.yml
curl -o .env https://raw.githubusercontent.com/OrcaCD/orca-cd/main/.env.example

Edit the .env file according to the instructions in the file. You can also customize other environment variables as needed. See the environment variables page for more details.

Remove the Agent part from the compose file if you don't want to deploy it to the same machine as the Hub.

Start the Hub and the Agent:

docker compose up -d

Configure your Reverse Proxy

See the reverse proxy guide for instructions on how to configure a reverse proxy for your Hub.

Create an Admin Account

Create an admin account on https://<your-app-url>/login

Setup Admin Account

Connect your first Agent

Navigate to the Agents page and click "Add Agent". Follow the instructions and copy the token and add it as AUTH_TOKEN to the .env file of your Agent deployment and restart the Agent.

Setup Agent

Start Deploying

Add your first repository and create your first deployment.

Last updated on

On this page