diff --git a/.env.example b/.env.example index 1d3c8d2f..d633b9ab 100644 --- a/.env.example +++ b/.env.example @@ -28,7 +28,7 @@ YOUTUBE_OUTPUT_DIR=./downloads # By default, Youtarr uses an internal MySQL database container. # If you want to use an external database, uncomment and set the following variables # To match your external DB settings -# Defaults are sets for internal DB use in docker-compose.yml +# Defaults are set for internal DB use in docker-compose.yml # Only override DB_HOST if you are using an external database # Default is set to youtarr-db service in docker-compose.yml for built-in DB @@ -42,7 +42,7 @@ YOUTUBE_OUTPUT_DIR=./downloads # !IMPORTANT! # If you switch DB_USER away from root while using the bundled database container, # edit docker-compose.yml and uncomment the MYSQL_USER / MYSQL_PASSWORD lines so the -# database service creates that user automatically or else Youtarr will not be able to start! +# database service creates that user automatically, or else Youtarr will not be able to start! # Only used for internal DB setup, can be omitted for external DB # DB_ROOT_PASSWORD=123qweasd @@ -86,7 +86,7 @@ AUTH_ENABLED=true # where you want to skip the one-time setup-token wizard # NOTE: If set, these values OVERRIDE any username and password previously set through the WEB UI # and will continue to do so on each startup -# These must meet the following validation criteria or they will be ignored: +# These must meet the following validation criteria, or they will be ignored: # Username: 1-32 characters (no leading/trailing spaces) # Password: 8-64 characters @@ -120,7 +120,7 @@ TZ=UTC # Docker Image Selection # For development: Set to 'youtarr-dev:latest' to use locally built image # For production: Use default 'dialmaster/youtarr:latest' (or leave unset) -# NOTE: Development scripts automatically set this, manual override rarely needed +# NOTE: Development scripts automatically set this; manual override rarely needed # YOUTARR_IMAGE=dialmaster/youtarr:latest # ============================================================================== diff --git a/docker-compose.external-db.yml b/docker-compose.external-db.yml index dc21164a..28b46541 100644 --- a/docker-compose.external-db.yml +++ b/docker-compose.external-db.yml @@ -1,7 +1,7 @@ # IMPORTANT NOTES: -# By default the youtarr service runs as ROOT (UID 0, GID 0) for compatibility with existing setups. +# By default, the youtarr service runs as ROOT (UID 0, GID 0) for compatibility with existing setups. # For improved security, you can set YOUTARR_UID and YOUTARR_GID environment variables to run the container as a non-root user. -# If you do so, ensure that the following directories to exist on the host with the correct ownership/permissions before +# If you do so, ensure that the following directories exist on the host with the correct ownership/permissions before # starting the container: # - ./config # - ./jobs @@ -51,7 +51,7 @@ services: # This is just informational and lets the app know where the videos will be stored on the host YOUTUBE_OUTPUT_DIR: ${YOUTUBE_OUTPUT_DIR} # Optional: Custom data path for platforms like Elfhosted (defaults to /usr/src/app/data) - # This is the internal path where videos download inside the container and is not needed for most users + # This is the internal path where videos are downloaded inside the container and is not needed for most users # DATA_PATH: /storage/rclone/storagebox/youtube ports: diff --git a/docker-compose.yml b/docker-compose.yml index e9132f19..4993b8fb 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,8 +1,8 @@ # IMPORTANT NOTES: -# 1) UID/GID and folders setup: -# By default the youtarr service runs as ROOT (UID 0, GID 0) for compatibility with existing setups. +# 1) UID/GID and folder setup: +# By default, the youtarr service runs as ROOT (UID 0, GID 0) for compatibility with existing setups. # For improved security, you can set YOUTARR_UID and YOUTARR_GID environment variables to run the container as a non-root user. -# If you do so, ensure that the following directories to exist on the host with the correct ownership/permissions before +# If you do so, ensure that the following directories exist on the host with the correct ownership/permissions before # starting the container: # - ./config # - ./jobs @@ -18,7 +18,7 @@ # 2) Database setup notes: # The default bundled MariaDB uses ./database as a bind mount for backwards compatibility. # On Docker Desktop (Windows/macOS), ARM hosts, and some NAS/virtualized filesystems, -# bind-mounted MariaDB data can corrupt during schema migrations. For a safer named +# bind-mounted MariaDB data can become corrupted during schema migrations. For a safer named # volume, use docker-compose.arm.yml or run ./scripts/migrate-to-named-volume.sh # for an existing bind-mounted install. @@ -79,7 +79,7 @@ services: # This is just informational and lets the app know where the videos will be stored on the host YOUTUBE_OUTPUT_DIR: ${YOUTUBE_OUTPUT_DIR} # Optional: Custom data path for platforms like Elfhosted (defaults to /usr/src/app/data) - # This is the internal path where videos download inside the container and is not needed for most users + # This is the internal path where videos are downloaded inside the container and is not needed for most users # DATA_PATH: /storage/rclone/storagebox/youtube ports: