Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gorbit.cloud/llms.txt

Use this file to discover all available pages before exploring further.

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 Gorbit repo

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

Navigate to the compose files

cd gorbit/deployment/docker_compose
4

Launch Gorbit

To pull images from Docker Hub and start Gorbit:
docker compose up -d
Alternatively, to build images from source:
docker compose up -d --build --force-recreate
If you’ve previously launched Gorbit with the old gorbit-stack service name, you’ll need to add -p gorbit-stack to your launch command.For example: docker compose up -p gorbit-stack -d.
After the containers come up, the system needs to go through an initialization process after which you can access Gorbit at localhost:3000.

Enabling Gorbit Craft

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

Option 2: Existing deployments

If you’ve already set up Gorbit, 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 Gorbit deployment with OAuth, OIDC, or SAML.

More Gorbit Configuration Options

Learn about all available configuration options for your Gorbit deployment.