Skip to content

vibe.json

vibe.json lives in the project root. The first deploy creates it; commit it so everyone, and CI, deploys to the same app.

{
"name": "notes",
"port": 3000,
"volume": true,
"databases": ["notes-db"]
}
Key Type Default
name string folder name App name and subdomain <name>.tja.nrw. 1 to 32 lowercase letters, digits and dashes, starting with a letter.
port number EXPOSE or 8080 Port, for apps that ignore $PORT.
volume true or object none A 2 GB volume. true means {"mountPath": "/data"}.
volume.mountPath string /data Absolute path; not /, /app, /tmp, /home, /var, /opt, /srv or a system directory.
databases string[] none Databases to link on every deploy.

Command-line options override the file: --name, --port. --volume and --link-db add to it.

A size for the volume is rejected; every volume is 2 GB.