Quick Start Guide
Learn how to set up Nebula using the Docker Compose template. The steps outlined below provide a general guide for self-hosting Nebula Services on your own infrastructure.
Prerequisites
Download the Docker Compose Template
You can get the nebula latest docker compose file by running the following command:
- curl
- wget
curl -o docker-compose.yaml https://raw.githubusercontent.com/CremitHQ/nebula/main/docker-compose.yaml
wget -O docker-compose.yaml https://raw.githubusercontent.com/CremitHQ/nebula/main/docker-compose.yaml
info
If you want to build the docker image from the source code, you can clone the repository and build the image using the following commands:
git clone https://github.com/CremitHQ/nebula.git
cd nebula
docker-compose -f docker-compose.build.yaml up -d
Download the Configurations
You can get the nebula configurations by running the following command:
- curl
- wget
mkdir -p config
curl -o .db.env https://raw.githubusercontent.com/CremitHQ/nebula/main/.db.env.example
curl -o config/backbone_config.toml https://raw.githubusercontent.com/CremitHQ/nebula/main/config/backbone_config.toml.example
curl -o config/authority_config.toml https://raw.githubusercontent.com/CremitHQ/nebula/main/config/authority_config.toml.example
curl -o config/authorization_config.toml https://raw.githubusercontent.com/CremitHQ/nebula/main/config/authorization_config.toml.example
mkdir -p config
wget -O .db.env https://raw.githubusercontent.com/CremitHQ/nebula/main/.db.env.example
wget -O config/backbone_config.toml https://raw.githubusercontent.com/CremitHQ/nebula/main/config/backbone_config.toml.example
wget -O config/authority_config.toml https://raw.githubusercontent.com/CremitHQ/nebula/main/config/authority_config.toml.example
wget -O config/authorization_config.toml https://raw.githubusercontent.com/CremitHQ/nebula/main/config/authorization_config.toml.example
Update Your Configurations
Update the .db.env file with your PostgreSQL configurations:
PGUSER=postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=password
Update the following configuration files with your desired settings in the config directory:
Start Nebula Services
Run the following command to start the Nebula services:
docker-compose up -d