Skip to Content
DocumentationGetting StartedGetting Started

Getting Started

Everything you need to go from nothing installed to a running Hub with your first app.

In a hurry, or new to all of this? Your First Hour is the whole path on a single page β€” Docker, Ollama, Hub, and your first app, with checks at each step. The pages below are the same journey broken into pieces, plus everything else in this section.

The path

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:

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.

Create your admin account

First Login & Setup β€” the dashboard at localhost:5002.

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.

In a hurry? Installation β†’ Onboarding Wizard is the shortest route to a working Hub. The rest of this section fills in the details.

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