Admin Guide

Admin Guide

This guide covers everything you need to deploy and manage a Brane instance. As a system administrator, you are responsible for setting up nodes, managing certificates, and keeping the infrastructure running.

What You’ll Set Up

A typical Brane deployment consists of:

• One central node that orchestrates workflows and hosts the API
• One or more worker nodes, each at a different organization or domain
• Proxy nodes (optional) for cross-firewall communication

Before You Begin

Make sure you understand the core concepts and architecture before proceeding.

Deployment Steps

1. Prerequisites — Install Docker and verify system requirements
2. Install branectl — Get the node management tool
3. Deploy Central Node — Set up the orchestrator
4. Deploy Worker Nodes — Add worker domains
5. Deploy Proxy Node — Optional cross-domain networking
6. Certificates — Manage TLS certificates
7. Configuration Reference — All config file options

Minimal Setup

For a quick test deployment on a single machine, follow the Quick Start guide instead. It covers installing both brane and branectl and launching a local instance in minutes.