Merge pull request #106 from linuxserver/development-2.x

switch upstream branch to 2.x

.github/workflows/external_trigger.yml

@@ -18,7 +18,7 @@ jobs:
           fi
           echo "**** External trigger running off of development branch. To disable this trigger, set a Github secret named \"PAUSE_EXTERNAL_TRIGGER_HEIMDALL_DEVELOPMENT\". ****"
           echo "**** Retrieving external version ****"
-          EXT_RELEASE=$(curl -u "${{ secrets.CR_USER }}:${{ secrets.CR_PAT }}" -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/master" | jq -r '. | .sha' | cut -c1-8)
+          EXT_RELEASE=$(curl -u "${{ secrets.CR_USER }}:${{ secrets.CR_PAT }}" -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/2.x" | jq -r '. | .sha' | cut -c1-8)
           if [ -z "${EXT_RELEASE}" ] || [ "${EXT_RELEASE}" == "null" ]; then
             echo "**** Can't retrieve external version, exiting ****"
             FAILURE_REASON="Can't retrieve external version for heimdall branch development"

Dockerfile

@@ -1,4 +1,4 @@
-FROM ghcr.io/linuxserver/baseimage-alpine-nginx:3.12
+FROM ghcr.io/linuxserver/baseimage-alpine-nginx:3.14
 
 # set version label
 ARG BUILD_DATE
@@ -17,13 +17,12 @@ RUN \
 	php7-ctype \
 	php7-pdo_sqlite \
 	php7-tokenizer \
-	php7-zip \
-	tar && \
+	php7-zip && \
  echo "**** install heimdall ****" && \
  mkdir -p \
 	/heimdall && \
  if [ -z ${HEIMDALL_RELEASE+x} ]; then \
- 	HEIMDALL_RELEASE=$(curl -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/master" \
+ 	HEIMDALL_RELEASE=$(curl -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/2.x" \
 	| awk '/sha/{print $4;exit}' FS='[""]'); \
  fi && \
  curl -o \

Dockerfile.aarch64

@@ -1,4 +1,4 @@
-FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm64v8-3.12
+FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm64v8-3.14
 
 # set version label
 ARG BUILD_DATE
@@ -17,13 +17,12 @@ RUN \
 	php7-ctype \
 	php7-pdo_sqlite \
 	php7-tokenizer \
-	php7-zip \
-	tar && \
+	php7-zip && \
  echo "**** install heimdall ****" && \
  mkdir -p \
 	/heimdall && \
  if [ -z ${HEIMDALL_RELEASE+x} ]; then \
- 	HEIMDALL_RELEASE=$(curl -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/master" \
+ 	HEIMDALL_RELEASE=$(curl -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/2.x" \
 	| awk '/sha/{print $4;exit}' FS='[""]'); \
  fi && \
  curl -o \

Dockerfile.armhf

@@ -1,4 +1,4 @@
-FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm32v7-3.12
+FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm32v7-3.14
 
 # set version label
 ARG BUILD_DATE
@@ -17,13 +17,12 @@ RUN \
 	php7-ctype \
 	php7-pdo_sqlite \
 	php7-tokenizer \
-	php7-zip \
-	tar && \
+	php7-zip && \
  echo "**** install heimdall ****" && \
  mkdir -p \
 	/heimdall && \
  if [ -z ${HEIMDALL_RELEASE+x} ]; then \
- 	HEIMDALL_RELEASE=$(curl -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/master" \
+ 	HEIMDALL_RELEASE=$(curl -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/2.x" \
 	| awk '/sha/{print $4;exit}' FS='[""]'); \
  fi && \
  curl -o \

Jenkinsfile

@@ -17,7 +17,7 @@ pipeline {
     GITLAB_TOKEN=credentials('b6f0f1dd-6952-4cf6-95d1-9c06380283f0')
     GITLAB_NAMESPACE=credentials('gitlab-namespace-id')
     SCARF_TOKEN=credentials('scarf_api_key')
-    EXT_GIT_BRANCH = 'master'
+    EXT_GIT_BRANCH = '2.x'
     EXT_USER = 'linuxserver'
     EXT_REPO = 'Heimdall'
     CONTAINER_NAME = 'heimdall'
@@ -353,9 +353,11 @@ pipeline {
               if [[ ("${BRANCH_NAME}" == "master") || ("${BRANCH_NAME}" == "main") ]] && [[ (! -f ${TEMPDIR}/unraid/templates/unraid/${CONTAINER_NAME}.xml) || ("$(md5sum ${TEMPDIR}/unraid/templates/unraid/${CONTAINER_NAME}.xml | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml | awk '{ print $1 }')") ]]; then
                 cd ${TEMPDIR}/unraid/templates/
                 if grep -wq "${CONTAINER_NAME}" ${TEMPDIR}/unraid/templates/unraid/ignore.list; then
-                  echo "Image is on the ignore list, removing Unraid template"
-                  git rm unraid/${CONTAINER_NAME}.xml || :
-                  git commit -m 'Bot Removing Deprecated Unraid Template' || :
+                  echo "Image is on the ignore list, marking Unraid template as deprecated"
+                  cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml ${TEMPDIR}/unraid/templates/unraid/
+                  git add -u unraid/${CONTAINER_NAME}.xml
+                  git mv unraid/${CONTAINER_NAME}.xml unraid/deprecated/${CONTAINER_NAME}.xml || :
+                  git commit -m 'Bot Moving Deprecated Unraid Template' || :
                 else
                   cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml ${TEMPDIR}/unraid/templates/unraid/
                   git add unraid/${CONTAINER_NAME}.xml
@@ -718,7 +720,7 @@ pipeline {
                 -e DO_REGION="ams3" \
                 -e DO_BUCKET="lsio-ci" \
                 -t ghcr.io/linuxserver/ci:latest \
-                python /ci/ci.py'''
+                python3 test_build.py'''
         }
       }
     }

README.md

@@ -48,17 +48,26 @@ Why not use it as your browser start page? It even has the ability to include a
 
 ## Supported Architectures
 
-Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
+We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
 
-Simply pulling `lscr.io/linuxserver/heimdall` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
+Simply pulling `lscr.io/linuxserver/heimdall:development` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
 
 The architectures supported by this image are:
 
-| Architecture | Tag |
-| :----: | --- |
-| x86-64 | amd64-latest |
-| arm64 | arm64v8-latest |
-| armhf | arm32v7-latest |
+| Architecture | Available | Tag |
+| :----: | :----: | ---- |
+| x86-64 | ✅ | amd64-\<version tag\> |
+| arm64 | ✅ | arm64v8-\<version tag\> |
+| armhf| ✅ | arm32v7-\<version tag\> |
+
+## Version Tags
+
+This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
+
+| Tag | Available | Description |
+| :----: | :----: |--- |
+| latest | ✅ | Stable Heimdall releases. |
+| development | ✅ | Latest commit from the github 2.x branch. |
 
 ## Application Setup
 
@@ -80,14 +89,14 @@ Here are some example snippets to help you get started creating a container.
 version: "2.1"
 services:
   heimdall:
-    image: lscr.io/linuxserver/heimdall
+    image: lscr.io/linuxserver/heimdall:development
     container_name: heimdall
     environment:
       - PUID=1000
       - PGID=1000
       - TZ=Europe/London
     volumes:
-      - </path/to/appdata/config>:/config
+      - /path/to/appdata/config:/config
     ports:
       - 80:80
       - 443:443
@@ -104,16 +113,11 @@ docker run -d \
   -e TZ=Europe/London \
   -p 80:80 \
   -p 443:443 \
-  -v </path/to/appdata/config>:/config \
+  -v /path/to/appdata/config:/config \
   --restart unless-stopped \
-  lscr.io/linuxserver/heimdall
+  lscr.io/linuxserver/heimdall:development
 ```
 
-Using tags, you can switch between the stable releases of Heimdall and the master branch. No tag is required for the latest stable release.
-Add the development tag,  if required,  to the linuxserver/heimdall line of the run/create command in the following format, linuxserver/heimdall:development
-The development tag will be the latest commit in the master branch of Heimdall.
-HOWEVER , USE THE DEVELOPMENT TAG AT YOUR OWN PERIL !!!!!!!!!
-
 ## Parameters
 
 Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
@@ -170,7 +174,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
 * container version number
   * `docker inspect -f '{{ index .Config.Labels "build_version" }}' heimdall`
 * image version number
-  * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/heimdall`
+  * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/heimdall:development`
 
 ## Updating Info
 
@@ -188,7 +192,7 @@ Below are the instructions for updating containers:
 
 ### Via Docker Run
 
-* Update the image: `docker pull lscr.io/linuxserver/heimdall`
+* Update the image: `docker pull lscr.io/linuxserver/heimdall:development`
 * Stop the running container: `docker stop heimdall`
 * Delete the container: `docker rm heimdall`
 * Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
@@ -223,7 +227,7 @@ cd docker-heimdall
 docker build \
   --no-cache \
   --pull \
-  -t lscr.io/linuxserver/heimdall:latest .
+  -t lscr.io/linuxserver/heimdall:development .
 ```
 
 The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
@@ -236,6 +240,9 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
 
 ## Versions
 
+* **04.11.22:** - Build commits to upstream branch 2.x.
+* **13.03.21:** - Make searchproviders.yaml user configurable.
+* **11.03.21:** - Rebase to alpine 3.14.
 * **10.02.21:** - Revert to alpine 3.12 as php 7.4 broke laravel.
 * **10.02.21:** - Rebasing to alpine 3.13.
 * **01.06.20:** - Rebasing to alpine 3.12.

jenkins-vars.yml

@@ -7,7 +7,7 @@ release_type: prerelease
 release_tag: development
 ls_branch: development
 repo_vars:
-  - EXT_GIT_BRANCH = 'master'
+  - EXT_GIT_BRANCH = '2.x'
   - EXT_USER = 'linuxserver'
   - EXT_REPO = 'Heimdall'
   - CONTAINER_NAME = 'heimdall'

package_versions.txt

@@ -1,71 +1,75 @@
-alpine-baselayout-3.2.0-r7
+alpine-baselayout-3.2.0-r16
 alpine-keys-2.4-r0
-apache2-utils-2.4.51-r0
-apk-tools-2.10.8-r0
-apr-1.7.0-r0
-apr-util-1.6.1-r6
+apache2-utils-2.4.54-r0
+apk-tools-2.12.7-r0
+apr-1.7.0-r1
+apr-util-1.6.1-r7
 argon2-libs-20190702-r1
-bash-5.0.17-r0
-busybox-1.31.1-r21
-ca-certificates-20191127-r4
-ca-certificates-bundle-20191127-r4
-coreutils-8.32-r0
-curl-7.79.1-r0
-expat-2.2.9-r1
-git-2.26.3-r0
+bash-5.1.16-r0
+brotli-libs-1.0.9-r5
+busybox-1.33.1-r8
+ca-certificates-20220614-r0
+ca-certificates-bundle-20220614-r0
+coreutils-8.32-r2
+curl-7.79.1-r3
+expat-2.5.0-r0
+git-2.32.4-r0
 libacl-2.2.53-r0
-libattr-2.4.48-r0
+libattr-2.5.1-r0
 libc-utils-0.7.2-r3
-libcrypto1.1-1.1.1l-r0
-libcurl-7.79.1-r0
-libedit-20191231.3.1-r0
-libintl-0.20.2-r0
-libmagic-5.38-r0
-libproc-3.3.16-r0
-libressl3.1-libcrypto-3.1.2-r0
-libressl3.1-libssl-3.1.2-r0
-libssl1.1-1.1.1l-r0
-libtls-standalone-2.9.1-r1
-libuuid-2.35.2-r0
-libxml2-2.9.12-r0
-libzip-1.6.1-r1
-linux-pam-1.3.1-r4
-logrotate-3.16.0-r0
-musl-1.1.24-r10
-musl-utils-1.1.24-r10
-nano-4.9.3-r0
-ncurses-libs-6.2_p20200523-r1
-ncurses-terminfo-base-6.2_p20200523-r1
-nghttp2-libs-1.41.0-r0
-nginx-1.18.0-r3
-openssl-1.1.1l-r0
+libcrypto1.1-1.1.1q-r0
+libcurl-7.79.1-r3
+libedit-20210216.3.1-r0
+libintl-0.21-r0
+libmagic-5.40-r1
+libproc-3.3.17-r0
+libressl3.3-libcrypto-3.3.6-r0
+libressl3.3-libssl-3.3.6-r0
+libretls-3.3.3p1-r3
+libssl1.1-1.1.1q-r0
+libuuid-2.37.4-r0
+libxml2-2.9.14-r2
+libzip-1.7.3-r2
+linux-pam-1.5.1-r1
+logrotate-3.18.1-r4
+musl-1.2.2-r3
+musl-utils-1.2.2-r3
+nano-5.7-r2
+ncurses-libs-6.2_p20210612-r1
+ncurses-terminfo-base-6.2_p20210612-r1
+nghttp2-libs-1.43.0-r0
+nginx-1.20.2-r1
+oniguruma-6.9.7.1-r0
+openssl-1.1.1s-r0
 pcre-8.44-r0
-pcre2-10.35-r0
-php7-7.3.33-r0
-php7-common-7.3.33-r0
-php7-ctype-7.3.33-r0
-php7-fileinfo-7.3.33-r0
-php7-fpm-7.3.33-r0
-php7-json-7.3.33-r0
-php7-mbstring-7.3.33-r0
-php7-openssl-7.3.33-r0
-php7-pdo-7.3.33-r0
-php7-pdo_sqlite-7.3.33-r0
-php7-session-7.3.33-r0
-php7-simplexml-7.3.33-r0
-php7-tokenizer-7.3.33-r0
-php7-xml-7.3.33-r0
-php7-xmlwriter-7.3.33-r0
-php7-zip-7.3.33-r0
-popt-1.16-r7
-procps-3.3.16-r0
-readline-8.0.4-r0
-scanelf-1.2.6-r0
+pcre2-10.36-r1
+php7-7.4.32-r0
+php7-common-7.4.32-r0
+php7-ctype-7.4.33-r0
+php7-fileinfo-7.4.32-r0
+php7-fpm-7.4.32-r0
+php7-json-7.4.32-r0
+php7-mbstring-7.4.32-r0
+php7-openssl-7.4.32-r0
+php7-pdo-7.4.33-r0
+php7-pdo_sqlite-7.4.33-r0
+php7-session-7.4.32-r0
+php7-simplexml-7.4.32-r0
+php7-tokenizer-7.4.33-r0
+php7-xml-7.4.32-r0
+php7-xmlwriter-7.4.32-r0
+php7-zip-7.4.33-r0
+popt-1.18-r0
+procps-3.3.17-r0
+readline-8.1.0-r0
+s6-ipcserver-2.10.0.3-r0
+scanelf-1.3.2-r0
 shadow-4.8.1-r0
-sqlite-libs-3.32.1-r1
-ssl_client-1.31.1-r21
-tar-1.32-r2
-tzdata-2021e-r0
-xz-5.2.5-r0
-xz-libs-5.2.5-r0
-zlib-1.2.11-r3
+skalibs-2.10.0.3-r0
+sqlite-libs-3.35.5-r0
+ssl_client-1.33.1-r8
+tzdata-2022c-r0
+utmps-0.1.0.2-r0
+xz-5.2.5-r1
+xz-libs-5.2.5-r1
+zlib-1.2.12-r3

readme-vars.yml

@@ -17,12 +17,18 @@ available_architectures:
   - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
   - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}
 
+# development version
+development_versions: true
+development_versions_items:
+  - { tag: "latest", desc: "Stable Heimdall releases." }
+  - { tag: "development", desc: "Latest commit from the github 2.x branch." }
+
 # container parameters
 common_param_env_vars_enabled: true
 param_container_name: "{{ project_name }}"
 param_usage_include_vols: true
 param_volumes:
-  - { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "Contains all relevant configuration files." }
+  - { vol_path: "/config", vol_host_path: "/path/to/appdata/config", desc: "Contains all relevant configuration files." }
 param_usage_include_ports: true
 param_ports:
   - { external_port: "80", internal_port: "80", port_desc: "http gui" }
@@ -32,7 +38,7 @@ param_env_vars:
   - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
 
 # optional parameters
-optional_block_1: true
+optional_block_1: false
 optional_block_1_items:
   - |
     Using tags, you can switch between the stable releases of Heimdall and the master branch. No tag is required for the latest stable release.
@@ -52,6 +58,9 @@ app_setup_block: |
 
 # changelog
 changelogs:
+  - { date: "04.11.22:", desc: "Build commits to upstream branch 2.x." }
+  - { date: "13.03.21:", desc: "Make searchproviders.yaml user configurable." }
+  - { date: "11.03.21:", desc: "Rebase to alpine 3.14." }
   - { date: "10.02.21:", desc: "Revert to alpine 3.12 as php 7.4 broke laravel." }
   - { date: "10.02.21:", desc: "Rebasing to alpine 3.13." }
   - { date: "01.06.20:", desc: "Rebasing to alpine 3.12." }

root/etc/cont-init.d/50-config

@@ -15,6 +15,7 @@ mkdir -p \
  echo -e '\n# Heimdall user authorization\nfastcgi_param  PHP_AUTH_USER $remote_user;\nfastcgi_param  PHP_AUTH_PW $http_authorization;' >> \
 	/etc/nginx/fastcgi_params && \
  rm -rf /heimdall && \
+ cp /var/www/localhost/heimdall/storage/app/searchproviders.yaml /var/www/localhost/heimdall/storage/app/searchproviders.yaml.orig && \
  chown -R abc:abc /var/www/localhost/heimdall
 
 # create symlinks
@@ -43,6 +44,11 @@ done
   cp /var/www/localhost/heimdall/.env.example /config/www/.env && \
   echo "generating app key"
   php /var/www/localhost/heimdall/artisan key:generate
+# copy searchproviders if not exists and symlink
+[[ ! -f /config/www/searchproviders.yaml ]] && \
+  cp /var/www/localhost/heimdall/storage/app/searchproviders.yaml.orig /config/www/searchproviders.yaml
+rm -rf /var/www/localhost/heimdall/storage/app/searchproviders.yaml
+ln -s /config/www/searchproviders.yaml /var/www/localhost/heimdall/storage/app/searchproviders.yaml
 # set queue driver to database
 sed -i 's/QUEUE_DRIVER=sync/QUEUE_DRIVER=database/' /config/www/.env