Getting started
Everything you need to go from nothing installed to a running Hub with your first app.
Start with Your first hour for the whole path on a single page: Docker, Ollama, Hub, and your first app, with checks at each step. The pages below break the same journey into separate tasks.
The path
The pages in this section, in the order you use them. Companion Core Server owners follow the Core Server quick start to the same first screen; everyone else starts with the prerequisites.
flowchart TD
A["System requirements"] --> B{"What are you<br/>installing on?"}
B -->|"Your own PC, laptop,<br/>or Linux server"| C["Install Docker"]
C --> D["Install Ollama"]
D --> E["Installation"]
B -->|"A Companion<br/>Core Server"| F["Core Server quick start"]
E --> G["Pair with your CI Account<br/>(Hub's first screen)"]
F --> G
G --> H["First login and setup<br/>(sign in as the first admin)"]
H --> I["Onboarding wizard"]
I --> J["Installing your first app"]
J --> K["Finding your app's URL"]Check your machine can run it
System requirements β 2 cores, 4 GB RAM, 20 GB free, Docker.
Install the prerequisites
Companion Hub does not bundle these β install both before Hub:
- Install Docker β required; Hub wonβt start without it
- Install Ollama β optional: the default engine for local AI models. Skip it if you use a cloud provider or another engine
Companion Core Server owners skip this step β and the next one. Your hardware ships with Docker, Ollama, and Hub already running; go to Core Server quick start.
Install Companion Hub
Installation β desktop app on macOS, Windows, and Linux desktop; headless package on Linux servers.
Pair with your CI Account
Device pairing β a fresh Hub opens on the device registration screen at localhost:5002. Enter the 6-character code from Add Device at hub.ci.computer.
Sign in as the first admin
First login and setup β Hub sends you to its sign-in screen after pairing. Sign in with your CI Account to become the Hubβs admin.
Complete the onboarding wizard
Onboarding wizard β picks your agent, models, apps, and remote access in one pass.
Install your first app
Installing your first app β and find its URL.
Have a pairing code ready before you install: Hub asks for it before it lets anyone sign in. Get one from Add Device at hub.ci.computerΒ , then follow Installation and the Onboarding wizard.
Which path is yours?
| You have | Start at |
|---|---|
| A Companion Core Server | Core Server quick start β Docker, Ollama, and Hub are already installed |
| Your own PC or laptop | Install Docker, then Ollama, then Hub |
| A Linux server or VPS | Same, but use Docker Engine β see Installation |
Also in this section
- Connect an existing agent β point Claude Code, OpenClaw, or any MCP client at your Hub
- Why use Companion Hub β the case for self-hosting, before you commit
- Running Companion Hub β desktop vs headless vs CLI
- Core Server quick start β Companion hardware, which ships with everything preinstalled
- CLI reference β every
cihubcommand - Updating β keeping Hub current
- Custom settings and Environment variables β configuration beyond the dashboard