Haloy Config

Haloy Configuration

Create haloy.yaml configuration files for deploying applications with haloy.

If no Dockerfile exists and the user does not already have a published image to deploy, inform them:

"No Dockerfile found in this project, and I don't see an existing image to deploy. Haloy can either build from a Dockerfile or deploy a published image. Would you like me to create a Dockerfile using the dockerize skill?"

How It Works

1. Check for Dockerfile or an existing published image - Decide whether the app should use Haloy's default local build flow or explicit image configuration
2. Check for configured haloy servers - Look for existing server configurations
3. Detect the project type by examining:
   • package.json with framework dependencies (Next.js, TanStack Start, Express, etc.)
   • pyproject.toml, requirements.txt, Pipfile (Python/Django/FastAPI)
   • go.mod (Go)
   • Cargo.toml (Rust)
   • Gemfile (Ruby/Rails)
   • composer.json (PHP/Laravel)
4. Detect database dependencies (Prisma, Drizzle, pg, SQLAlchemy, etc.)
5. Infer defaults for app name, port, health check path, and image strategy
6. Ask the user for server (from configured list or manual entry) and domain
7. If explicit image configuration is needed, gather the minimal extra image details
8. If database detected, ask if they want self-hosted or external
9. Generate haloy.yaml with appropriate configuration
10. Provide next steps for validation and deployment

Project Detection

Detect the framework to determine the default port:

Also check the Dockerfile for EXPOSE directives which override framework defaults.

Database Detection

Scan for database dependencies to determine if the project uses a database:

Prisma schema example - look for the provider:

datasource db {
  provider = "postgresql"  // or "mysql", "sqlite"
  url      = env("DATABASE_URL")
}

Decision Flow

Use defaults unless a critical value is missing. Only ask the user when necessary.

App Name

• First choice: name field in package.json
• Second choice: Project folder name
• Ask if: Name contains invalid characters or is generic (e.g., "app", "project")

Image Strategy

Prefer the simplest valid image configuration for the user's setup.

1. Default local build:

   • If a Dockerfile exists at the project root and the user did not ask for a published image, registry auth, custom Dockerfile path, custom build context, or multiple target-specific images, use the minimal Haloy config and omit image entirely.
   • This matches Haloy's default flow: it looks for a Dockerfile in the same directory, builds locally, and uploads to the server.

2. Ask about image details only when needed:

   • No Dockerfile exists
   • The user mentions an existing/published image, Docker Hub, GHCR, ECR, or a private registry
   • The Dockerfile is not in the config directory or the project is a monorepo and needs a custom build context
   • Multiple targets need different images (for example, web and worker)
   • The user explicitly wants registry push behavior or rollback/history settings

3. For single-image deployments with an existing image:

   • Use string shorthand when only the repository/tag is needed:

     image: "ghcr.io/acme/my-app:v1.2.3"
     

   • Use object form only when you need tag, registry, history, or build_config.
   • Omit registry.server unless Haloy cannot infer it from the repository host.

4. For local builds that need explicit image config:

   • Use image.build_config when the Dockerfile or build context is not the default.
   • Use the current field names from the docs:

     image:
       build_config:
         context: "."
         dockerfile: "Dockerfile"
     

   • Paths are relative to the directory containing haloy.yaml.
   • Prefer omitting build_config.push; Haloy auto-detects the common server vs registry cases.
   • If the same value is needed both at runtime and as a build argument, prefer env[].build_arg: true over duplicating it in build_config.args.

5. For multi-target setups:

   • Use root image when every target should inherit the same image defaults.
   • Use root images plus target image_key when targets need different images.
   • A target may define either image or image_key, never both.
   • Resolution priority is: target image -> target image_key -> root image.

6. If there is no Dockerfile and no published image:

   • Recommend the dockerize skill instead of inventing an image configuration.

Server URL

Check for configured servers in ~/.config/haloy/client.yaml:

# Example client.yaml structure
servers:
  example.haloy.dev:
    token_env: HALOY_API_TOKEN_example_HALOY_DEV
  prod.mycompany.com:
    token_env: HALOY_API_TOKEN_PROD

Decision flow:

1. If servers found: Present them as options and let the user choose. The server keys (e.g., example.haloy.dev) are the values to use in the config.

   "I found these configured haloy servers. Which one would you like to deploy to?"

   • example.haloy.dev
   • prod.mycompany.com
   • Enter a different server

2. If no servers found: Check if haloy CLI is installed by running which haloy or haloy --version

   • If haloy is installed: Ask for the server URL manually

     "What is your haloy server URL? (e.g., haloy.yourserver.com)"

   • If haloy is not installed: Inform the user they need to install and configure the CLI first

     "No haloy servers configured. To deploy with haloy, you'll need to install the CLI and add a server. See: https://haloy.dev/docs/client-installation"

Domain

• Always ask - Required for web applications
• Example prompt: "What domain should this app be accessible at? (e.g., myapp.example.com)"
• If user says "none" or "skip", omit the domains section

Domain Aliases

• Ask after domain: Once the user provides a domain, ask if they want to add any aliases
• Example prompt: "Would you like to add any domain aliases? (e.g., www.myapp.example.com)"
• Common alias: www. prefix of the main domain
• If user says "none" or "skip", omit the aliases

DNS Reminder

After gathering domain information, remind the user to configure DNS:

"Remember to configure DNS with your domain provider. Point your domain(s) to your haloy server's IP address using an A record, or use a CNAME record if your server has a domain name."

Port

• Use framework default from the table above
• Check Dockerfile for EXPOSE directive which takes precedence
• Ask only if: Multiple ports exposed or no clear default

Health Check Path

• Search for existing endpoints: /health, /healthz, /api/health, /_health
• If found: Use the existing health endpoint
• If not found: Use / (root path)
• Do NOT ask - haloy will use / by default which works for most apps

Database

If database dependencies are detected (see Database Detection section):

