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.

​
Installation Script

The install script requires Bash to run so it works out of the box for Linux and MacOS. To run Gorbit on Windows, install Bash or refer to the Docker deployment. To deploy with a single command: 
curl -fsSL https://raw.githubusercontent.com/gorbit-dot-app/gorbit/main/deployment/docker_compose/install.sh > install.sh && chmod +x install.sh && ./install.sh
Gorbit Craft is currently unstable and under active development. Use in production environments is not recommended.
To deploy Gorbit with Gorbit Craft enabled (Sandboxed agent):
curl -fsSL https://raw.githubusercontent.com/gorbit-dot-app/gorbit/main/deployment/docker_compose/install.sh > install.sh && chmod +x install.sh && ./install.sh --include-craft
See the Craft documentation for full details on capabilities, configuration, and enabling Craft on existing deployments.
Alternatively, download and run the installation script below.

Download Install Script

Click here to download the install.sh script from GitHub.
After downloading the script, run it with bash ./install.sh The script will do the following:
  • Check your system resources and requirements
  • Pull the necessary deployment and configuration files
  • Prompt the user for the version of Gorbit to deploy and other basic information
  • Pull the Gorbit containers and start them in Docker
The script will create a directory called gorbit_data and there will also be a README in there with additional information.

​
Resourcing Overview

ResourceMinimumPreferred
CPU4 vCPU8+ vCPU
RAM10 GB16+ GB
Disk32 GB + ~2.5x indexed data500 GB for organizations <5000 users
Vespa (the vector database used by Gorbit) does not allow writes once disk usage hits 75%.
For more details, our Resourcing guide covers selecting Cloud instances, resourcing by container, and how to scale your Gorbit deployment.

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