Improve README #88
Merged
Improve README #88
Conversation
This file contains 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
In most of the document, we use spaces, but there are some places we use tabs instead. To make it consistent, use spaces everywhere, since this is the format usually used in Markdown.
Our current description of how to use and access the administrative interface is too terse and confusing. People are prone to start the server for the first time without any environment variables, which leads to an unusable configuration. Tell users that they must create users before they can use the server with the client. Be explicit about what happens if the administrative user and password variable are not set, and try to make it clearer that the default is that they are not set, not the literal string "unset" as a default credential. The server does not have default credentials, since doing so is not a secure configuration.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Our current description of how to use and access the administrative interface is too terse and confusing. People are prone to start the server for the first time without any environment variables, which leads to an unusable configuration.
Tell users of the server that they must create users before they can use the server with the client. Be explicit about what happens if the administrative user and password variable are not set, and try to make it clearer that the default is that they are not set, not the literal string "unset" as a default credential. The server does not have default credentials, since doing so is not a secure configuration.
In addition, make the indentation consistent across the file using spaces.
/cc @Jazzynupe as reporter
Fixes #87