1. Ask the user:

   "I detected database dependencies ([detected type]). Would you like to add a self-hosted database service, or will you use an external provider (Supabase, Neon, RDS, etc.)?"

   • Add self-hosted database
   • Use external provider (I'll configure DATABASE_URL myself)

2. If self-hosted:

   • Generate multi-target config with database service + app target
   • Use the database preset for the database target
   • Add appropriate environment variables with placeholder values unless the user already has them in env files or secret providers
   • Add volume for data persistence
   • Prefer string shorthand for simple database images unless more image fields are needed
   • Note that preset: database applies safer defaults, including image.history.strategy: "none"
   • Database defaults by type:

   Database	Image	Port	Volume Path
   PostgreSQL	postgres:18	5432	/var/lib/postgresql
   MySQL	mysql:8	3306	/var/lib/mysql

   • Image data paths vary by image and version. If the user changes the image, verify the correct mount path in that image's documentation.

3. If external provider:

   • Generate single-target config as usual
   • Remind user: "Remember to set the DATABASE_URL environment variable for your external database."

Configuration Reference

Haloy supports two modes:

1. Single Deployment: No targets defined, root configuration is the deployment target
2. Multi-Target: targets defined, root acts as base/default configuration

Minimal Configuration (Single Deployment)

name: "my-app"
server: "haloy.yourserver.com"

This is the default choice when the project already has a root Dockerfile and does not need custom image settings.

With Domain and Port

name: "my-app"
server: "haloy.yourserver.com"
domains:
  - domain: "my-app.example.com"
    aliases:
      - "www.my-app.example.com"
port: "3000"
health_check_path: "/health"

With a Published Image

name: "my-app"
server: "haloy.yourserver.com"
image: "ghcr.io/acme/my-app:v1.2.3"
domains:
  - domain: "my-app.example.com"
port: 3000

With a Custom Local Build

name: "my-app"
server: "haloy.yourserver.com"
image:
  repository: "my-app"
  tag: "latest"
  build_config:
    context: "."
    dockerfile: "./apps/web/Dockerfile"
domains:
  - domain: "my-app.example.com"
port: 3000

With Environment Variables

name: "my-app"
server: "haloy.yourserver.com"
domains:
  - domain: "my-app.example.com"
port: "3000"
env:
  - name: "NODE_ENV"
    value: "production"
  - name: "DATABASE_URL"
    value: "postgres://user:pass@db:5432/myapp"

With Volumes (for persistent data)

name: "my-app"
server: "haloy.yourserver.com"
domains:
  - domain: "my-app.example.com"
volumes:
  - "app-data:/app/data"

With Self-Hosted Database (Multi-Target)

server: "haloy.yourserver.com"
env:
  - name: POSTGRES_USER
    value: "postgres"
  - name: POSTGRES_PASSWORD
    value: "change-me-in-production"
  - name: POSTGRES_DB
    value: "my_app"

targets:
  postgres:
    preset: database
    image: "postgres:18"
    port: 5432
    volumes:
      - postgres-data:/var/lib/postgresql

  my-app:
    domains:
      - domain: "my-app.example.com"
    port: 3000
    env:
      - name: DATABASE_URL
        value: "postgres://postgres:change-me-in-production@postgres:5432/my_app"
      - name: NODE_ENV
        value: "production"

Named Images With image_key

name: "my-app"
server: "haloy.yourserver.com"
images:
  web:
    repository: "my-app-web"
    tag: "v1.2.3"
  worker: "my-app-worker:v1.2.3"

targets:
  production:
    image_key: "web"
    domains:
      - domain: "my-app.example.com"
    port: 3000

  jobs:
    image_key: "worker"

Multi-Target Example

# Base settings inherited by all targets
image:
  repository: "my-app"
  tag: "latest"
  build_config:
    context: "."
    dockerfile: "Dockerfile"
port: 3000

targets:
  production:
    server: "prod.haloy.com"
    domains:
      - domain: "my-app.com"
    replicas: 2
  staging:
    server: "staging.haloy.com"
    domains:
      - domain: "staging.my-app.com"
    replicas: 1

Full Reference

For all configuration options, see: https://haloy.dev/docs/configuration-reference

Key options:

• name - Application name (required for single deployment)
• server - Haloy server URL (required)
• image - Docker image configuration for the default/single target; supports string shorthand or object form
• images - Root map of named images for multi-target deployments
• image_key - Target-level reference to a named image in images
• image.build_config - Local build settings: context, dockerfile, platform, args, and optional push
• image.registry - Registry authentication for private images or registry pushes
• image.history - Rollback strategy (local, registry, or none)
• domains - Array of domain objects with domain and optional aliases
• port - Container port (default: "8080")
• health_check_path - Health check endpoint (default: "/")
• env - Environment variables as name/value pairs
• volumes - Volume mounts for persistent data
• replicas - Number of container instances (default: 1)
• deployment_strategy - "rolling" (default) or "replace"
• targets - Define multiple deployment targets (multi-target mode)
• preset - Apply preset configuration ("database" or "service")

Output Format

After gathering information, create the haloy.yaml file and provide:

1. The haloy.yaml file - Written to the project root
2. Update .dockerignore - Add haloy.yaml to .dockerignore if not already present. This improves Docker layer caching since changes to haloy.yaml won't invalidate the build cache.
3. Validation command:

   haloy validate-config
   

4. Deployment command:

   haloy deploy
   

5. If haloy CLI is not installed, show installation options:

   # Shell script
   curl -fsSL https://sh.haloy.dev/install-haloy.sh | sh
   
   # Homebrew
   brew install haloydev/tap/haloy
   
   # npm/pnpm/bun
   npm install -g haloy
   pnpm add -g haloy
   bun add -g haloy
   

Example Interactions

See references/examples.md for detailed interaction examples covering:

• Deploying with configured servers
• Database detection and self-hosted database setup
• Handling missing server configuration