CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Version [5.4.5] - 2024-11-22 🚀

Fixed 🛠️

• PR #88 Zilean: Add database connection timeouts 🐛 - Thanks @skeet70 🙏

Version [5.4.4] - 2024-11-16 🚀

Changed 🔄

• Zilean: Update to dotnet 9 🔄
• Zilean: Update to support both Zilean.Scraper & Zilean.DmmScraper for older version of Zilean 🔄

Notes 📝

• Zilean: Only Zilean v2.1.0 and newer are supported due to dotnet update to version 9 🚨

Version [5.4.3] - 2024-11-01 🚀

Changed 🔄

• Riven Frontend: Updated the name and location of the server-config.json file to server.json and to be transferred to the /riven/frontend/config directory on startup 🔄
• Re-enabled reaping of zombie processes 🔄

Version [5.4.2] - 2024-10-29 🚀

Fixed 🛠️

• Issue #72 Zilean Permissions Issue 🐛

Version [5.4.1] - 2024-10-28 🚀

Fixed 🛠️

• Issue #71 PostgreSQL Graceful Shutdown 🐛

Version [5.4.0] - 2024-10-25 🚀

Fixed 🛠️

• Issue #14 Add Riven build process to Dockerfile ✨
• Issue #65 Zilean Enabled when ZILEAN_ENABLED=false 🐛
• Issue #66 Dockerfile pulls from Riven Frontend main branch vs. latest release 🐛
• Issue #67 Future releases for Riven Frontend and Backend will require an API Key 🐛

Added ✨

• Riven Backend: Added the Riven backend build process to the Dockerfile 📦
• Riven Frontend: Added the server-config.json to the be saved in /config and transferred to the Riven Frontend when using the API key 📦
• Zilean: Added the Zilean build process to the Dockerfile 📦

Changed 🔄

• Riven Backend: Settings are now loaded with or without the API key depending on the version of Riven used 🔄
• Refactor: Refactored the utils and version checks 🔄
• Utils: Added description to reaped processes 🔄
• Logging: Added thread lock to rollover 🔄

Notes 📝

• Future releases for Riven Frontend and Backend will require an API Key to be set 🚨
• With these changes, you can now use the latest development versions of Riven Frontend and Backend 🌙
• Use the RIVEN_BACKEND_BRANCH=release-please--branches--main and RIVEN_FRONTEND_BRANCH=release-please--branches--main environment variables to test the current development versions of Riven 🌙

Version [5.3.2] - 2024-10-18 🚀

Fixed 🛠️

• Issue #60 Does not correctly handle deleted files in new Riven releases 🐛
• Issue #61 Riven Backend v0.16.0 Broke Settings Update 🐛
• Issue #62 Riven Frontend v0.14.0 Broke VersionFilePath 🐛
• Issue #63 Riven Frontend v0.16.0 Broke Frontend Build 🐛 - This may be a temporary fix...

Version [5.3.1] - 2024-10-15 🚀

Fixed 🛠️

• Issue #59 Zombie dotnet Processes Accumulating Over Time 🐛

Version [5.3.0] - 2024-10-03 🚀

Added ✨

• pgAdmin 4: Added system_stats extension to pgAdmin 4 for host system monitoring 📦
• pgAdmin 4: Added pgAgent extension to pgAdmin 4 for job scheduling 📦

Fixed 🛠️

• pgAdmin 4: Fixed the pgAdmin 4 config_local.py SSL settings 🐛

Changed 🔄

• RIVEN_BACKEND_URL: Linked to the Riven backend load_settings function. PR #57 Thanks @FunkeCoder23 🙏

Version [5.2.0] - 2024-10-01 🚀

Added ✨

• pgAdmin 4: Added pgAdmin 4 to the DMB image for PostgreSQL management 📦 - Resolves Issue #49

Notes 📝

• pgAdmin 4 is enabled by setting the PGADMIN_SETUP_EMAIL and PGADMIN_SETUP_PASSWORD environment variables 🆔🔐
• The DMB PostgreSQL server is automatically added to pgAdmin4 Servers🗄️
• On the first access of pgAdmin 4, the DMB PostgreSQL server password will need to be set in pgAdmin 4 🗄️ - the default PostgreSQL server password is postgres or set with POSTGRES_PASSWORD 🔐
• To access pgAdmin 4, navigate to http://<DMB_IP>:5050 in your browser 🌐
• The pgAdmin 4 data is stored in the /pgadmin/data directory - though, not required to mounted to the host 📁
• The pgAdmin 4 config_local.py is stored in the /pgadmin/data directory and symlinked at startup 📝 - review the pgAdmin 4 documentation for additional configuration options 📚
• Backups of the PostgreSQL database can be made using pgAdmin 4 and are stored in the /pgadmin/storage directory 🗄️
• The following message can be ignored on initial startup: ERROR - PostgreSQL subprocess: relation "version" does not exist at character 75

