Align documented config default path with deployment path #15

Closed
opened 2026-05-11 18:52:28 +02:00 by heiko · 4 comments
Owner

Problem

The code defaults to /etc/xrechnung-scanner/, while the systemd deployment uses /etc/xr-invoiced/config.yaml explicitly.

References:

  • internal/config/config.go:41
  • doc/admin.md:66
  • CLAUDE.md:23
  • deploy/xr-invoiced.service:11

This is confusing for manual runs and documentation, because the project and service name now use xr-invoiced.

Expected

Default config path and docs should consistently describe the intended path, or docs should clearly state that systemd passes a non-default --config path.

Suggested fix

Change the default config search path to /etc/xr-invoiced/ or update docs to distinguish legacy/default search path from the deployment path.

## Problem The code defaults to `/etc/xrechnung-scanner/`, while the systemd deployment uses `/etc/xr-invoiced/config.yaml` explicitly. References: - `internal/config/config.go:41` - `doc/admin.md:66` - `CLAUDE.md:23` - `deploy/xr-invoiced.service:11` This is confusing for manual runs and documentation, because the project and service name now use `xr-invoiced`. ## Expected Default config path and docs should consistently describe the intended path, or docs should clearly state that systemd passes a non-default `--config` path. ## Suggested fix Change the default config search path to `/etc/xr-invoiced/` or update docs to distinguish legacy/default search path from the deployment path.
Author
Owner

Branch renamed per convention:

Old: regression/issue-15-config-path-docs
New: fix/15-config-path-docs

The old remote branch has been deleted.

Branch renamed per convention: Old: regression/issue-15-config-path-docs New: fix/15-config-path-docs The old remote branch has been deleted.
Author
Owner

Fix branch pushed: fix/15-config-path-docs-claude

Replaces /etc/xrechnung-scanner/ with /etc/xr-invoiced/ in config.go, doc/admin.md, and adds CLAUDE.md to git with the corrected path. Regression test passes.

Fix branch pushed: [fix/15-config-path-docs-claude](https://forgejo.schlittermann.de/IUS/xr-invoiced/src/branch/fix/15-config-path-docs-claude) Replaces /etc/xrechnung-scanner/ with /etc/xr-invoiced/ in config.go, doc/admin.md, and adds CLAUDE.md to git with the corrected path. Regression test passes.
Author
Owner

Implementation branch: fix/15-config-path-docs-codex

Implementation branch: [fix/15-config-path-docs-codex](https://forgejo.schlittermann.de/IUS/xr-invoiced/src/branch/fix/15-config-path-docs-codex)
Author
Owner

Fixed in 5c512f4 and merged by fe28af9. The documented and configured default path now uses /etc/xr-invoiced/config.yaml, and config_path_docs_regression_test.go covers the alignment.

Fixed in 5c512f4 and merged by fe28af9. The documented and configured default path now uses /etc/xr-invoiced/config.yaml, and config_path_docs_regression_test.go covers the alignment.
heiko closed this issue 2026-05-13 14:08:48 +02:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
IUS/xr-invoiced#15
No description provided.