[SUGGESTION] Add detailed descriptions for volumes and environment variables #12
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
This commit enhances the README file by providing comprehensive and detailed descriptions for the volumes and environment variables used in the Umbrel application manifest. The following changes were made:
Volumes Section: Each volume variable now includes a clear explanation of its purpose and how it should be utilized within the Docker configuration. This includes details on the main application directory, as well as the data directories for LND and Bitcoin Core.
System Level Environment Variables: Descriptions for the device hostname and domain name variables have been clarified to help users understand their significance in the context of the Umbrel server.
Tor Proxy Environment Variables: Added detailed explanations for the Tor proxy IP and port variables, emphasizing their role in routing traffic through the Tor network for enhanced privacy.
App Specific Environment Variables: Provided in-depth descriptions for the app-specific variables, including the hidden service address, authentication password, and unique seed. This aims to assist developers in configuring their applications effectively.
Overall, these enhancements aim to improve the clarity and usability of the README, making it easier for developers to understand and implement the necessary configurations for their applications.
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.
This commit enhances the README file by providing comprehensive and detailed descriptions for the volumes and environment variables used in the Umbrel application manifest. The following changes were made:
I found it challenging to fully grasp all the details initially, which motivated me to create this reference. The information was sourced from the Umbrel Apps README, and I recommend creating a similar table for the variables to further enhance clarity and accessibility.
Overall, these enhancements aim to improve the clarity and usability of the README, making it easier for developers to understand and implement the necessary configurations for their applications.
Screenshots