Version [5.1.10] - 2024-09-24 🚀

Fixed 🛠️

• logger: Fixed obfuscation of sensitive data in logs 🐛

Version [5.1.9] - 2024-09-23 🚀

Fixed 🛠️

• Riven Backend: Enabled not set to true for applied subordinate dictionary values - seriously this time 🐛
• Riven Frontend: Set the default path for the frontend version.txt in dockerfile 🐛
• Issue #54 An error occurred in the Zilean setup: 'NoneType' object has no attribute 'lower'

Version [5.1.8] - 2024-09-23 🚀

Fixed 🛠️

• Riven Backend: Enabled not set to true for applied subordinate dictionary values 🐛

Version [5.1.7] - 2024-09-23 🚀

Fixed 🛠️

• Issue #40 Postgres. role "root" does not exist. 🐛 - Thanks @lukemuller 🙏

Added ✨

• Riven Backend: Added the use of .env file for Riven backend settings 📝

Changed 🔄

• Main Process: Refactored the main process to handle exceptions - graceful shutdown 🔄
• Logger: Clean up logging 📝
• Riven Backend: DEBUG is now linked to the DMB_LOG_LEVEL 🔄

Notes 📝

• To use the .env file for Riven backend settings, create a .env file in the Riven data directory with settings in the format of KEY=VALUE as shown in the env.example📝

Version [5.1.6] - 2024-09-13 🚀

Changed 🔄

• Riven Frontend: Set the default path for the frontend version.txt to /riven/frontend 🔄

Version [5.1.5] - 2024-09-13 🚀

Fixed 🛠️

• Riven Frontend: Fixed the default DIALECT set for node build process 🐛
• Riven Frontend: Set the default path for the frontend version.txt 🐛

Added ✨

• RIVEN_FRONTEND_OWNER: Environment variable to set the owner of the Riven frontend repository; Default is rivenmedia 🆔

Version [5.1.4] - 2024-09-12 🚀

Fixed 🛠️

• Issue #51 Duplicate start_process when update applied during initial startup 🐛

Version [5.1.3] - 2024-09-12 🚀

Fixed 🛠️

• Issue #43 Node issue when setting Riven frontend version 🐛

Notes 📝

• The Riven frontend automatic update / branch / version should now work again 📦

Version [5.1.2] - 2024-09-10 🚀

Fixed 🛠️

• Healthcheck: Fixed healthcheck for Zilean 🩺

Version [5.1.1] - 2024-09-10 🚀

Fixed 🛠️

• Zilean: PostgreSQL subprocess: ... CEST [490] FATAL: role "postgres" does not exist 🐛

Notes 📝

• On first run of Zilean, the PostgreSQL will create the database named zilean, so the message PostgreSQL subprocess: ... CEST [596] FATAL: database "zilean" does not exist can be ignored 🗄️

Version [5.1.0] - 2024-09-09 🚀

Added ✨

• Issue #48 Added Zilean to the DMB image for caching of the DebridMediaManager shared hashlists 📦
• ZILEAN_ENABLED: Environment variable to enable Zilean; Default is false 🔄
• ZILEAN_UPDATE: Environment variable to update Zilean; Default is false 🔄
• ZILEAN_BRANCH: Environment variable to set the Zilean branch; Default is main 🔄
• ZILEAN_VERSION: Environment variable to set the Zilean version; Default is latest 🔄
• ZILEAN_LOGS: Environment variable to disable the Zilean logging when value is set to OFF; Default is ON 📝

Version [5.0.1] - 2024-09-06 🚀

Fixed 🛠️

• Issue #47 Error when RCLONE_LOG_LEVEL is not enabled 🐛

Version [5.0.0] - 2024-09-05 🚀

Breaking Changes ⚠️

• PostgreSQL: The default database user has been changed from postgres to DMB 📉 - Please delete the existing PostgreSQL data directory before starting the new version of DMB 🗑️

Added ✨

• FRONTEND_LOGS: Environment variable to disable the Riven frontend logging when value is set to OFF; Default is ON 📝
• BACKEND_LOGS: Environment variable to disable the Riven backend logging when value is set to OFF; Default is ON 📝
• Riven: Added shutdown for Riven backend and frontend processes 🛑

Fixed 🛠️

• Issue #44 Add graceful shutdown for Riven frontend and backend ✨
• Issue #45 Fix permissions for npm_install 🐛
• Issue #46 Zurg config.yml not chown'd to the correct user 🐛
• PostgreSQL: Fixed permissions for PostgreSQL 🐛 - Thanks @Unlearned6688 🙏
• Zurg: Fixed automatic updates for Zurg nightly builds 🐛

Changed 🔄

• Refactor: Refactored the use of ProcessHandler for consistent process management 🔄

Notes 📝

• Add stop_grace_period: 60s to your compose file to allow for a 60 second grace period for all of the processes to shutdown before the container is stopped 🛑
• Issue #43 Node issue when setting Riven frontend version 🐛 has not been resolved in this release 🚨, so please ensure to only use Riven frontend version that is built into the image - No automatic update / branch / version 📦
• There may be an issue with the Riven frontend when trying to access settings; the logs will show TypeError: Cannot read properties of undefined (reading 'enabled') when trying to access settings - this is a known issue and you will need to delete the riven settings.json 🚨

Version [4.1.0] - 2024-08-29 🚀

Added ✨

• RCLONE_LOGS: Environment variable to disable the rclone process logging when value is set to OFF; Default is ON 📝
• RCLONE_DIR: Environment variable to set the rclone directory; Default is /data 📁

Fixed 🛠️

• Issue #36 Setting RCLONE_LOG_LEVEL=OFF causes the rclone process to fail 🐛
• Issue #37 Error when PUID/PGID are set without values: PGID= 🐛
• Issue #38 Recursive chown of /data throws errors if the mount is still present 🐛
• Issue #39 Make rclone mount base path a variable - /data --> /user-defined ✨
• Issue #41 Add healthcheck for PostgreSQL process ✨
• Issue #42 Add clean shutdown for PostgreSQL server ✨

Version [4.0.0] - 2024-08-28 🚀

Breaking Changes ⚠️

• Riven: Riven backend no longer supports sqlite as a database option; PostgreSQL is now the only supported database option 📉
• PostgreSQL: To ensure the database files are persisted, a volume must be mounted to /postgres_data 📂

Added ✨

• PUID & PGID: Environment variables to set the user and group IDs for the DMB container; Default is 1001 🆔
• POSTGRES_DATA: Environment variable to set the path for the PostgreSQL database files; Default is /postgres_data 📁
• POSTGRES_PASSWORD: Environment variable to set the password for the PostgreSQL database; Default is postgres 🔐
• POSTGRES_USER: Environment variable to set the user for the PostgreSQL database; Default is postgres 👤
• POSTGRES_DB: Environment variable to set the database name for the PostgreSQL database; Default is riven 🗄️

Changed 🔄

• Riven: Riven backend now uses PostgreSQL as the database option; Default is postgresql+psycopg2://postgres:[email protected]/riven 🔧
• Riven: Riven frontend now uses PostgreSQL as the database option; Default is postgres://postgres:[email protected]/riven 🔄

Fixed 🛠️

• Issue #8 Add support for PUID/GUID ✨
• Issue #34 Add PostgreSQL option for Riven backend ✨
• Issue #35 Riven frontend not properly connecting to the database 🐛

Notes 📝📌

• If the Riven backend shows errors related to the database or alembic, then the Riven data directory may need to be deleted before starting the new version of Riven w/ PostgreSQL 🗑️ - backup your settings.json before deleting the data directory 📂

Version [3.5.0] - 2024-08-08 🚀

Added ✨

• Suppress Logs: If the LOG_LEVEL for a process is set to OFF, then logs will be suppressed for the process 🤫
• Riven Frontend: Added the latest version of the Riven frontend to the Dockerfile for image build 📦

Notes 📝

• The DMB image is built nightly and will include the latest version of the Riven frontend at the time of build 🌙

Version [3.4.0] - 2024-08-05 🚀

Fixed 🛠️

• Issue #27 DATABASE_URL was not being set correctly for the Riven frontend 🐛
• healthcheck: Fixed healthcheck to properly check for Riven frontend setup completion 🩺

