Quickstart

This guide will walk you through setting up Haloy and deploying your first application.

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

curl -fsSL https://sh.haloy.dev/install-haloy.sh | sh

brew install haloydev/tap/haloy

npm i -g haloy

pnpm add -g haloy

bun add -g haloy

2. Server Setup

Use the server setup command to provision your server automatically. This command will SSH into your server as root (default), install Docker if needed, install haloyadm, and configure the remote haloyd service.

haloy server setup <server-ip> --api-domain haloy.yourserver.com --acme-email you@email.com

Note: This command requires SSH access to the root user on the server. If you don’t have this or if you prefer to install manually, check 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.

Next Steps