🏠Homix/Documentation
Open App

Installation Guide

Detailed instructions for installing Homix in various environments.

System Requirements

Minimum Requirements

  • OS: Linux, macOS, or Windows with WSL2
  • Memory: 512MB RAM
  • Storage: 1GB free space
  • Network: Internet connection for cloud features

Recommended Requirements

  • Memory: 2GB+ RAM
  • Storage: 5GB+ free space
  • Network: Ethernet connection for reliability

Container Platform

Homix requires either Docker or Podman to run. Choose one:

🐳 Docker (Recommended)

Most widely supported, includes Docker Desktop

Linux: apt install docker.io docker-compose-plugin

📦 Podman (Alternative)

Daemonless, rootless container platform

Installation: podman.io
Compose: pip install podman-compose

Quick Installation

The fastest way to get started:

curl -sSL https://get.homix.dev | sh

This installer will:

  1. Detect your container platform (Docker/Podman)
  2. Check for required tools
  3. Look for Synadia Cloud credentials
  4. Create configuration directory (~/.homix)
  5. Download and start the edge server

Advanced Installation Options

Environment Variables

Customize the installation with environment variables:

Force Container Tool

curl -sSL https://get.homix.dev | CONTAINER_TOOL=podman sh

Custom Installation Directory

curl -sSL https://get.homix.dev | HOMIX_DIR=/opt/homix sh

Specific Version

curl -sSL https://get.homix.dev | HOMIX_VERSION=v1.0.0 sh

Legacy Docker Compose

curl -sSL https://get.homix.dev | COMPOSE_CMD="docker-compose" sh

Manual Installation

For more control, you can install manually:

# Download installer
curl -sSL https://get.homix.dev > install.sh
# Review and customize
nano install.sh
# Run with custom environment
CONTAINER_TOOL=podman HOMIX_DIR=/opt/homix bash install.sh

Platform-Specific Instructions

macOS

  1. Install Docker Desktop from docker.com
  2. Start Docker Desktop
  3. Run the Homix installer

Windows (WSL2)

  1. Enable WSL2 and install a Linux distribution
  2. Install Docker Desktop with WSL2 backend
  3. Run the installer from WSL2 terminal

Linux (Ubuntu/Debian)

# Install Docker
sudo apt update
sudo apt install docker.io docker-compose-plugin
sudo usermod -aG docker $USER
# Log out and back in, then:
curl -sSL https://get.homix.dev | sh

Linux (RHEL/CentOS/Fedora)

# Install Docker
sudo dnf install docker docker-compose-plugin
sudo systemctl enable --now docker
sudo usermod -aG docker $USER
# Log out and back in, then:
curl -sSL https://get.homix.dev | sh

Synadia Cloud Setup

For cloud features and remote access, set up Synadia Cloud:

  1. Create account at app.ngs.global
  2. Create a new context named "home"
  3. Download your credentials file
  4. Save it to ~/.synadia/NGS-Home-yourname.creds
  5. Restart Homix to pick up credentials

Credentials File Location

The installer automatically looks for credentials in ~/.synadia/. Any file matching NGS-*.creds will be detected.

Post-Installation

Verify Installation

# Check if Homix is running
docker ps | grep homix-edge
# View logs
cd ~/.homix && docker compose logs -f

Access Dashboards

Management Commands

View Logs

cd ~/.homix && docker compose logs -f

Stop Homix

cd ~/.homix && docker compose down

Update Homix

cd ~/.homix && docker compose pull && docker compose up -d

Uninstall

cd ~/.homix && docker compose down && cd .. && rm -rf .homix

Troubleshooting

Common installation issues and solutions:

Docker not found

Make sure Docker is installed and running. On Linux, ensure your user is in the docker group.

Permission denied

On Linux, add your user to the docker group: sudo usermod -aG docker $USER

Port conflicts

If port 8080 is in use, edit ~/.homix/docker-compose.yml to change ports.

For more help, see the troubleshooting guide or join our community (Discord coming soon).