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

[SUGGESTION] Add detailed descriptions for volumes and environment variables #12

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Commits on Oct 9, 2024

  1. Add detailed descriptions for volumes and environment variables

    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.
    lukasitaly authored Oct 9, 2024
    Configuration menu
    Copy the full SHA
    abff76f View commit details
    Browse the repository at this point in the history