0ac46ecadb
Coolify does not interpolate ${...} inside the labels: block, so the
two strings tying this template to its specific Coolify resource cannot
currently be variables. Document where they appear and how to swap
them when redeploying as a new resource.
49 lines
2.5 KiB
Markdown
49 lines
2.5 KiB
Markdown
# coolcouch
|
|
|
|
CouchDB 3 on Coolify. The `couchdb-init` sidecar waits for the server to come up, creates the three system databases, and enables CORS via the config API — no file mounts required.
|
|
|
|
## Deploy
|
|
|
|
1. In Coolify: **New Resource → Docker Compose** and point it at this repository.
|
|
2. In the resource's **Environment Variables** tab, set:
|
|
- `COUCHDB_PASSWORD` — required
|
|
- `COUCHDB_USER` — optional, defaults to `admin`
|
|
3. In the resource's **Domains** tab, assign a domain to the `couchdb` service on port `5984`. Coolify fills `SERVICE_FQDN_COUCHDB_5984` from this.
|
|
4. **Deploy.** `couchdb-init` runs once, exits, and won't restart.
|
|
|
|
## Verify
|
|
|
|
Replace `$DOMAIN` and `$PASS`:
|
|
|
|
```bash
|
|
curl -fsS https://$DOMAIN/_up
|
|
curl -fsS -u admin:$PASS https://$DOMAIN/
|
|
curl -fsS -u admin:$PASS https://$DOMAIN/_all_dbs
|
|
curl -fsS -I -X OPTIONS https://$DOMAIN/ \
|
|
-H "Origin: https://example.com" \
|
|
-H "Access-Control-Request-Method: GET"
|
|
```
|
|
|
|
Expected: `_up` returns `{"status":"ok",...}`; `/` returns the CouchDB welcome JSON; `_all_dbs` returns `["_global_changes","_replicator","_users"]`; the preflight returns 2xx with an `Access-Control-Allow-Origin` header.
|
|
|
|
If the init logs show CORS errors, you can re-trigger only that step by redeploying — the PUTs against `/_node/_local/_config/...` are idempotent.
|
|
|
|
## CORS
|
|
|
|
Wildcard origin (`*`) with `credentials = false` — the only browser-spec-legal combination with a wildcard. For credentialed auth from the browser, edit the `put_config cors origins`/`credentials` lines in `docker-compose.yml`.
|
|
|
|
## Hardcoded values (cloning to another Coolify resource)
|
|
|
|
Two strings in `docker-compose.yml` are pinned to this specific Coolify deployment and must be updated if you redeploy as a new resource:
|
|
|
|
- The host in `traefik.http.routers.coolcouch.rule=Host(`couch.apoena.dev`)`
|
|
- The per-resource Coolify network name, appearing twice: `traefik.docker.network=lvw8efvnvsxduodrkg68zul3` and `networks.coolify.name: lvw8efvnvsxduodrkg68zul3`
|
|
|
|
They're hardcoded because Coolify does not interpolate `${...}` inside the `labels:` block (it does inside `environment:` and `networks.<name>.name:`). The network UUID matches `COOLIFY_RESOURCE_UUID` for the resource — find it in Coolify's UI or in `docker network ls` after first deploy.
|
|
|
|
A `sed` swap before push, or a Coolify "Custom Build Command" running `sed -i` over the file, is the simplest way to keep this template portable.
|
|
|
|
## Files
|
|
|
|
- `docker-compose.yml` — services, volume, Traefik labels, init sidecar
|