Workflow
Ask user for:
- Domain — e.g.,
app.example.com(service name:app_example_com) - Server IP(s)
- Health endpoint — Does app return 200 on
/upwithout auth?
Generate config/deploy.yml
service: {{DOMAIN_UNDERSCORED}}
image: jalen0x/{{DOMAIN_UNDERSCORED}}
servers:
web:
hosts:
- {{SERVER_IP}}
proxy: ssl: true host: {{DOMAIN}}
registry: username: jalen0x password: - KAMAL_REGISTRY_PASSWORD
ssh: user: ubuntu
builder: arch: amd64
## Health Endpoint
App must respond 200 on `/up` at port 80 (default).
**Custom path**: Add `healthcheck.path` to proxy config.
**No health endpoint**: Use Caddy. Copy templates from `assets/` and customize:
- `assets/Caddyfile` → project `Caddyfile`
- `assets/start.sh` → project `start.sh`
Generate Dockerfile:
```dockerfile
FROM {{BASE_IMAGE}}
RUN apk add --no-cache caddy
COPY Caddyfile /Caddyfile
COPY start.sh /start.sh
RUN chmod +x /start.sh
ENTRYPOINT ["/bin/sh", "/start.sh"]
Commands
kamal setup # First-time
kamal deploy # Deploy