docs: clarify scope of config file and environment variables #5643
Conversation
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
hacdias
requested changes
Dec 28, 2025
Member
hacdias
left a comment
There was a problem hiding this comment.
The CLI docs get generated from the CLI code itself. To change the CLI description, you need to update this file: https://github.com/filebrowser/filebrowser/blob/master/cmd/root.go#L113
I got pretty confused about why I can't set auth.method from the config file (and also why there were no docs saying what the JSON/YAML/etc key would even be). Document that this doesn't work to try to prevent future confusion here. Caveat: I wrote this documentation by hand, but I did not actually read the code carefully enough to have figured this out myself. I am trusting the claims made by an LLM coding agent (which do at least seem to match empirical evidence).
Contributor
Author
|
Ah, sorry. Let me try to do this properly...
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I got pretty confused about why I can't set auth.method from the config file (and also why there were no docs saying what the JSON/YAML/etc key would even be).
Document that this doesn't work to try to prevent future confusion here.
Caveat: I wrote this documentation by hand, but I did not actually read the code carefully enough to have figured this out myself. I am trusting the claims made by an LLM coding agent (which do at least seem to match empirical evidence).
Description
... Hopefully docs improvements is compatible with maintenance-only mode?
Additional Information
Checklist
Before submitting your PR, please indicate which issues are either fixed or closed by this PR. See GitHub Help: Closing issues using keywords.
masterbranch.