Quick Start Guide

Get Homix running in your home in under 5 minutes.

Prerequisites

  • Linux, macOS, or Windows machine
  • Docker or Podman installed
  • Internet connection

Step 1: Install Homix Edge Server

Run the one-line installer to set up the Homix edge server in your home:

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

This will:

  • Download and start the Homix edge server
  • Set up the local configuration
  • Check for Synadia Cloud credentials

Alternative: Force Container Tool

If you have both Docker and Podman installed, you can force a specific tool:

# Force Docker
curl -sSL https://get.homix.dev | CONTAINER_TOOL=docker sh
# Force Podman
curl -sSL https://get.homix.dev | CONTAINER_TOOL=podman sh

Step 2: Set up Synadia Cloud (Optional)

For cloud access and remote management, set up a Synadia Cloud account:

  1. Sign up at app.ngs.global
  2. Create a new context called "home"
  3. Download your credentials to ~/.synadia/
  4. Restart the edge server to pick up credentials
# Restart edge server after adding credentials
cd ~/.homix && docker compose restart

Step 3: Access the Dashboard

Once the edge server is running, you can access Homix in two ways:

🏠 Local Dashboard

Access via your local network:

http://localhost:8080

☁️ Cloud Dashboard

Access from anywhere (requires Synadia Cloud):

https://app.homix.dev

Step 4: Add Your First Device

With Homix running, you can now start adding devices:

  1. Open the dashboard (local or cloud)
  2. Navigate to the "Devices" section
  3. Click "Add Device" or use auto-discovery
  4. Follow the device-specific setup instructions

Device Discovery

Homix can automatically discover many devices on your network. Look for the "Auto-discover devices" button in the devices section.

Next Steps

Now that you have Homix running, explore these features:

Need Help?

If you run into issues during setup: