670 feature request add support for qobuz new authentication mode (#671)

* #670 qobuz authentication review

* #670 complete with documentation

- add remarks in the generated upmpdcli.conf file
- add entry in News section of README.md

Author: GioF71

Dockerfile

@@ -154,8 +154,6 @@ ENV CHECK_CONTENT_FORMAT=""
 
 ENV QOBUZ_ENABLE=no
 ENV QOBUZ_TITLE=""
-ENV QOBUZ_USERNAME="qobuz_username"
-ENV QOBUZ_PASSWORD="qobuz_password"
 ENV QOBUZ_FORMAT_ID=5
 ENV QOBUZ_RENUM_TRACKS=""
 ENV QOBUZ_EXPLICIT_ITEM_NUMBERS=""

README.md

@@ -23,6 +23,13 @@ Current version is `1.9.17`.
 
 ## News (newest first)
 
+### Support for the updated qobuz authentication method
+
+The former authentication method, based on username and password, doesn't work anymore.  
+So the variables `QOBUZ_USERNAME` and `QOBUZ_PASSWORD` have been removed.  
+By setting `QOBUZ_ENABLE` to `yes`, the initialization script will set the `qobuzuser` configuration key to `qobuz` just to enable the mediaserver.  
+You will need to run the `qobuz-init-auth.py` script from inside the container, as mentioned in the [Qobuz example configuration](./doc/example-configurations.md#qobuz).  
+
 ### Download variables deprecated
 
 We can now avoid to download plugin at runtime. Just use updated master/edge images (see below).  
@@ -281,8 +288,6 @@ TIDAL_ALLOW_STATISTICS_ACTIONS|Allow the creation of entries that can remove ent
 TIDAL_ENABLE_USER_AGENT_WHITELIST|Enables the agent whitelist for hi-res support, default is `yes`
 QOBUZ_ENABLE|Set to `yes` to enable Qobuz support, defaults to `no`
 QOBUZ_TITLE|Set the title for Qobuz plugin, defaults to `Qobuz`
-QOBUZ_USERNAME|Your Qobuz account username
-QOBUZ_PASSWORD|Your Qobuz account password
 QOBUZ_FORMAT_ID|Qobuz format id: 5 for mp3/320, 6 for FLAC, 7 for FLAC 24/96, 27 for hi-res, defaults to `5`
 QOBUZ_RENUM_TRACKS|Renum tracks in albums and playlists, mostly for kodi compatibility, defaults to `1`
 QOBUZ_EXPLICIT_ITEM_NUMBERS|Adds numbers in square brackets in list items, mostly for kodi compatibility, defaults to `0`
@@ -323,11 +328,10 @@ FILE|DESCRIPTION
 :---|:---
 additional-radio-list.txt|Additional Radios
 recoll.conf.user|Recoll configuration (used by upcrl)
-qobuz.txt|Qobuz Credentials
 hra.txt|HRA Credentials, format is like a .env file. Make sure you include all the settings related the streaming service.
 upmpdcli-additional.txt|Configuration snippet, will be appended to upmpdcli.conf.
 
-For `qobuz.txt` and `hra.txt`, the format of the file must be like a `.env` file, where all the settings which are related to the service must be listed. Mixed configurations (so part in variables, part in these files) are not supported.  
+For `hra.txt`, the format of the file must be like a `.env` file, where all the settings which are related to the service must be listed. Mixed configurations (so part in variables, part in these files) are not supported.  
 The upmpdcli-additional.txt is a simple list of lines with a `key = value` synthax.
 
 ### Custom icon

app/bin/run-upmpdcli.sh

@@ -48,7 +48,6 @@ fi
 SOURCE_CONFIG_FILE=/app/conf/upmpdcli.conf
 CONFIG_FILE=/tmp/current-upmpdcli.conf
 
-QOBUZ_CREDENTIALS_FILE=/user/config/qobuz.txt
 HRA_CREDENTIALS_FILE=/user/config/hra.txt
 
 UPMPDCLI_ADDITIONAL_FILE=/user/config/upmpdcli-additional.txt
@@ -78,16 +77,6 @@ if [[ -n $ENABLE_UPRCL ]]; then
     fi
 fi
 
-if [[ -f "$QOBUZ_CREDENTIALS_FILE" ]]; then
-    echo "Reading $QOBUZ_CREDENTIALS_FILE"
-    read_file $QOBUZ_CREDENTIALS_FILE
-    QOBUZ_USERNAME=$(get_value "QOBUZ_USERNAME" $PARAMETER_PRIORITY)
-    QOBUZ_PASSWORD=$(get_value "QOBUZ_PASSWORD" $PARAMETER_PRIORITY)
-    QOBUZ_FORMAT_ID=$(get_value "QOBUZ_FORMAT_ID" $PARAMETER_PRIORITY)
-else
-    echo "File $QOBUZ_CREDENTIALS_FILE not found."
-fi
-
 if [[ -f "$HRA_CREDENTIALS_FILE" ]]; then
     echo "Reading $HRA_CREDENTIALS_FILE"
     read_file $HRA_CREDENTIALS_FILE
@@ -580,11 +569,15 @@ fi
 echo "Qobuz Enable [$QOBUZ_ENABLE]"
 if [[ "${QOBUZ_ENABLE^^}" == "YES" ]]; then
     echo "Processing Qobuz settings";
+    # creating bogus user to activate the qobuz media server
+    echo "# qobuzuser is set to an arbitrary value" >> $CONFIG_FILE
+    echo "# Such value has nothing to do with your username" >> $CONFIG_FILE
+    echo "# It is just needed to activate the qobuz media server" >> $CONFIG_FILE
+    echo "# You will need to authenticate using the qobuz-init-auth.py script" >> $CONFIG_FILE
+    echo "qobuzuser = qobuz" >> $CONFIG_FILE
     if [[ -n "${QOBUZ_TITLE}" ]]; then
         echo "qobuztitle = ${QOBUZ_TITLE}" >> $CONFIG_FILE
     fi
-    echo "qobuzuser = $QOBUZ_USERNAME" >> $CONFIG_FILE
-    echo "qobuzpass = $QOBUZ_PASSWORD" >> $CONFIG_FILE
     if [[ -n "${QOBUZ_FORMAT_ID}" ]]; then
         echo "qobuzformatid = $QOBUZ_FORMAT_ID" >> $CONFIG_FILE
     fi

doc/change-history.md

@@ -2,6 +2,7 @@
 
 Change Date|Major Changes
 ---|---
+2026-05-09|Changes for new qobuz authentication method (see [#670](https://github.com/GioF71/upmpdcli-docker/issues/670))
 2026-05-04|Fix a bad substitution (see [#668](https://github.com/GioF71/upmpdcli-docker/issues/668))
 2026-05-04|Submodule `master` updated to Subsonic Plugin 0.9.14
 2026-05-04|Submodule `edge` updated to Subsonic Plugin 0.9.14

doc/example-configurations.md

@@ -265,18 +265,18 @@ services:
       - QOBUZ_ENABLE=yes
     volumes:
       - ./config/uprclconfdir:/uprcl/confdir
-      - ./config/credentials/qobuz.txt:/user/config/qobuz.txt:ro
     labels:
       - com.centurylinklabs.watchtower.enable=false
     restart: unless-stopped
 ```
 
-The `qobuz.txt` file should resemble the following:
+You will need to authenticate with qobuz. Assuming the service in compose file is named `upmpdcli` as in the previous example file, do the following:
 
 ```text
-QOBUZ_USERNAME=qobuz-username
-QOBUZ_PASSWORD=qobuz-password
-QOBUZ_FORMAT_ID=27
+# enter the container
+docker compose exec upmpdcli /bin/bash
+# cd to the qobuz plugin directory
+cd /usr/share/upmpdcli/cdplugins/qobuz
+# initiate the authentication (follow on-screen instructions)
+./qobuz-init-oauth.py
 ```
-
-Alternatively, those values can be passed as individual environment variables.