Self-hosting hyAway
Run your own instance of hyAway instead of using the hosted hyaway.com.
TL;DR
- Most users: use Docker (
docker compose -f docker/docker-compose.yml up -d), then connect to Hydrus in the browser - Remote access: add Tailscale Serve (recommended)
- Sharing without logins: only via preset credentials (danger zone, requires building from source)
Common scenarios
| I want to... | Setup needed |
|---|---|
| Access Hydrus from my phone/tablet (remote via Tailscale) | Use hyaway.com + Tailscale Serve for Hydrus (see Remote access with Tailscale). |
| Access Hydrus from my phone/tablet (same Wi‑Fi / LAN) | Use hyaway.com — no self-hosting required. If you want direct LAN access (advanced), see Local network access. |
| Run hyAway on my local network | Basic Docker setup. Each user enters their own Hydrus credentials. |
| Share Hydrus with family/friends without them logging in | Build from source with preset credentials. ⚠️ Access key is exposed to all users. |
| Access Hydrus remotely (outside my home) | Docker + Tailscale Serve for easy secure access, or set up a reverse proxy with your own domain. |
| Host a public instance for others | Build from source + reverse proxy + VITE_APP_URL. Do NOT use preset credentials. |
| Customize hyAway or contribute | Local development setup |
Why self-host?
- Privacy — Keep everything on your own infrastructure
- Customization — Modify the source code to fit your needs
- Offline access — No dependency on external services
- Network isolation — Run hyAway on the same network as Hydrus
Deployment options
| Method | Best For | Difficulty |
|---|---|---|
| Docker | Most users — pull pre-built image, easy updates | Easy |
| Build from source | Preset credentials, custom VITE_APP_URL | Medium |
| Local development | Contributors, code modifications | Medium |
Quick start with Docker
The fastest way to self-host hyAway:
bash
# Download the compose file
curl -O https://raw.githubusercontent.com/hyaway/hyaway/main/docker/docker-compose.yml
# Start the container (pulls from GitHub Container Registry)
docker compose up -dhyAway will be available at http://localhost:4929
See the Docker guide for configuration options and production setup.
Architecture
hyAway is a static single-page application (SPA). It:
- Runs entirely in your browser
- Communicates directly with the Hydrus Client API
- Has no backend server — just static files served by nginx
This means you can host it with any web server: nginx, Apache, Caddy, etc.
How it works: Your browser loads the hyAway SPA from nginx (port 4929), then makes API calls directly to Hydrus (port 45869). The nginx server only serves static files — it doesn't proxy API requests.
Prerequisites
Before self-hosting, make sure:
- Hydrus Client API is enabled — See Getting Started
- CORS is enabled — Required for browser-to-API communication
- Docker is installed (for Docker deployment) or Node.js 20+ (for local development)
Next steps
- Deploy with Docker — Recommended for most users
- Local development setup — Run and customize locally