Skip to content

Commit

Permalink
chore(.env.template): clarify on docker compose settings
Browse files Browse the repository at this point in the history
  • Loading branch information
Fdawgs committed Nov 25, 2024
1 parent 116449d commit 6f5f953
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions .env.template
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
NODE_ENV="development"

# NOTE: Needs to be set to "0.0.0.0" if using Docker.
# Ignored if deployed with included Docker Compose file.
# Defaults to resolving to "localhost" if not set
HOST=
# Expects number.
Expand Down Expand Up @@ -87,30 +88,30 @@ LOG_ROTATION_DATE_FORMAT=
# Filename including full path used by the stream, example:
# "./logs/docsmith-%DATE%.log"
# Defaults to STDOUT.
# Ignored if deployed with Docker Compose, as Docker's
# daemon handles logging and rotations
# Ignored if deployed with included Docker Compose file,
# as Docker's daemon handles logging and rotations
LOG_ROTATION_FILENAME=

# Frequency can be "daily", "date", "[1-12]h" or "[1-30]m".
# Defaults to "daily".
# Set to "date" if you want to rotate based on LOG_ROTATION_DATE_FORMAT.
# Requires LOG_ROTATION_FILENAME to be set.
# Ignored if deployed with Docker Compose.
# Ignored if deployed with included Docker Compose file.
# Defaults to "daily"
LOG_ROTATION_FREQUENCY=

# Max number of logs to keep. If not set, it will not remove past logs.
# Requires LOG_ROTATION_FILENAME to be set.
# If using days, add "d" as the suffix.
# Defaults to "10" if deployed with Docker Compose
# Defaults to "10" if deployed with included Docker Compose file
LOG_ROTATION_MAX_LOGS=

# Max size of the file after which it will rotate.
# It can be combined with frequency or date format.
# The size units are "k", "m" and "g".
# Units need to directly follow a number e.g. 1g, 100m, 20k.
# Requires LOG_ROTATION_FILENAME to be set.
# Defaults to "100m" if deployed with Docker Compose
# Defaults to "100m" if deployed with included Docker Compose file
LOG_ROTATION_MAX_SIZE=

### PROCESS LOAD HANDLING #################################
Expand Down

0 comments on commit 6f5f953

Please sign in to comment.