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
+#    Torsearch    #
-# or pass your certificates into the 'app' container.
+###################
-# Please omit any trailing slashes. The APP_URL is
+# The version of Torsearch to run. Docker will this tag.
-# used to generate the Mercure URL behind the scenes.
+TAG=0.38.0
-APP_URL="https://dev.caldwell.digital"
+
+# 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
+#   Real Debrid   #
-# else and is passed to Torrentio
+###################
-# to retrieve download options
+# Enter your Real Debrid API key is passed to Torrentio to retrieve download options
-REAL_DEBRID_KEY=""
+REAL_DEBRID_KEY="<enter real debrid api key>"
 
+
+###################
+#      TMDB       #
+###################
 # Enter your TMDB API key
-# This is used to provide rich search results
+# This is used to provide rich search results when searching
-# when searching for media and rendering the
+# for media and rendering the Popular Movies and TV Shows section.
-# Popular Movies and TV Shows section.
+TMDB_API="<enter tmdb api key>"
-TMDB_API=""
 
-# 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 ###
-OIDC_WELL_KNOWN_URL=
+#OIDC_WELL_KNOWN_URL=
-OIDC_CLIENT_ID=
+#OIDC_CLIENT_ID=
-OIDC_CLIENT_SECRET=
+#OIDC_CLIENT_SECRET=
-# Allows you to skip the login page and directly
+# Allows you to skip the login page and directly rely on your IdP for auth.
-# rely on your IdP for auth.
+#OIDC_BYPASS_FORM_LOGIN=
-OIDC_BYPASS_FORM_LOGIN=
 
-
+### LDAP (*** Experimental! ***) ###
-# LDAP Config: To use LDAP, enter the below fields
+# LDAP Config: To use LDAP, enter the below fields and run 'php bin/console config:set auth.method ldap'
-# and run 'php bin/console config:set auth.method ldap'
 # (LDAP is still in progress and not ready for use)
 #LDAP_HOST=
 #LDAP_PORT=

docs/examples/compose.yml

@@ -1,78 +1,55 @@
 services:
+  ### The app contains the application and web server ###
   app:
-    image: code.caldwell.digital/home/torsearch-app:latest
+    image: code.caldwell.digital/home/torsearch-app:${TAG}
     ports:
-      - '8006:80'
+      - "${WEB_PORT}:80"
-    env_file:
+    env_file: .env
-      - .env
-    volumes:
-      - ./downloads/movies:/var/download/movies
-      - ./downloads/tvshows:/var/download/tvshows
-    environment:
-      TZ: America/Chicago
-      MERCURE_PUBLISHER_JWT_KEY: '!ChangeThisMercureHubJWTSecretKey!'
-      MERCURE_SUBSCRIBER_JWT_KEY: '!ChangeThisMercureHubJWTSecretKey!'
     depends_on:
-      database:
+      - database
-        condition: service_healthy
+    volumes:
+      - ${LOCAL_MOVIES_DIR}:/var/download/movies
+      - ${LOCAL_TVSHOWS_DIR}:/var/download/tvshows
+      - mercure_data:/data
+      - mercure_config:/config
 
-  # Downloads happen in this container. Replicate this
+
-  # container to run multiple downloads simultaneously.
+  ### The worker handles downloads and async jobs ###
-  # Map your "movies" folder to /var/download/movies
-  # Map your "TV shows" folder to /var/download/tvshows
-  # If your folders are on another machine, use an NFS volume.
-  # This container runs a Symfony worker process.
-  # See: https://symfony.com/doc/current/messenger.html
   worker:
-    image: code.caldwell.digital/home/torsearch-worker:latest
+    image: code.caldwell.digital/home/torsearch-worker:${TAG}
     volumes:
-      - ./downloads/movies:/var/download/movies
+      - ${LOCAL_MOVIES_DIR}:/var/download/movies
-      - ./downloads/tvshows:/var/download/tvshows
+      - ${LOCAL_TVSHOWS_DIR}:/var/download/tvshows
-    environment:
+    env_file: .env
-      TZ: America/Chicago
-    command: -vv --time-limit=3600 --limit=10
-    env_file:
-      - .env
-    restart: always
     depends_on:
-      app:
+      - app
-        condition: service_healthy
 
-  # This container handles the monitoring for new media. When new
+
-  # monitors are added, jobs are periodically dispatched to this
+  ### The scheduler processes monitored media ###
-  # container, and the desired media is searched for and downloaded.
-  # This container runs a Symfony worker process.
-  # See: https://symfony.com/doc/current/messenger.html
   scheduler:
-    image: code.caldwell.digital/home/torsearch-scheduler:latest
+    image: code.caldwell.digital/home/torsearch-scheduler:${TAG}
     volumes:
-      - ./downloads/movies:/var/download/movies
+      - ${LOCAL_MOVIES_DIR}:/var/download/movies
-      - ./downloads/tvshows:/var/download/tvshows
+      - ${LOCAL_TVSHOWS_DIR}:/var/download/tvshows
-    env_file:
+    env_file: .env
-      - .env
-    command: -vv
-    environment:
-      TZ: America/Chicago
-    restart: always
     depends_on:
-      app:
+      - app
-        condition: service_healthy
 
+
+  #!! If using your own database, this can be omitted !!#
   database:
     image: mariadb:10.11.2
     volumes:
       - mysql:/var/lib/mysql
-    environment:
+    env_file: .env
-      MYSQL_DATABASE: app
-      MYSQL_USERNAME: app
-      MYSQL_PASSWORD: password
-      MYSQL_ROOT_PASSWORD: password
     healthcheck:
       test: [ "CMD", "mysqladmin" ,"ping", "-h", "localhost" ]
       interval: 5s
       timeout: 5s
       retries: 10
 
+
+  #!! If using your own redis, this can be omitted !!#
   redis:
     image: redis:latest
     volumes:
@@ -80,12 +57,6 @@ services:
     command: redis-server --maxmemory 512MB
     restart: unless-stopped
 
-  # **Optional**
-  # Provides a simple method of viewing the database
-  adminer:
-    image: adminer
-    ports:
-      - "8081:8080"
 
 volumes:
   mysql: