Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(infra): describe builtInSet as the saved mode the config states

Yudhi Armyndharis90785dc01a68
diff --git a/dashboard/src/services/api.ts b/dashboard/src/services/api.ts
index 057dc747c..d134fcb34 100644
--- a/dashboard/src/services/api.ts
+++ b/dashboard/src/services/api.ts
@@ -655,8 +655,9 @@ export interface SavedConfig {
database: {
type: 'sqlite' | 'postgres';
builtIn: boolean;
- // Whether the flag is stored (saved file or environment). A deployment that pins the bundled host never
- // writes it, and `builtIn` is then false only because nothing says otherwise: /infra/status has what runs.
+ // Whether the saved config states the built-in mode of this service. False when a host the environment
+ // pins decides it, when the file does not select the service (the first boot writes every flag as false)
+ // and when nothing is saved: the form then follows what /infra/status reports as running.
builtInSet: boolean;
host: string;
port: string;
diff --git a/docs/06-api-specification.md b/docs/06-api-specification.md
index 21c661564..c31458707 100644
--- a/docs/06-api-specification.md
+++ b/docs/06-api-specification.md
@@ -5651,7 +5651,7 @@ Read the effective infrastructure config used to hydrate the dashboard form. Eac
}
```
-`builtInSet` says whether each `builtIn` flag is stored (in the saved file or pinned by the environment). A Compose deployment that pins `DATABASE_HOST=postgres`, `REDIS_HOST=redis` or `S3_ENDPOINT` in `.env` never writes the flag, so there `builtIn` is `false` only because nothing says otherwise: read what runs from `GET /api/infra/status`.
+`builtInSet` says whether the saved configuration states the built-in mode of the database, Redis or storage. It is `false` when a host pinned by the environment (`DATABASE_HOST`, `REDIS_HOST`, `S3_ENDPOINT`) decides the mode, in which case `builtIn` reports the pin (`true` for the bundled host `postgres`, `redis` or `http://minio:9000`), when the saved file does not select the service (the first boot writes every flag as `false` next to a service that is not in use), and when nothing is saved. Read what runs from `GET /api/infra/status` then. A flag pinned by the environment itself counts as stated.
When nothing supplies a key — no pinned environment value and the file absent or silent about it — empty-string/default values are returned (`schema='public'`, `poolSize=10`, `sslRejectUnauthorized=true`, `engine.type='whatsapp-web.js'`, `headless=true`).