Configuration
Describe how a project runs in .homemade/config, or start from a template.
A project's recipe lives in .homemade/config in your repo. It says what to install, which services to run and which ports to publish. If a repo has no config, Homemade suggests one from what it finds, and you can edit it in Project settings → Config. A config in the repo wins over the dashboard.
The file can be config.ts, config.js, config.jsonc or config.json. The first one found is used.
An example
{
"setup": ["pnpm install --frozen-lockfile"],
"install": ["pnpm install --frozen-lockfile"],
"services": {
"db": {
"cmd": "docker start -a pg || docker run --name pg -e POSTGRES_PASSWORD=postgres -p 5432:5432 postgres:17",
"port": 5432,
"healthcheck": { "cmd": "pg_isready -h 127.0.0.1" }
},
"web": {
"cmd": "pnpm dev --hostname 0.0.0.0 --port 3000",
"port": 3000,
"url": true,
"depends_on": { "db": { "condition": "healthy" } }
}
},
"size": "medium",
"sleep_after": "30m"
}Commands
setupruns when the project is built, before your code is copied in. Only dependency files such aspackage.jsonand lockfiles exist at that point.warmupruns once when the project is built, so new VMs start with its results already in place.installruns on each new VM, with your repo present, before services start.
Services
Each entry under services is a long-running process with its own terminal.
| Key | What it does |
|---|---|
cmd | The command to run. |
port | The port the service listens on. |
url | true gives the service a preview link. Needs a port. |
share | public, authenticated (Organization) or owner. Default public. |
autostart | Start the service when the VM starts. Default true. |
healthcheck | A path or a cmd that tells when the service is up. |
depends_on | Services to wait for, by name, until they are healthy or started. |
displayName, icon, order, hidden | How the service shows in the dashboard. |
signInUrl | A sign-in link shown under the service. |
A repo can use compose to run a Docker compose file instead of services, but not both.
Other settings
size: the machine size for the project's VMs. See Projects and VMs.sleep_after: when VMs sleep, like"30m","2h"or"never". See Sleep and wake.env_schema: the environment variable names the project expects. An entry can set adefault, orgenerate: truefor a random secret made once per VM.network: limits on outgoing and incoming traffic.agent: instructions and skills for coding agents. See AI tools.editor:{ "enabled": true }turns on the browser editor.
Templates
A template is a ready app you can start a project from. Pick one under New project → Template. The recipe comes with it, so the project builds and runs with no setup.
Starters: Next.js, Vite + React, Astro, Django, Go API, Bun + Hono, T3 stack, Next.js + Supabase, Payload CMS, Django + Celery, Rails, Laravel, Phoenix, and Open WebUI + Ollama.
Apps: OpenClaw, nanobot, T3 Code, OpenCode, CloudCLI, Coolify and Dokploy. Each VM gets the app's latest release.
Templates run the app's dev server, so edits show up as you save them.