Getting Started
Get Homeio running on your home server in under 2 minutes using Docker Compose. New to self-hosting? Start with the home server lab guide or the home server setup for beginners guide for hardware, Docker, and first-app recommendations.
Requirements
| Requirement | Version | Notes |
|---|---|---|
| Docker Engine | 24+ | Required |
| Docker Compose | v2 | Required (bundled with Docker Desktop) |
| Linux | Ubuntu 22.04+ recommended | macOS supported for development |
| RAM | 1 GB minimum | 2 GB+ recommended |
Installation
1. Clone the repository
Terminalbash
git clone https://github.com/doctor-io/homeio.git
cd homeio2. Set up environment
Copy the example environment file and fill in the required values:
Terminalbash
cp .env.example .env
# Open with your editor and set required values
nano .env3. Start Homeio
Terminalbash
docker compose up -dOpen http://your-server-ip:3000 in your browser to complete the first-time setup.
Environment variables
| Variable | Description | Example |
|---|---|---|
| POSTGRES_PASSWORD | PostgreSQL database password | strongpassword123 |
| SESSION_SECRET | Session signing secret (32+ chars) | random-secret-here |
| HOMEIO_HTTP_PORT | Port to expose (default: 3000) | 3000 |
First login
When you open Homeio for the first time, you'll be prompted to create an admin account. Enter a username and password — these become your permanent credentials for the local dashboard. There is no cloud sign-in or email verification required.
Updating Homeio
Pull the latest changes and restart the containers:
Terminalbash
git pull
docker compose pull
docker compose up -d