Skip to content

config: fix reference config entries that differ from the defaults - #2406

Merged
pbiering merged 3 commits into
Kozea:masterfrom
rawsun007:config-reference-defaults
Nov 20, 2026
Merged

pbiering merged 3 commits into
Kozea:masterfrom
rawsun007:config-reference-defaults

Conversation

@rawsun007

Copy link
Copy Markdown
Contributor

Some commented lines in the reference config did not match the defaults in radicale/config.py, or broke when uncommented:

  • [auth] uc_username was missing. It is the only [auth] option not listed there. The comment also notes that it is mutually exclusive with lc_username, since enabling both raises at startup.
  • Three examples carried literal quotes, which the config parser keeps. group_collections_folder = "GROUPS" used a folder named "GROUPS". conversion_bday_alarm_trigger_template = "", and the quoted example above it, failed at startup. trace_filter = "" installed a filter that hid trace messages.
  • [sharing] conversion_bday_summary_template kept a space that 8a28141 removed from the default. It added a double space to the summary when the contact has both a family and a given name.

I found these by comparing every commented #key = value line in config with DEFAULT_CONFIG_SCHEMA, and checked each one by loading the uncommented line through radicale.config.load. One commit per change. No CHANGELOG entry, since only comments in the reference file change. Tell me if you want one.

Not changed: the [hook] lines smtp_security = starttls, smtp_server = localhost and rabbitmq_queue_type = classic also differ from the schema defaults (none, empty, empty). They may be meant as examples, so I left them. The lc_username comment still says "must be true"; I left that neighbouring line alone.

tox -c pyproject.toml -e flake8,isort,mypy,py passes (851 passed, 15 skipped on macOS, where TEMP is not case sensitive). The fs label, which needs sudo, was not run.

AI disclosure: written by Claude Code (Claude Opus 5.5, medium effort), working as an agent. It wrote the comparison script, the edits and this description. Following AGENTS.md, each commit went through at least three independent adversarial review agents until only nits remained; those reviews led to the lc_username note, the two extra quoted lines and the more precise commit messages. I reviewed the diff before it was opened.

uc_username has been an option since 3.3.2 but was the only [auth]
option missing from the reference config.

Assisted-by: Claude Opus 5.5
The config parser keeps quotes, so uncommenting these lines set the
value with the quotes:

- group_collections_folder = "GROUPS" used a folder named "GROUPS"
  with the quotes instead of the default GROUPS
- conversion_bday_alarm_trigger_template = "" fails at startup, since
  '""' is not a valid <trigger>;<alarm description> template, and the
  quoted example above it fails the same way, with the trigger '"-15H'
- trace_filter = "" installs a filter for the prefix '""', which hides
  every trace message not starting with '""' instead of applying no
  filter

Also remove the space after # on the group_collections_folder line to
match the other commented options.

Assisted-by: Claude Opus 5.5
8a28141 removed {n:a} from the default, but in the reference config
it left the space before it behind. Uncommenting that line added a
second space to the summary whenever the vCard N property has both a
family and a given name, e.g. "Doe John  (1980) (BDAY)". When either is
missing the template falls back to {fn} or {nickname} and the output
is the same.

Assisted-by: Claude Opus 5.5

@pbiering pbiering left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@pbiering pbiering added this to the 3.9.4 milestone Nov 20, 2026
@pbiering

Copy link
Copy Markdown
Collaborator

Not changed: the [hook] lines smtp_security = starttls, smtp_server = localhost and rabbitmq_queue_type = classic also differ from the schema defaults (none, empty, empty). They may be meant as examples, so I left them.

Thank you for the hint, verify and create a dedicated commit if required

@pbiering
pbiering merged commit b51ee46 into Kozea:master Nov 20, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants