Removed environment variables and added docker secrets for more security

.gitignore

@@ -174,4 +174,5 @@ music
 config
 Music
 /docker-compose.yml
-dev*
+dev*
+/examples/config.json

CHANGELOG.md

@@ -1,4 +1,7 @@
 # Changelog
+**v3.0.3 (26 Mar 2024)**
+- Enviroment Variables removed and added docker secrets for more security
+
 **v3.0.2 (22 Dec 2023)**
 - already downloaded log entries become info instead of warning
 - use `logger` instead of `logging`

README.md

@@ -39,7 +39,7 @@ Tested with versions `3.10 <= python <= 3.12`, however slightly older versions p
 cd examples
 ```
 
-Edit `docker-compose.yml` with your username and password.
+Copy `config.example.json` to `config.json` and enter your username and password
 
 ```bash
 sudo docker compose run --rm zyspotify -lsdall

examples/config.example.json

@@ -0,0 +1,4 @@
+{
+    "USERNAME": "example@gmail.com",
+    "PASSWORD": "hunter2"
+}

examples/docker-compose.yml

@@ -2,16 +2,14 @@ version: "3"
 services:
   zyspotify:
     image: kaitallaoua/zyspotify
-
+    secrets:
+      - spotify_login
     # bind to a vpn container already running if desired
     # such as https://github.com/wfg/docker-openvpn-client
     # network_mode: container:openvpn-client
     volumes:
       - ./log:/root/zyspotify_log
       - ./config:/root/config
       - ./Music:/root/Music
-    environment:
-
-      # These should be removed after the first run. since credentials cached in db
-      - USERNAME=example@gmail.com
-      - PASSWORD=hunter2
+    secrets:
+      - spotify_login: ./config.json

zyspotify/__main__.py

@@ -14,16 +14,22 @@
 import logging
 from logging.handlers import RotatingFileHandler
 from logging.config import dictConfig
-
+from json import loads
 import errno
 
 try:
     __version__ = metadata.version("zyspotify")
 except metadata.PackageNotFoundError:
     __version__ = "unknown"
 
-_USERNAME = os.environ.get("USERNAME", None)
-_PASSWORD = os.environ.get("PASSWORD", None)
+_USERNAME = None
+_PASSWORD = None
+with open("/run/secrets/spotify_login") as login:
+    login = loads(login)
+    if "USERNAME" in login:
+        _USERNAME =  login["USERNAME"]
+    if "PASSWORD" in login:
+        _PASSWORD =  login["PASSWORD"]
 
 GENERIC_MAX_STR_LEN = 50