[log1-c]

Updated comment for database password to include guidance on handling special characters.

Took me quite a while to figure out, because the resulting error when starting the service is not very helpful in that case

invalid configuration: invalid redis configuration: Redis host missing

[oxzi]

Thanks for creating this PR.

I am unsure about having this comment in only one place when it addresses a limitation (or footgun) of YAML. How about putting the examples in single quotes instead? Or adding a general note at the top and/or in the docs?

[log1-c]

How about putting the examples in single quotes instead?

Would have been too obvious 😅
I added the quotes and another hint in the config section

[oxzi]

I added the quotes and another hint in the config section

Thanks for the fast reply. However, I am still a bit unhappy about the change as it explicitly only handles database.password, while this is a general problem.

So, how about a warning note at the beginning of the docs - maybe after the last paragraph of the Configuration section before the Database Configuration subsection starts? I could imagine something like:

When using the YAML configuration, please be aware of how YAML handles strings. If your input field contains special characters - which is common for passwords -, enclose it in quotes.

This way, the information would be generic, as there are multiple potentially affected fields; even multiple password fields.

[log1-c]

Removed the previous hints and added a caution box at the beginning of the database configuration section.
Single quotes around the password in the config example still remain.

[oxzi]

Thanks again!

Please add yourself to the AUTHORS file and squash all your commits into one. Then, it's good for me :)

[oxzi]

Sorry @log1-c, but in my previous suggested changes leading > crept in :(

[log1-c]

Please add yourself to the AUTHORS file

Is that mandatory? Because until now that was never requested.

and squash all your commits into one. Then, it's good for me :)

tbh, I have no idea how to do that. The Github interface does not seem to offer such an option.
I tried using the Github Copilot app, but it only did the squashing in my forked repo which did not seem to have an impact on the PR

[oxzi]

Please add yourself to the AUTHORS file

Is that mandatory? Because until now that was never requested.

Depends. It is mostly there to acknowledge our contributors.

and squash all your commits into one. Then, it's good for me :)

tbh, I have no idea how to do that. The Github interface does not seem to offer such an option. I tried using the Github Copilot app, but it only did the squashing in my forked repo which did not seem to have an impact on the PR

No problem. I did it for you and force-pushed it to your PR branch.

[oxzi]

Thanks again and please excuse the back-and-forth here in the PR discussion.

[log1-c]

Happy to help :)

Thanks again and please excuse the back-and-forth here in the PR discussion.

No worries, usual refinement process I'd say 👍