Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup sample config #350

Merged
merged 4 commits into from
May 8, 2021
Merged

Cleanup sample config #350

merged 4 commits into from
May 8, 2021

Conversation

alerque
Copy link
Contributor

@alerque alerque commented May 7, 2021

See commit message comments for details. The TOML formatting wasn't invalid, it's just non-traditional and annoyed me a lot. The other two changes to sample configs are just sysadmin convenience and more safety out of the box.

Using localhost instead of some random string is much more likely to
actually work out of the box. Also it's a lot easier for a sysamdmin to
'scan' for things that need changing.
This is a small safety precaution to make sure the out of the box
configuration is not world routeable. Bringing this up on a public
interface with a connected database could be a security concern. Any
sysadmin worth their salt is going to test offline or by binding to
localhost only first anyway, but this gets them started on the right
foot and makes sure people don't make mistakes.

Also with the high likelihood that a proxy is going to be used for HTTPS
termination anyway, the decision to move to a public IP should be more
deliberate.
@knadh
Copy link
Owner

knadh commented May 7, 2021

This is a vestige of the indentation I applied when there were dozens and dozens of keys and it was painful to read and parse mentally. Thankfully, all of that has now moved to the UI.

@alerque alerque changed the title config handling Cleanup sample config May 7, 2021
@alerque
Copy link
Contributor Author

alerque commented May 7, 2021

This is a vestige of the indentation I applied when there were dozens and dozens of keys and it was painful to read and parse mentally. Thankfully, all of that has now moved to the UI.

TOML does have a convention of indenting sections, but typically subsections are indented below sections. Keys inside sections are indented at the same level as their section headings.

@alerque alerque mentioned this pull request May 7, 2021
@knadh knadh merged commit f08254d into knadh:master May 8, 2021
@knadh knadh added the documentation Improvements or additions to documentation label May 8, 2021
@alerque alerque deleted the config-handling branch May 8, 2021 08:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants