Skip to Content
DocumentationGetting StartedGetting started

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.

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 haveStart at
A Companion Core ServerCore Server quick start β€” Docker, Ollama, and Hub are already installed
Your own PC or laptopInstall Docker, then Ollama, then Hub
A Linux server or VPSSame, but use Docker Engine β€” see Installation

Also in this section

Last updated on