Version [5.2.0]

Author: I-am-PUID-0

CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
+## Version [5.2.0] - 2024-10-01 🚀
+
+### Added ✨
+
+- pgAdmin 4: Added pgAdmin 4 to the DMB image for PostgreSQL management 📦 - Resolves [Issue #49](https://github.com/I-am-PUID-0/DMB/issues/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](https://www.pgadmin.org/docs/pgadmin4/latest/config_py.html) 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 🛠️

Dockerfile

@@ -14,7 +14,7 @@ ADD https://github.com/rivenmedia/riven-frontend/archive/refs/heads/main.zip /ri
 
 RUN \
   apk add --update --no-cache gcompat libstdc++ libxml2-utils curl tzdata nano ca-certificates wget fuse3 build-base linux-headers py3-cffi libffi-dev rust cargo openssl openssl-dev pkgconfig git npm ffmpeg postgresql-dev postgresql-client postgresql dotnet-sdk-8.0 postgresql-contrib && \
-  mkdir -p /log /riven /riven/frontend && \
+  mkdir -p /log /riven /riven/frontend /pgadmin/venv /pgadmin/data && \
   if [ -f /riven-frontend-main.zip ]; then echo "File exists"; else echo "File does not exist"; fi && \
   unzip /riven-frontend-main.zip -d /riven && \
   mv /riven/riven-frontend-main/* /riven/frontend && \
@@ -34,16 +34,23 @@ WORKDIR /
 
 COPY . /./
 
-ENV \
-  XDG_CONFIG_HOME=/config \
-  TERM=xterm
+RUN \
+  python3 -m venv /pgadmin/venv && \
+  source /pgadmin/venv/bin/activate && \
+  pip install pip==24.0 setuptools==66.0.0 && \
+  pip install pgadmin4 && \
+  deactivate
 
 RUN \
   python3 -m venv /venv && \
   source /venv/bin/activate && \
   pip install --upgrade pip && \
   pip install -r /requirements.txt
 
+ENV \
+  XDG_CONFIG_HOME=/config \
+  TERM=xterm 
+
 HEALTHCHECK --interval=60s --timeout=10s \
   CMD ["/bin/sh", "-c", "source /venv/bin/activate && python /healthcheck.py"]
 

README.md

@@ -9,7 +9,7 @@
 </div>
 
 ## 📜 Description
-**Debrid Media Bridge (DMB)** is an All-In-One (AIO) docker image for the unified deployment of **[Riven Media's](https://github.com/rivenmedia)**, **[yowmamasita's](https://github.com/yowmamasita)**, **[iPromKnight's](https://github.com/iPromKnight/zilean)**, and **[ncw's](https://github.com/ncw)** projects -- **[Riven](https://github.com/rivenmedia/riven)**, **[zurg](https://github.com/debridmediamanager/zurg-testing)**, **[zilean](https://github.com/iPromKnight/zilean)**, and **[rclone](https://github.com/rclone/rclone)**.
+**Debrid Media Bridge (DMB)** is an All-In-One (AIO) docker image for the unified deployment of **[Riven Media's](https://github.com/rivenmedia)**, **[yowmamasita's](https://github.com/yowmamasita)**, **[iPromKnight's](https://github.com/iPromKnight/zilean)**, **[Nick Craig-Wood's](https://github.com/ncw)**, **[Michael Stonebraker's](https://en.wikipedia.org/wiki/Michael_Stonebraker)**, and **[Dave Page's](https://github.com/dpage)** projects -- **[Riven](https://github.com/rivenmedia/riven)**, **[Zurg](https://github.com/debridmediamanager/zurg-testing)**, **[Zilean](https://github.com/iPromKnight/zilean)**, **[rclone](https://github.com/rclone/rclone)**, **[PostgreSQL](https://www.postgresql.org/)**, and **[pgAdmin 4](https://www.pgadmin.org/)**.
 
 > ⚠️ **IMPORTANT**: Docker Desktop **CANNOT** be used to run DMB. Docker Desktop does not support the [mount propagation](https://docs.docker.com/storage/bind-mounts/#configure-bind-propagation) required for rclone mounts.
 >
@@ -49,8 +49,9 @@ services:
       - /home/username/docker/DMB/Zurg/mnt:/data:shared              ## Location for rclone mount to host
       - /home/username/docker/DMB/Riven/data:/riven/backend/data     ## Location for Riven backend data
       - /home/username/docker/DMB/Riven/mnt:/mnt                     ## Location for Riven symlinks
-      - /home/username/docker/DMB/PostgreSQL/data:/postgres_data     ## Location for PostgreSQL database if using Riven
-      - /home/username/docker/DMB/Zilean/data:/zilean/app/data       ## Location for Zilean data if using Riven
+      - /home/username/docker/DMB/PostgreSQL/data:/postgres_data     ## Location for PostgreSQL database
+      - /home/username/docker/pgAdmin4/data:/pgadmin/data            ## Location for pgAdmin 4 data
+      - /home/username/docker/DMB/Zilean/data:/zilean/app/data       ## Location for Zilean data
     environment:
       - TZ=
       - PUID=
@@ -61,6 +62,8 @@ services:
       - ZILEAN_ENABLED=true
       - RIVEN_ENABLED=true
       - ORIGIN=http://0.0.0.0:3000                                  ## See Riven documentation for more details
+      - PGADMIN_SETUP_EMAIL=                                        ## Set if using pgAdmin 4 - Ex. [email protected]
+      - PGADMIN_SETUP_PASSWORD=                                     ## Set if using pgAdmin 4
     # network_mode: container:gluetun                               ## Example to attach to gluetun vpn container if realdebrid blocks IP address 
     ports:
       - "3000:3000"
@@ -145,6 +148,8 @@ of this parameter has the format `<VARIABLE_NAME>=<VALUE>`.
 |`POSTGRES_USER`| The username for the PostgreSQL database |`DMB`|| :heavy_check_mark:|
 |`POSTGRES_PASSWORD`| The password for the PostgreSQL database |`postgres`|| :heavy_check_mark:|
 |`POSTGRES_DB`| The name of the PostgreSQL database |`riven`|| :heavy_check_mark:|
+|`PGADMIN_SETUP_EMAIL`| The email for the pgAdmin setup |`none`|| :heavy_check_mark:|
+|`PGADMIN_SETUP_PASSWORD`| The password for the pgAdmin setup |`none`|| :heavy_check_mark:|
 |`RIVEN_ENABLED`| Set the value "true" to enable the Riven backend and frontend processes | `false ` | | :heavy_check_mark: | |
 |`RIVEN_BACKEND_ENABLED`| Set the value "true" to enable the Riven backend process | `false ` | | :heavy_check_mark: | |
 |`RIVEN_FRONTEND_ENABLED`| Set the value "true" to enable the Riven frontend process | `false ` | | :heavy_check_mark: | |
@@ -293,9 +298,13 @@ If you enjoy the underlying projects and want to buy Riven Media a beer/coffee,
 
 If you enjoy the underlying projects and want to buy yowmamasita a beer/coffee, feel free to use the [GitHub sponsor link](https://github.com/sponsors/debridmediamanager)
 
-## 🍻 Buy **[ncw](https://github.com/ncw)** a beer/coffee? :) 
+## 🍻 Buy **[Nick Craig-Wood](https://github.com/ncw)** a beer/coffee? :) 
 
 If you enjoy the underlying projects and want to buy Nick Craig-Wood a beer/coffee, feel free to use the website's [sponsor links](https://rclone.org/sponsor/)
 
+## 🍻 Buy **[PostgreSQL](https://www.postgresql.org)** a beer/coffee? :)
+
+If you enjoy the underlying projects and want to buy PostgreSQL a beer/coffee, feel free to use the [sponsor link](https://www.postgresql.org/about/donate/)
+
 ## ✅ GitHub Workflow Status
 ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/I-am-PUID-0/DMB/docker-image.yml)

base/__init__.py

@@ -66,6 +66,8 @@ def get_valid_env(env_var, default):
 GHTOKEN = load_secret_or_env('github_token')
 SEERRAPIKEY = load_secret_or_env('seerr_api_key')
 SEERRADD = load_secret_or_env('seerr_address')
+PGADMINEMAIL = load_secret_or_env('pgadmin_setup_email')
+PGADMINPASS = load_secret_or_env('pgadmin_setup_password')
 DUPECLEAN = os.getenv('DUPLICATE_CLEANUP')
 CLEANUPINT = os.getenv('CLEANUP_INTERVAL')
 RCLONEMN = os.getenv("RCLONE_MOUNT_NAME")

docker-compose.yml

@@ -15,6 +15,7 @@ services:
       - /home/username/docker/DMB/Riven/data:/riven/backend/data     ## Location for Riven backend data
       - /home/username/docker/DMB/Riven/mnt:/mnt                     ## Location for Riven symlinks
       - /home/username/docker/DMB/PostgreSQL/data:/postgres_data     ## Location for PostgreSQL database if using Riven
+      - /home/username/docker/pgAdmin4/data:/pgadmin/data            ## Location for pgAdmin 4 data
       - /home/username/docker/DMB/Zilean/data:/zilean/app/data       ## Location for Zilean data if using Riven
     environment:
       - TZ=
@@ -26,6 +27,8 @@ services:
       - ZILEAN_ENABLED=true
       - RIVEN_ENABLED=true
       - ORIGIN=http://0.0.0.0:3000                                  ## See Riven documentation for more details
+      - PGADMIN_SETUP_EMAIL=                                        ## Set if using pgAdmin 4 - Ex. [email protected]
+      - PGADMIN_SETUP_PASSWORD=                                     ## Set if using pgAdmin 4
     # network_mode: container:gluetun                               ## Example to attach to gluetun vpn container if realdebrid blocks IP address 
     ports:
       - "3000:3000"

main.py

@@ -31,7 +31,7 @@ def unmount_all():
                 else:
                     logger.error(f"Failed to unmount {full_path}: {umount.stderr.strip()}")
 
-    processes = ['riven_frontend', 'riven_backend', 'Zilean', 'PostgreSQL', 'Zurg', 'rclone']
+    processes = ['riven_frontend', 'riven_backend', 'Zilean', 'PostgreSQL', 'Zurg', 'rclone', 'pgAdmin']
     for process in processes:
         stop_process(process)
 
@@ -43,7 +43,7 @@ def unmount_all():
 def main():
 
 
-    version = '5.1.10'
+    version = '5.2.0'
 
     ascii_art = f'''