danvics/Pulse
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Fix CONFIGURATION.md - logFormat not in system.json

Browse source 
The logFormat setting is only available via LOG_FORMAT environment
variable, not in system.json. Updated the example and added a note
clarifying this. Also added LOG_FORMAT to the environment variables
table.
This commit is contained in:
rcourtman 2025-12-02 23:43:45 +00:00
parent e3079b6ac7
commit 8fd891a921
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/CONFIGURATION.md
View file

@ -63,14 +63,15 @@ Controls runtime behavior like ports, logging, and polling intervals. Most of th
```json ```json
{ {
"pvePollingInterval": 10, // Seconds "pvePollingInterval": 10, // Seconds
"backendPort": 3000, // Internal port "backendPort": 3000, // Internal port (default: 3000)
"frontendPort": 7655, // Public port "frontendPort": 7655, // Public port
"logLevel": "info", // debug, info, warn, error "logLevel": "info", // debug, info, warn, error
"logFormat": "auto", // auto, json, console "autoUpdateEnabled": false, // Enable auto-update checks
"autoUpdateEnabled": false, // Enable auto-updates
"adaptivePollingEnabled": true // Smart polling for large clusters "adaptivePollingEnabled": true // Smart polling for large clusters
} }
``` ```
> **Note**: `logFormat` is only configurable via the `LOG_FORMAT` environment variable, not in `system.json`.
</details> </details>
### Common Overrides (Environment Variables) ### Common Overrides (Environment Variables)
@ -80,6 +81,7 @@ Environment variables take precedence over `system.json`.
|----------|-------------|---------| |----------|-------------|---------|
| `FRONTEND_PORT` | Public listening port | `7655` | | `FRONTEND_PORT` | Public listening port | `7655` |
| `LOG_LEVEL` | Log verbosity (`debug`, `info`, `warn`, `error`) | `info` | | `LOG_LEVEL` | Log verbosity (`debug`, `info`, `warn`, `error`) | `info` |
| `LOG_FORMAT` | Log output format (`auto`, `json`, `console`) | `auto` |
| `PULSE_PUBLIC_URL` | Public URL for notifications/OIDC | `""` | | `PULSE_PUBLIC_URL` | Public URL for notifications/OIDC | `""` |
| `ALLOWED_ORIGINS` | CORS allowed domains | `""` (Same origin) | | `ALLOWED_ORIGINS` | CORS allowed domains | `""` (Same origin) |
| `DISCOVERY_ENABLED` | Auto-discover nodes | `false` | | `DISCOVERY_ENABLED` | Auto-discover nodes | `false` |