chore: updates example compose

docs/examples/.env

@@ -1,58 +1,99 @@
-# App must be served over HTTPS (requirement of Mercure)
-# Either serve behind an SSL terminating reverse proxy
-# or pass your certificates into the 'app' container.
-# Please omit any trailing slashes. The APP_URL is
-# used to generate the Mercure URL behind the scenes.
-APP_URL="https://dev.caldwell.digital"
+###################
+#    Torsearch    #
+###################
+# The version of Torsearch to run. Docker will this tag.
+TAG=0.38.0
+
+# The port for which the web server (app container) will
+# serve the application on the host.
+WEB_PORT=8004
+
+# The host directories where your media is stored.
+# If you would like to use a docker driver for a network
+# share, update the compose.yml file to reflect that.
+LOCAL_MOVIES_DIR="<enter movies dir>"
+LOCAL_TVSHOWS_DIR="<enter tvshows dir>"
+
+# Set the timezone you're in. This helps render monitored items correctly on the calendar
+TZ=America/Chicago
+
+###################
+#     Symfony     #
+###################
+# The external URL of the application where it can be reached by a browser.
+APP_URL="<enter url>"
+# Requried by Symfony Framework. Feel free to change.
 APP_SECRET="70169beadfbc8101c393cbfbba27a313"
+# Change to 'dev' to show logs in the browser.
 APP_ENV=prod
 
+
+###################
+#     Mercure     #
+###################
 # Mercure is a Caddy module built into the webserver
 # that facilitates the usage of websockets to transmit
 # real time data (download progress, etc.)
 MERCURE_JWT_SECRET="!ChangeThisMercureHubJWTSecretKey!"
+MERCURE_PUBLISHER_JWT_KEY="!ChangeThisMercureHubJWTSecretKey!"
+MERCURE_SUBSCRIBER_JWT_KEY="!ChangeThisMercureHubJWTSecretKey!"
 
+
+###################
+#    Database     #
+###################
 # Use the DATABASE_URL below to use the MariaDB container
 # provided in the example.compose.yml file, or remove this
 # line and fill in the details of your own MySQL/MariaDB server
-DATABASE_URL="mysql://root:password@database:3306/app?serverVersion=10.6.19.2-MariaDB&charset=utf8mb4"
+MYSQL_RANDOM_ROOT_PASSWORD=true
+MYSQL_DATABASE=app
+MYSQL_USER=app
+MYSQL_PASSWORD=password
+MYSQL_HOST=database
+DATABASE_URL="mysql://${MYSQL_USER}:${MYSQL_PASSWORD}@${MYSQL_HOST}:3306/${MYSQL_DATABASE}?serverVersion=10.11.2-MariaDB&charset=utf8mb4"
 
-# Fill in your MySQL/MariaDB connection details
-#DATABASE_URL="mysql://<mysql user>:<mysql pass>@<mysql host>:3306/<mysql db name>?serverVersion=10.6.19.2-MariaDB&charset=utf8mb4"
 
-# Enter your Real Debrid API key
-# This key is never saved anywhere
-# else and is passed to Torrentio
-# to retrieve download options
-REAL_DEBRID_KEY=""
+###################
+#   Real Debrid   #
+###################
+# Enter your Real Debrid API key is passed to Torrentio to retrieve download options
+REAL_DEBRID_KEY="<enter real debrid api key>"
 
+
+###################
+#      TMDB       #
+###################
 # Enter your TMDB API key
-# This is used to provide rich search results
-# when searching for media and rendering the
-# Popular Movies and TV Shows section.
-TMDB_API=""
+# This is used to provide rich search results when searching
+# for media and rendering the Popular Movies and TV Shows section.
+TMDB_API="<enter tmdb api key>"
 
-# Use your own Redis instance or use the
-# below value to use the container included
-# in the example compose.yml file.
+
+###################
+#      Redis      #
+###################
+# Use your own Redis instance or use the below value to use the
+# container included in the example compose.yml file.
 REDIS_HOST="redis://redis"
 
-### Auth ###
-# Change to "oidc" to and provide the required
-# environment variables below to use OIDC auth.
+
+###################
+#      Auth       #
+###################
+# Options: form_login, oidc, or ldap (experimental)
+# Fill the rest of the configuration based on your choice here
+# No additional config is required for form_login
 AUTH_METHOD=form_login
 
-# OIDC
-OIDC_WELL_KNOWN_URL=
-OIDC_CLIENT_ID=
-OIDC_CLIENT_SECRET=
-# Allows you to skip the login page and directly
-# rely on your IdP for auth.
-OIDC_BYPASS_FORM_LOGIN=
+### OIDC ###
+#OIDC_WELL_KNOWN_URL=
+#OIDC_CLIENT_ID=
+#OIDC_CLIENT_SECRET=
+# Allows you to skip the login page and directly rely on your IdP for auth.
+#OIDC_BYPASS_FORM_LOGIN=
 
-
-# LDAP Config: To use LDAP, enter the below fields
-# and run 'php bin/console config:set auth.method ldap'
+### LDAP (*** Experimental! ***) ###
+# LDAP Config: To use LDAP, enter the below fields and run 'php bin/console config:set auth.method ldap'
 # (LDAP is still in progress and not ready for use)
 #LDAP_HOST=
 #LDAP_PORT=