Update .env.example with complete environment variable definitions and descriptions for clarity

This commit is contained in:
William Valentin
2025-07-26 11:12:26 -07:00
parent 7f1c655f7e
commit d6c7be2031

View File

@@ -1,19 +1,25 @@
# The version of the application
# This should match the version in your Dockerfile
# Example: VERSION=1.0.1
VERSION=1.0.1
# The Docker image name
# This should include the registry, repository, and tag
# Example: IMAGE=gitea-http.taildb3494.ts.net/will/thechart:${VERSION}
IMAGE=gitea-http.taildb3494.ts.net/will/thechart:${VERSION}
# Src Path
# The path to the source code directory
# This should be relative to the location of this .env file
# Example: SRC_PATH=./src
SRC_PATH=./src
# The IP address of your X server, e.g., 192.168.1.100
DISPLAY_IP=
# Set the logging level for the application
# Options: DEBUG, INFO, WARNING, ERROR, CRITICAL
LOG_LEVEL=INFO
LOG_FILE=/tmp/thechart.log
# This is an example .env file. Copy this to .env and modify as needed.
# Ensure to set the correct values for your environment.
# The TARGET variable should reflect the name of your application or service.
# The VERSION variable should match the version of your application.
# The IMAGE variable should point to the correct Docker image repository.
# The SRC_PATH should be the path to your source code.
# DISPLAY_IP should be the IP address where the application will be accessible.
# ROOT is the home directory for the application.
# ICON should be the filename of the icon used in the application.
# LOG_LEVEL can be set to DEBUG, INFO, WARNING, ERROR, or CRITICAL.
# LOG_PATH is where the application logs will be stored.
# LOG_CLEAR can be set to True or False to control log clearing behavior.
# Make sure to keep this file secure and not expose sensitive information.
# If you need to add more environment variables, do so below this line.
# Additional environment variables can be added as needed.
TARGET="thechart"
VERSION="1.0.0"
IMAGE="gitea-http.taildb3494.ts.net/will/${TARGET}:${VERSION}"
SRC_PATH="./src"
DISPLAY_IP="192.168.153.117"
ROOT="/home/will"
ICON="chart-671.png"
LOG_LEVEL="DEBUG"
LOG_PATH="./logs"
LOG_CLEAR="True"