Docker: v24 fixes (#256)

README.md

@@ -66,6 +66,7 @@ QNAP packages are available as native / buildroot packages or via [sherpa](https
 
 ## Brief introduction on how to use NZBGet
  - [How to use](docs/HOW_TO_USE.md)
+ - [Performance tips](docs/PERFORMANCE.md)
 
 ## Contribution
 

docker/Dockerfile

@@ -3,8 +3,9 @@ FROM alpine:3.19.1 AS build
 
 # args
 ARG NZBGET_RELEASE=develop
-ARG UNRAR_VERSION=7.0.7
-ARG UNRAR_NATIVE=false
+ARG UNRAR6_VERSION=6.2.12
+ARG UNRAR7_VERSION=7.0.7
+ARG UNRAR7_NATIVE=false
 ARG MAKE_JOBS=1
 ARG TARGETPLATFORM
 
@@ -44,19 +45,26 @@ RUN \
   ln -s /usr/bin/unrar /app/nzbget/unrar && \
   cp /nzbget/pubkey.pem /app/nzbget/pubkey.pem && \
   curl -o /app/nzbget/cacert.pem -L "https://curl.se/ca/cacert.pem" && \
-  echo "**** install unrar from source ****" && \
-  mkdir /tmp/unrar && \
-  curl -o /tmp/unrar.tar.gz -L "https://www.rarlab.com/rar/unrarsrc-${UNRAR_VERSION}.tar.gz" && \  
-  tar xf /tmp/unrar.tar.gz -C /tmp/unrar --strip-components=1 && \
-  cd /tmp/unrar && \
-  if [ "${UNRAR_NATIVE}" != "true" ] && [ "${TARGETPLATFORM}" == "linux/amd64" ]; \
+  echo "**** install unrar7 from source ****" && \
+  mkdir /tmp/unrar7 && \
+  curl -o /tmp/unrar7.tar.gz -L "https://www.rarlab.com/rar/unrarsrc-${UNRAR7_VERSION}.tar.gz" && \
+  tar xf /tmp/unrar7.tar.gz -C /tmp/unrar7 --strip-components=1 && \
+  cd /tmp/unrar7 && \
+  if [ "${UNRAR7_NATIVE}" != "true" ] && [ "${TARGETPLATFORM}" == "linux/amd64" ]; \
     then sed -i "s|CXXFLAGS=-march=native|CXXFLAGS=-march=x86-64-v2|" makefile; fi && \
-  if [ "${UNRAR_NATIVE}" != "true" ] && [ "${TARGETPLATFORM}" == "linux/arm64" ]; \
-    then sed -i "s|CXXFLAGS=-march=native|CXXFLAGS=-march=armv8-a|" makefile; fi && \
-  if [ "${UNRAR_NATIVE}" != "true" ] && [ "${TARGETPLATFORM}" == "linux/arm/v7" ]; \
+  if [ "${UNRAR7_NATIVE}" != "true" ] && [ "${TARGETPLATFORM}" == "linux/arm64" ]; \
+    then sed -i "s|CXXFLAGS=-march=native|CXXFLAGS=-march=armv8-a+crypto+crc|" makefile; fi && \
+  if [ "${UNRAR7_NATIVE}" != "true" ] && [ "${TARGETPLATFORM}" == "linux/arm/v7" ]; \
     then sed -i "s|CXXFLAGS=-march=native|CXXFLAGS=-march=armv7-a|" makefile; fi && \
   make -j ${MAKE_JOBS} && \
-  install -v -m755 unrar /usr/bin
+  install -v -m755 unrar /usr/bin/unrar7 && \
+  echo "**** install unrar6 from source ****" && \
+  mkdir /tmp/unrar6 && \
+  curl -o /tmp/unrar6.tar.gz -L "https://www.rarlab.com/rar/unrarsrc-${UNRAR6_VERSION}.tar.gz" && \
+  tar xf /tmp/unrar6.tar.gz -C /tmp/unrar6 --strip-components=1 && \
+  cd /tmp/unrar6 && \
+  make -j ${MAKE_JOBS} && \
+  install -v -m755 unrar /usr/bin/
 
 # runtime stage
 FROM alpine:3.19.1
@@ -75,6 +83,7 @@ RUN \
   echo "**** cleanup ****" && \
   rm -rf /root/.cache /root/.cargo /tmp/*
 COPY --from=build /usr/bin/unrar /usr/bin/unrar
+COPY --from=build /usr/bin/unrar7 /usr/bin/unrar7
 COPY --from=build /app/nzbget/ /app/nzbget/
 ADD entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh && \

docker/README.md

@@ -99,8 +99,9 @@ Dockerfile supports next build arguments:
 | Argument	      | Description
 |:----------------|-
 | NZBGET_RELEASE  | Branch name or tag to build from
-| UNRAR_VERSION   | Unrar version
-| UNRAR_NATIVE    | Build native unrar (see below)
+| UNRAR6_VERSION  | Unrar 6 version
+| UNRAR7_VERSION  | Unrar 7 version
+| UNRAR7_NATIVE   | Build native unrar (see below)
 | MAKE_JOBS       | Number of make jobs for speed up build
 
 # ghcr.io
@@ -118,15 +119,19 @@ In case a linux image or docker image is slower than expected, here are some tip
 1. Increase number of server connections (NEWS-SERVERS -> Connections) - default is 8, and 16 and 32 are worth trying
 2. For slower machines/hosts - increase article read chunk size from 4 to 64 (CONNECTION -> ArticleReadChunkSize). This is new setting available in v23.
 
-# Native unrar build support
+# Unrar 7 support
 
-Unrar from version 7.0 supports hardware crypto acceleration for unpacking encrypted archives.
-For compatibility with most hardware nzbgetcom image unrar built with next march parameters:
+The NZBGet docker image contains the optimized unrar7 binary. To use unrar7, change in settings UNPACK - UnrarCmd to `unrar7`.
+Unrar 7 built with next march parameters:
 
 - x86_64: x86-64-v2
-- arm64:  armv8-a
+- arm64:  armv8-a+crypto+crc
 - armhf:  armv7-a
 
+More information about unrar performance: [Performance tips](https://github.com/nzbgetcom/nzbget/blob/develop/docs/PERFORMANCE.md#unrar)
+
+# Native unrar 7 build support
+
 To build image on hardware which support crypto acceleration with native-optimized unrar can be used docker-compose like this (also needed entrypoint.sh and Dockerfile from [official repository](https://github.com/nzbgetcom/nzbget/tree/develop/docker)):
 
 
@@ -142,7 +147,7 @@ services:
         # make jobs == host cpu cores
         MAKE_JOBS: 4
         # build native unrar
-        UNRAR_NATIVE: "true"
+        UNRAR7_NATIVE: "true"
     environment:
       - PUID=1000
       - PGID=1000

docker/docker-compose.yml

@@ -6,7 +6,7 @@ services:
       args:
         NZBGET_RELEASE: develop
         MAKE_JOBS: 4
-        UNRAR_NATIVE: true
+        UNRAR7_NATIVE: true
     environment:
       - PUID=1000
       - PGID=1000

docker/entrypoint.sh

@@ -23,29 +23,23 @@ if [ ! -f /config/nzbget.conf ]; then
     chown user:users /config/nzbget.conf
 fi
 
-# create scripts dir
-if [ ! -d /downloads/scripts ]; then
-    mkdir -p /downloads/scripts
-    chown user:users /downloads/scripts
-fi
-
 # parse env vars to options
 OPTIONS=""
 if [ ! -z "${NZBGET_USER}" ]; then
-  OPTIONS="${OPTIONS}-o ControlUsername=${NZBGET_USER} "
+    OPTIONS="${OPTIONS}-o ControlUsername=${NZBGET_USER} "
 fi
 if [ ! -z "${NZBGET_PASS}" ]; then
-  OPTIONS="${OPTIONS}-o ControlPassword=${NZBGET_PASS} "
+    OPTIONS="${OPTIONS}-o ControlPassword=${NZBGET_PASS} "
 fi
 
 chown user:users /config || CONFIG_CHOWN_STATUS=$?
 if [ ! -z $CONFIG_CHOWN_STATUS ]; then
-  echo "*** Could not set permissions on /config ; this container may not work as expected ***"
+    echo "*** Could not set permissions on /config ; this container may not work as expected ***"
 fi
 
 chown user:users /downloads || DOWNLOADS_CHOWN_STATUS=$?
 if [ ! -z $DOWNLOADS_CHOWN_STATUS ]; then
-  echo "*** Could not set permissions on /downloads ; this container may not work as expected ***"
+    echo "*** Could not set permissions on /downloads ; this container may not work as expected ***"
 fi
 
 su -p user -c "/app/nzbget/nzbget -s -c /config/nzbget.conf -o OutputMode=log ${OPTIONS}"

docs/PERFORMANCE.md

@@ -0,0 +1,44 @@
+# NZBGet performance tips (WIP)
+
+## Unrar
+
+Unrar from version 7 provides improved performance when extracting encrypted archives, especially when built with optimized march.
+
+Several tests (`time unrar -p<password> x <archive>`, archive size ~1.6Gb):
+
+- arm64 (Mac mini M2)
+  - unrar 6.24
+    ```
+    real    0m 27.71s
+    user    0m 25.00s
+    sys     0m 1.41s
+    ```
+  - unrar 7.0 march=armv8-a
+    ```
+    real    0m 11.04s
+    user    0m 9.28s
+    sys     0m 1.19s
+    ```
+  - unrar 7.0 march=armv8-a+crypto+crc
+    ```
+    real    0m 6.04s
+    user    0m 3.59s
+    sys     0m 1.48s
+    ```
+
+- x86_64 (Intel Xeon E3-1265L V2)
+  - unrar 6.24
+    ```
+    real    0m 13.51s
+    user    0m 12.08s
+    sys     0m 1.27s
+    ```
+  - unrar 7.0 march=x86-64-v2
+    ```
+    real    0m 6.13s
+    user    0m 5.34s
+    sys     0m 1.90s
+    ```
+
+Extraction speed is increased by ~2x and ~4.5x when using the optimized binary.
+The NZBGet docker container includes unrar6 (used by default, for most compatibility), and an optimized unrar7 (can be enabled in the settings). More information can be found in [Docker readme](../docker/README.md#unrar-7-support)