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:
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:
Step 2: Set up Synadia Cloud (Optional)
For cloud access and remote management, set up a Synadia Cloud account:
- Sign up at app.ngs.global
- Create a new context called "home"
- Download your credentials to
~/.synadia/
- Restart the edge server to pick up credentials
Step 3: Access the Dashboard
Once the edge server is running, you can access Homix in two ways:
Step 4: Add Your First Device
With Homix running, you can now start adding devices:
- Open the dashboard (local or cloud)
- Navigate to the "Devices" section
- Click "Add Device" or use auto-discovery
- 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:
📱 Device Management
Learn how to add and configure devices
⚡ Create Automations
Build automations with the visual designer
🎬 Scene Management
Create and manage scenes for your home
🔧 Troubleshooting
Common issues and solutions
Need Help?
If you run into issues during setup:
- Check the detailed installation guide
- Review the troubleshooting guide
- Join our community (Discord coming soon)