47 lines
2.3 KiB
Markdown
47 lines
2.3 KiB
Markdown
# Weatherreporter Configuration
|
|
|
|
Configuration is loaded from `/usr/local/etc/weatherreporter/config.yml` by
|
|
default. Use `--config PATH` to load a different file. CLI flags override file
|
|
values.
|
|
|
|
If the default file is absent, built-in defaults are used.
|
|
|
|
## Minimal Config
|
|
|
|
```yaml
|
|
weather_api:
|
|
base_url: https://weather.api.example.com/
|
|
```
|
|
|
|
## Production-Oriented Config
|
|
|
|
See [examples/config.yml](../examples/config.yml).
|
|
|
|
## Reference
|
|
|
|
- `weather_api.base_url`: single Weather API endpoint base URL, required when fetching weather data.
|
|
- `weather_api.timeout`: HTTP timeout duration. Default: `10s`.
|
|
- `weather_api.precision`: numeric precision hint. Default: `1`.
|
|
- `weather_api.units`: Weather API units. Default: `us`.
|
|
- `weather_api.timezone`: report timezone. Accepts IANA names, configured aliases such as `Chicago` and `Stl`, US timezone abbreviations, and UTC offsets such as `-5` or `+09:30`. Default: `Chicago`.
|
|
- `weather_api.format`: Weather API response format. Default: `json`.
|
|
- `missing_source.default`: one of `error`, `warn`, or `none`. Default: `warn`.
|
|
- `missing_source.sources`: optional per-source missing-source policy overrides.
|
|
- `scriptorium.binary`: `scriptorium` executable name. Default: `scriptorium`.
|
|
- `scriptorium.config_path`: optional `scriptorium` config path.
|
|
- `scriptorium.profile`: optional `scriptorium` profile.
|
|
- `scriptorium.timeout`: subprocess timeout. Default: `2m`.
|
|
- `scriptorium.extra_args`: optional extra arguments reserved for the adapter.
|
|
- `workspace.root`: workspace root. Default: `workspace`.
|
|
- `workspace.snapshots_dir`: snapshot directory under the workspace.
|
|
- `workspace.reports_dir`: managed report directory under the workspace.
|
|
- `workspace.data_packages_dir`: prompt input package directory under the workspace.
|
|
- `workspace.preflight_dir`: preflight output directory under the workspace.
|
|
- `reports.output_dir`: report output directory. Default: `reports`.
|
|
- `reports.paths`: optional report-specific output paths.
|
|
- `dayparts`: named daypart definitions with `start` and `end` `HH:MM` values.
|
|
- `recent_change.temperature_degrees`: temperature change threshold.
|
|
- `recent_change.precip_probability_points`: precipitation probability threshold.
|
|
- `recent_change.wind_gust_miles_per_hour`: wind gust change threshold.
|
|
- `recent_change.precip_timing_shift_minutes`: precipitation timing shift threshold.
|