docs: correct client env-var prefixes and stale flag/log-path docs - #63
Open
bakerboy448 wants to merge 1 commit into
Open
docs: correct client env-var prefixes and stale flag/log-path docs#63bakerboy448 wants to merge 1 commit into
bakerboy448 wants to merge 1 commit into
Conversation
Reconciled the client docs against the current notifiarr code (v0.9.5 + main).
All changes verified against source:
- commands.md: env vars were `COMMANDS_{n}_*`; the config field is `xml:"command"`
(singular) and the Web UI hardcodes the `DN_` prefix, so the real vars are
`DN_COMMAND_{n}_*`. Added the missing `DN_COMMAND_{n}_SHELL` var and fixed the
shell wrapper: builder.go uses `/bin/sh`, not `/bin/bash`.
- endpoints.md / fileWatcher.md: added the missing `DN_` prefix to every env var
(`DN_ENDPOINT_{n}_*`, `DN_WATCH_FILE_{n}_*`), matching the UI and the existing
healthChecks.md / install.md convention.
- fileWatcher.md: documented that the UI rejects watching the client's own log
file (it would loop); client errors already flow via the `client_error_log`
event (client PR #1300).
- afterInstall.md: FreeBSD log path corrected from `/var/log/syslog` to
`/usr/local/var/log/notifiarr/{app,http,services}.log` (freebsd.rc.d sets
DN_LOG_FILE/DN_HTTP_LOG/DN_SERVICES_LOG_FILE and DN_QUIET=true, so nothing
goes to syslog).
- troubleshooting.md: `--write` never overwrites an existing config; only
`example`/`---` write a default template to `<config>.new`. Added the `-v`
short version flag and the `-w` short form.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reconciles the client docs against the current
notifiarrcode (v0.9.5 + main). Every change was verified against source, not inferred.Env-var prefix corrections
The client's Web UI renders every config env var with the
DN_prefix (frontend/src/includes/Input.svelte:100hardcodes'DN_' + envVar.toUpperCase(),DefaultEnvPrefix = "DN").healthChecks.mdandinstall.mdalready document vars this way; these three pages didn't.COMMANDS_{n}_*, but the config field isxml:"command"(singular), socnfgderivesCOMMAND_{n}_*. Corrected toDN_COMMAND_{n}_*. Also added the missingDN_COMMAND_{n}_SHELLvar (the field exists and is tagged identically to the documented ones), and fixed the shell wrapper:pkg/triggers/commands/builder.go:71uses/bin/sh, not/bin/bash.ENDPOINT_{n}_*→DN_ENDPOINT_{n}_*.WATCH_FILE_{n}_*→DN_WATCH_FILE_{n}_*.Other drift
client_error_logevent. Client PR #1300, backendErrIgnoredLoginpkg/triggers/filewatch/filewatch.go./var/log/syslog; the rc.d unit (init/bsd/freebsd.rc.d) setsDN_LOG_FILE/DN_HTTP_LOG/DN_SERVICES_LOG_FILEunder/usr/local/var/log/notifiarr/andDN_QUIET=true, so nothing reaches syslog. Corrected to/usr/local/var/log/notifiarr/{app,http,services}.log.--writenever overwrites an existing config; onlyexample/---write a default template to<config>.new(pkg/client/cli.go,pkg/configfile/config.gorefuses to overwrite an existing file). Added the-vshort version flag and-wshort form.markdownlint + cspell pass on all five changed files.