Changed 🔄

• Riven setup: Refactored backend and frontend setup to use ProcessHandler for consistent logging 🔄

Added ✨

• Issue #9 Obfuscate sensitive data in logs
• Riven backend: UPDATERS_PLEX_ADDRESS linked to PLEX_ADDRESS 🔄
• Riven backend: UPDATERS_PLEX_TOKEN linked to PLEX_TOKEN 🔄

Version [3.3.2] - 2024-08-03 🚀

Fixed 🛠️

• Issue #27 Riven frontend needed a database connection to function properly 🐛

Added ✨

• RIVEN_DATABASE_URL: Environment variable to set the Riven frontend database URL; Default is sqlite:////riven/backend/data/media.db 🗃️

Changed 🔄

• GITHUB_TOKEN: Can be added to the environment variables to allow for repository downloads without rate limits 🔄

Version [3.3.1] - 2024-08-01 🚀

Fixed 🛠️

• healthcheck: Reverted healthcheck, for now 🐛

Version [3.3.0] - 2024-08-01 🚀

Fixed 🛠️

• Issue #23 Processes not properly killed during automatic updates 🐛
• Issue #24 Riven automatic update extracts to wrong directory 🐛
• Issue #25 Automatic update initiates update check multiple times for each instance 🐛
• Issue #26 Riven Frontend breaking change requires DIALECT=sqlite env variable 🐛

Added ✨

• Automatic Update: Enabled automatic updates for Riven branches - expands automatic updates to include branches 🔄
• RIVEN_FRONTEND_DIALECT: Environment variable to set the Riven frontend database dialect; Default is sqlite - not required to be set in default configuration 🗃️
• Riven Frontend: Set npm max_old_space_size to 2048MB for Riven frontend build process - limits resource usage 📦
• Riven Frontend: Set vite minification to false for Riven frontend build process - speeds up build process and reduces resource usage 📦

Changed 🔄

• healthcheck: Waits for Riven frontend setup to complete 🩺

Version [3.2.0] - 2024-07-30 🚀

Changed 🔄

• Update process: Refactored update process to apply updates to Zurg and Riven before starting the processes 🔄
• Zurg: Disabling plex_update.sh in config file has been disbaled, for now. Comment out the line in the config file to disable the Zurg based plex update process if desired 🔄

Added ✨

• Zurg: Allow nightly release custom versions for ZURG_VERSION
• Zurg: Add plex_update.sh from Zurg to working directory for Zurg use 📦

Fixed 🛠️

• Logging: Fixed logging for Zurg to ensure log levels are properly set 📝

Version [3.1.0] - 2024-07-26 🚀

Added ✨

• Shutdown: Added a shutdown function to gracefully stop the DMB container; e.g., unmount the rclone mounts 🛑

Version [3.0.0] - 2024-07-26 🚀

Breaking Changes ⚠️

• BACKEND_URL: Environment variable has been changed to RIVEN_BACKEND_URL to better reflect the environment variable's purpose; please update your compose file accordingly

Added ✨

• Ratelimit for GitHub API requests ⏳
• Retries for GitHub API requests 🔄

Fixed 🛠️

• RIVEN_ENABLED: Environment variable has been fixed to correctly enable the Riven backend and frontend; Default is false 🤞
• RIVEN_UPDATE: Environment variable has been fixed to correctly update the Riven backend and frontend; Default is false 🤞
• RIVEN_BACKEND_UPDATE: Environment variable has been fixed to correctly update the Riven backend; Default is false 🤞
• RIVEN_FRONTEND_UPDATE: Environment variable has been fixed to correctly update the Riven frontend; Default is false 🤞
• RIVEN_DATABASE_HOST: Environment variable has been fixed to correctly set the Riven database host; Default is sqlite:////riven/backend/data/media.db 🗃️
• Issue #22 🐛

Notes 📝

• BACKEND_URL has been changed to RIVEN_BACKEND_URL. The value is automatically set when the variable is not enabled. The default value is http://127.0.0.1:8080 🌐
• RIVEN_DATABASE_HOST value is automatically set when the variable is not enabled. The default value is sqlite:////riven/backend/data/media.db 🗃️

Version [2.0.0] - 2024-07-25

Breaking Changes

