Skip to main content
Version: Next (nightly)

Install and startup

One container is unhappy and the rest wait on it. The db starts, api runs migrations against it, and web proxies to api, so a failure upstream leaves the containers below it stuck. Read from the bottom of the chain up: start with docker compose logs db, then api.

The api container restart-loops on a config error​

The log names the offending value:

Invalid environment:
JWT_SECRET: String must contain at least 16 character(s)
  1. Set the named value in .env. Two secrets are required and must each be at least 16 characters: JWT_SECRET and TENANT_CREDS_ENCRYPTION_KEY.

  2. Regenerate the file with the setup builder, or set a strong value yourself:

    openssl rand -hex 32
  3. Before you replace TENANT_CREDS_ENCRYPTION_KEY, read the warning in Data and backups: once it has encrypted stored credentials, changing it makes those unreadable.

Why it exits, and why a value goes blank

On startup the api validates its environment and exits if anything required is missing or malformed. That is deliberate: a half-configured instance fails loudly at boot rather than misbehaving later. The builder generates both secrets, so a blank or truncated value usually means the .env was hand-edited or a copy-paste dropped characters.

A migration failed on boot​

The container restart-loops, and docker compose logs api shows which migration file failed and the SQL error under it.

  1. Check df -h for space. A disk that filled mid-migration is a usual cause.
  2. Confirm you pulled the current images (docker compose pull). An image and a data directory from mismatched versions is another.
  3. Read the SQL error in the log. A hand-modified database is the third usual cause.
  4. Since your data is in ./data/db, you can restore a pre-update copy and try again (see Data and backups).
How migrations run

Database migrations run automatically when the api container starts, before it serves any request. Each migration runs in its own transaction, so a failure rolls itself back and the api exits rather than leaving the schema half-applied. On a stock install this should not happen, because migrations are tested against the schema they ship with.

Port already in use​

docker compose up reports a bind error because some other process holds the port the web container wants (8088 by default):

Error: ... failed to bind host port 0.0.0.0:8088 ... address already in use

Either stop whatever holds it, or move Cobblr to a free port:

  1. Set WEB_PORT in .env:

    WEB_PORT=8090
  2. Bring the stack back up:

    docker compose up -d
  3. Open the box at the new port.

See what else is listening with sudo lsof -i :8088 (or ss -ltnp | grep 8088).

Image pull is denied or unauthorized​

Error response from daemon: ... denied / unauthorized

The images are public, so a pull needs no login and no account. That message almost always means the image reference is wrong rather than that you lack access.

  1. Check the image lines in your docker-compose.yml against the one the setup builder generated.

  2. Check COBBLR_VERSION in your .env is a tag that exists (stable, nightly, or a release like 2026.8.0). A typo there reads to the registry as an image you cannot see.

  3. If the reference is right, the box may be behind a proxy or a firewall that blocks ghcr.io. Test the path on its own:

    docker pull ghcr.io/cobblrhq/cobblr-api:stable
  • The one case where a login is genuinely required: if you were given access to a private pre-release lane, docker login ghcr.io with your GitHub username and a personal access token carrying the read:packages scope.

Nothing is obviously wrong, but the page won't load​

Check the order of the chain.

  1. docker compose ps should show db healthy, api up, and web up.
  2. If web is up but the browser shows nothing, the api may still be finishing migrations on a first run. Give it a moment and re-run the health check.
  3. If you run HTTPS, the caddy container also has to be up and to have a certificate. That path is covered in HTTPS and access.