README
¶
Haloy
Haloy is a lightweight deployment and orchestration system designed for developers who want a simple, reliable way to deploy Docker‑based applications to their own servers.
Features
- Own your infrastructure – Deploy to any Linux server you control.
- Simple config – One
haloy.yamldescribes your app, domains, and routes. - Docker-native – Builds and deploys from your existing Dockerfile.
- TLS & domains – Automated HTTPS via ACME / Let’s Encrypt.
- Batteries included – Single CLI for setup, deploy, and status.
- Secure - Built-in secret management
Quickstart
Prerequisites
- Server: Any modern Linux server
- Local: Docker for building your app
- Domain: A domain or subdomain pointing to your server for secure API access
1. Install haloy
Install script:
curl -fsSL https://sh.haloy.dev/install-haloy.sh | sh
Homebrew (macOS / Linux):
brew install haloydev/tap/haloy
npm/pnpm/bun
npm i -g haloy
pnpm add -g haloy
bun add -g haloy
2. Server Setup
SSH into your server and run the install script with your API domain:
curl -fsSL https://sh.haloy.dev/install-haloyd.sh | API_DOMAIN=haloy.yourserver.com sh
Note: If you're not logged in as root, use | sudo sh instead of | sh.
After installation completes, copy the API token from the output and add the server to your local machine:
haloy server add haloy.yourserver.com <token>
For detailed options, see the Server Installation guide.
3. Create haloy.yaml
Create a haloy.yaml file:
name: "my-app"
server: haloy.yourserver.com
domains:
- domain: "my-app.com"
aliases:
- "www.my-app.com" # Redirects to my-app.com
This will look for a Dockerfile in the same directory as your config file, build it and upload it to the server. This is the Haloy configuration in its simplest form.
Check out the examples repository for complete configurations showing how to deploy common web apps like Next.js, TanStack Start, static sites, and more.
4. Deploy
haloy deploy
# Check status
haloy status
That's it! Your application is now deployed and accessible at your configured domain.
Directories