• Riven: Directory structure has changed to allow for split riven instances - backend and frontend - please update your compose file volumes accordingly
• RIVEN_BRANCH: Is now split into RIVEN_FRONTEND_BRANCH and RIVEN_BACKEND_BRANCH
• RIVEN_ENABLED: Environment variable will enable the Riven backend and frontend without the need to set the RIVEN_FRONTEND_ENABLED and RIVEN_BACKEND_ENABLED variables
• RIVEN_UPDATE: Environment variable to update the Riven backend and frontend; Default is false

Added

• RIVEN_BACKEND_ENABLED: Environment variable to enable the Riven backend; Default is false
• RIVEN_FRONTEND_ENABLED: Environment variable to enable the Riven frontend; Default is false
• RIVEN_BACKEND_BRANCH: Environment variable to set the Riven backend branch; Default is main
• RIVEN_FRONTEND_BRANCH: Environment variable to set the Riven frontend branch; Default is main
• RIVEN_BACKEND_UPDATE: Environment variable to update the Riven backend; Default is false
• RIVEN_FRONTEND_UPDATE: Environment variable to update the Riven frontend; Default is false
• RIVEN_BACKEND_VERSION: Environment variable to set the Riven backend version; Default is latest
• RIVEN_FRONTEND_VERSION: Environment variable to set the Riven frontend version; Default is latest
• BACKEND_URL: Environment variable to set the Riven backend URL; Default is http://127.0.0.1:8080
• RIVEN_DATABASE_HOST: Environment variable to set the Riven database host; Default is sqlite:////riven/backend/data/media.db
• COLOR_LOG_ENABLED: Environment variable to enable color logging; Default is false
• ffmpeg: Added ffmpeg to the Dockerfile for Zurg use of ffprobe to extract media information from files, enhancing media metadata accuracy.

Notes

• Delete all Riven files and directories within the data directory before starting the new version of Riven!
• Automatic updates for Riven backend and frontend are not funtioal yet; will be fixed in a follow-on release.
• Other features may also not be functional yet; will be fixed in a follow-on release.
• This release resolves Issue #19, Issue #20, and Issue #10

Version [1.2.0] - 2024-07-19

Added

• Issue #18: Added DMB_LOG_SIZE environment variable to set the maximum size of the log file; Default is 10MB

Version [1.1.0] - 2024-07-17

Changed

• Rclone: WebDAV URL check for Zurg startup processes accepts any 200 status code as a valid response
• DMB: Refactored to use common functions under utils

Version [1.0.3] - 2024-07-16

Fixed

• Rclone: Fixed WebDAV URL check for Zurg startup processes when Zurg user and password are set in config.yml

Version [1.0.2] - 2024-07-16

Fixed

• Zurg: Fixed the removal of Zurg user and password if previously set in config.yml

Version [1.0.1] - 2024-07-16

Fixed

• DMB: Introduced a Riven startup check for the symlinked directory to ensure the Zurg startup processes have finished before starting Riven
• DMB: Introduced a Rclone startup check for the Zurg WebDAV URL to ensure the Zurg startup processes have finished before starting Rclone

Version [1.0.0] - 2024-06-25

Breaking Changes

• DMB: Updated PDZURG_LOG_LEVEL to DMB_LOG_LEVEL
• DMB: Updated PDZURG_LOG_COUNT to DMB_LOG_COUNT

Changed

• Issue #5: Added initial sleep time to allow for services to start
• Issue #6: Disabled Zurg plex_update.sh - not needed
• Issue #7: Cleanup Riven logging

Added

• Issue #1: All Riven settings now assignable with environment variables
• Riven: RIVEN_LOG_LEVEL environment variable - Riven log level is only configurable to DEBUG or INFO; Default is INFO

Removed

• Issue #3: Removed Jellyfin environment variables
• Issue #2: Removed PLEX_REFRESH environment variable

Version [0.2.0] - 2024-06-22

Added

• Zurg: GITHUB_TOKEN environment variable to use for access to the private sponsored zurg repository

Removed

• Zurg: PLEX_REFRESH environment variable
• Zurg: PLEX_MOUNT environment variable

Version [0.1.0] - 2024-06-22

Added

• Riven: RIVEN_BRANCH environment variable to select the branch to use for the riven repository

Fixed

• rclone: Fixed rclone process w/ Riven
• Healthcheck: Fixed healthcheck process w/ Riven

Version [0.0.1] - 2024-06-21

Added

• Initial Push