From 54cb881c8cd53e65bb7a65e87488afbbf3015d90 Mon Sep 17 00:00:00 2001 From: "Jakub A. W" Date: Sun, 19 Jul 2026 19:40:20 +0200 Subject: [PATCH] docs: drop audit-logging flags that are now defaults LOGGING_ENABLED / LOGGING_LOG_BODIES / LOGGING_LOG_HEADERS default to true since #554, so the quickstart commands (README, docs quickstart, docker-compose) no longer need to set them; prose that said audit data "requires LOGGING_ENABLED=true" now says it is on by default. LOG_FORMAT=text stays - containers still auto-detect to JSON without it. The release-e2e harness keeps its explicit pins on purpose: it runs across releases, including ones predating the new defaults. Co-Authored-By: Claude Fable 5 --- README.md | 3 --- docker-compose.yaml | 3 +-- docs/advanced/admin-endpoints.mdx | 4 ++-- docs/features/labelling.mdx | 4 ++-- docs/getting-started/quickstart.mdx | 3 --- 5 files changed, 5 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 6c96e8399..06700694f 100644 --- a/README.md +++ b/README.md @@ -36,10 +36,7 @@ ```bash docker run --rm -p 8080:8080 \ - -e LOGGING_ENABLED=true \ - -e LOGGING_LOG_BODIES=true \ -e LOG_FORMAT=text \ - -e LOGGING_LOG_HEADERS=true \ -e OPENAI_API_KEY="your-openai-key" \ enterpilot/gomodel ``` diff --git a/docker-compose.yaml b/docker-compose.yaml index 4e5f24d1d..748d4499a 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -21,8 +21,7 @@ services: - POSTGRES_URL=postgres://gomodel:gomodel@postgres:5432/gomodel # MongoDB configuration (uncomment to use MongoDB instead) - MONGODB_URL=mongodb://mongodb:27017/gomodel - # Audit logging - all enabled with PostgreSQL - - LOGGING_ENABLED=true + # Audit logging is enabled by default; pick its storage backend below # - STORAGE_TYPE=postgresql - STORAGE_TYPE=mongodb depends_on: diff --git a/docs/advanced/admin-endpoints.mdx b/docs/advanced/admin-endpoints.mdx index 2f4b0ba5c..2e146cbce 100644 --- a/docs/advanced/admin-endpoints.mdx +++ b/docs/advanced/admin-endpoints.mdx @@ -128,8 +128,8 @@ Returns an empty array if usage tracking is disabled or no data exists for the p Returns time-bucketed request counts grouped into `2xx`/`4xx`/`5xx` status classes, an overall success-rate summary, and average request duration per provider. This powers the "Requests by Status" and "Provider Latency" charts on -the dashboard's Overview page. Data comes from the audit log, so it requires -`LOGGING_ENABLED=true`. +the dashboard's Overview page. Data comes from the audit log (audit logging is enabled by default; +`LOGGING_ENABLED`). **Query parameters:** diff --git a/docs/features/labelling.mdx b/docs/features/labelling.mdx index 74c090fe1..c63e5cab4 100644 --- a/docs/features/labelling.mdx +++ b/docs/features/labelling.mdx @@ -97,8 +97,8 @@ routes; translated routes never forward client headers anyway. each of them. - **Request log** — label chips per request, filterable with the `label` query param on `GET /admin/usage/log`. -- **Audit logs** — recorded under `data.labels` on each entry (requires - `LOGGING_ENABLED=true`). +- **Audit logs** — recorded under `data.labels` on each entry (audit logging is enabled + by default). - **API keys page** — each key's labels are listed alongside its user path. ## Defaults diff --git a/docs/getting-started/quickstart.mdx b/docs/getting-started/quickstart.mdx index 25b0ea4e0..371c0b953 100644 --- a/docs/getting-started/quickstart.mdx +++ b/docs/getting-started/quickstart.mdx @@ -15,10 +15,7 @@ admin visibility in one place. ```bash docker run --rm -p 8080:8080 \ - -e LOGGING_ENABLED=true \ - -e LOGGING_LOG_BODIES=true \ -e LOG_FORMAT=text \ - -e LOGGING_LOG_HEADERS=true \ -e GOMODEL_MASTER_KEY="change-me" \ -e OPENAI_API_KEY="sk-..." \ enterpilot/gomodel