Restructure for v8

Author: aptalca

.github/workflows/external_trigger.yml

@@ -20,7 +20,7 @@ jobs:
           echo "**** External trigger running off of master branch. To disable this trigger, set a Github secret named \"PAUSE_EXTERNAL_TRIGGER_FOLDINGATHOME_MASTER\". ****"
           echo "External trigger running off of master branch. To disable this trigger, set a Github secret named \`PAUSE_EXTERNAL_TRIGGER_FOLDINGATHOME_MASTER\`" >> $GITHUB_STEP_SUMMARY
           echo "**** Retrieving external version ****"
-          EXT_RELEASE=$(curl -H 'Accept-Encoding: gzip' -fSsL --compressed https://download.foldingathome.org/releases.py?series=7.6 | jq -r '.[] | select(.title=="64bit Linux") | .groups[0].files[0].filename' | awk -F'(fahclient_|_amd64.deb)' '{print $2}')
+          EXT_RELEASE=$(curl -H 'Accept-Encoding: gzip' -fSsL --compressed https://download.foldingathome.org/releases.py | jq -r '.[] | select(.title=="64bit Linux") | .groups[0].files[0].filename' | awk -F'(fah-client_|_amd64.deb)' '{print $2}')
           if [ -z "${EXT_RELEASE}" ] || [ "${EXT_RELEASE}" == "null" ]; then
             echo "**** Can't retrieve external version, exiting ****"
             FAILURE_REASON="Can't retrieve external version for foldingathome branch master"

Dockerfile

@@ -13,21 +13,20 @@ LABEL maintainer="aptalca"
 ENV NVIDIA_DRIVER_CAPABILITIES="compute,video,utility"
 
 # global environment settings
-ENV DEBIAN_FRONTEND="noninteractive" \
-  MAJOR_VERSION=7.6
+ENV DEBIAN_FRONTEND="noninteractive"
 
 RUN \
   echo "**** install runtime packages ****" && \
   apt-get update && \
   apt-get install -y \
-    ocl-icd-libopencl1 && \
+    intel-opencl-icd && \
   ln -s libOpenCL.so.1 /usr/lib/x86_64-linux-gnu/libOpenCL.so && \
   echo "**** install foldingathome ****" && \
-  download_url=$(curl -H 'Accept-Encoding: gzip' -fSsL --compressed https://download.foldingathome.org/releases.py?series=${MAJOR_VERSION} | jq -r '.[] | select(.title=="64bit Linux") | .groups[].files[].url' | grep "fahclient" | grep "deb" | grep "amd64") && \
+  download_url=$(curl -H 'Accept-Encoding: gzip' -fSsL --compressed https://download.foldingathome.org/releases.py | jq -r '.[] | select(.title=="64bit Linux") | .groups[].files[].url' | grep "fah-client" | grep "amd64.deb") && \
   curl -o \
     /tmp/fah.deb -L \
     ${download_url} && \
-  dpkg -x /tmp/fah.deb /app && \
+  dpkg -x /tmp/fah.deb / && \
   printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \
   echo "**** cleanup ****" && \
   apt-get clean && \

Dockerfile.aarch64

@@ -13,8 +13,7 @@ LABEL maintainer="aptalca"
 ENV NVIDIA_DRIVER_CAPABILITIES="compute,video,utility"
 
 # global environment settings
-ENV DEBIAN_FRONTEND="noninteractive" \
-  MAJOR_VERSION=7.6
+ENV DEBIAN_FRONTEND="noninteractive"
 
 RUN \
   echo "**** install runtime packages ****" && \
@@ -23,11 +22,11 @@ RUN \
     ocl-icd-libopencl1 && \
   ln -s libOpenCL.so.1 /usr/lib/aarch64-linux-gnu/libOpenCL.so && \
   echo "**** install foldingathome ****" && \
-  download_url=$(curl -H 'Accept-Encoding: gzip' -fSsL --compressed https://download.foldingathome.org/releases.py?series=${MAJOR_VERSION} | jq -r '.[] | select(.title=="64bit Linux") | .groups[].files[].url' | grep "fahclient" | grep "deb" | grep "arm64") && \
+  download_url=$(curl -H 'Accept-Encoding: gzip' -fSsL --compressed https://download.foldingathome.org/releases.py | jq -r '.[] | select(.title=="64bit Linux") | .groups[].files[].url' | grep "fah-client" | grep "arm64.deb") && \
   curl -o \
     /tmp/fah.deb -L \
     ${download_url} && \
-  dpkg -x /tmp/fah.deb /app && \
+  dpkg -x /tmp/fah.deb / && \
   printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \
   echo "**** cleanup ****" && \
   apt-get clean && \

Jenkinsfile

@@ -31,8 +31,8 @@ pipeline {
     CI_PORT='7396'
     CI_SSL='false'
     CI_DELAY='120'
-    CI_DOCKERENV='TZ=US/Pacific'
-    CI_AUTH='user:password'
+    CI_DOCKERENV=''
+    CI_AUTH=''
     CI_WEBPATH=''
   }
   stages {
@@ -115,7 +115,7 @@ pipeline {
       steps{
         script{
           env.EXT_RELEASE = sh(
-            script: ''' curl -H 'Accept-Encoding: gzip' -fSsL --compressed https://download.foldingathome.org/releases.py?series=7.6 | jq -r '.[] | select(.title=="64bit Linux") | .groups[0].files[0].filename' | awk -F'(fahclient_|_amd64.deb)' '{print $2}' ''',
+            script: ''' curl -H 'Accept-Encoding: gzip' -fSsL --compressed https://download.foldingathome.org/releases.py | jq -r '.[] | select(.title=="64bit Linux") | .groups[0].files[0].filename' | awk -F'(fah-client_|_amd64.deb)' '{print $2}' ''',
             returnStdout: true).trim()
             env.RELEASE_LINK = 'custom_command'
         }

README.md

@@ -59,13 +59,19 @@ The architectures supported by this image are:
 
 ## Application Setup
 
-This image sets up the Folding@home client. The interface is available at `http://your-ip:7396`.
+This image sets up the Folding@home client. The interface is available at [https://app.foldingathome.org](https://app.foldingathome.org).
 
-The built-in webserver provides very basic control (ie. GPUs are only active when set to `Medium` or higher). For more fine grained control of individual devices, you can use the FAHControl app on a different device and connect remotely via port `36330` (no password).
+Before setting up this container, please register for an account on [https://app.foldingathome.org](https://app.foldingathome.org) and retrieve the account token shown in the account settings. That value should be populated in the `ACCOUNT_TOKEN` env var.
 
-There are a couple of minor issues with the webgui:
-- If you get an "ERR_EMPTY_RESPONSE" error when trying to access via IP, it's most likely due to a clash of cookies/cache. Try opening in an incgnito window.
-- If you're getting a constant refresh of the window but no display of info, try a force refresh via `shft-F5` or `ctrl-F5`.
+Once the container is created with the token and the machine name, the instance should be listed in the web app and can be controlled there.
+
+Afterwards, the `ACCOUNT_TOKEN` and the `MACHINE_NAME` vars can be removed as the instance will already be associated with the online account and the info stored in the config folder.
+
+## Migration from version 7.6
+
+Version 8 of fah-client has been rewritten and has some breaking changes that we can't automatically mitigate in this container.
+
+Unlike v7, v8 no longer bundles a local webgui. The web app is loaded from an online source and can only auto-detect instances that are running on the same machine (bare metal) as the browser. This is not possible in a docker container. Therefore, upgrading to v8 requires registering for an online account, retrieving the account token and setting it in the new env var `ACCOUNT_TOKEN`, along with a friendly name in `MACHINE_NAME`.
 
 ## GPU Hardware Acceleration
 
@@ -91,12 +97,13 @@ services:
       - PUID=1000
       - PGID=1000
       - TZ=Etc/UTC
+      - ACCOUNT_TOKEN=
+      - MACHINE_NAME=
       - CLI_ARGS= #optional
     volumes:
-      - /path/to/data:/config
+      - /path/to/foldingathome/data:/config
     ports:
-      - 7396:7396
-      - 36330:36330 #optional
+      - 7396:7396 #optional
     restart: unless-stopped
 ```
 
@@ -108,10 +115,11 @@ docker run -d \
   -e PUID=1000 \
   -e PGID=1000 \
   -e TZ=Etc/UTC \
+  -e ACCOUNT_TOKEN= \
+  -e MACHINE_NAME= \
   -e CLI_ARGS= `#optional` \
-  -p 7396:7396 \
-  -p 36330:36330 `#optional` \
-  -v /path/to/data:/config \
+  -p 7396:7396 `#optional` \
+  -v /path/to/foldingathome/data:/config \
   --restart unless-stopped \
   lscr.io/linuxserver/foldingathome:latest
 ```
@@ -122,12 +130,13 @@ Containers are configured using parameters passed at runtime (such as those abov
 
 | Parameter | Function |
 | :----: | --- |
-| `-p 7396` | Folding@home web gui. |
-| `-p 36330` | Optional port for connecting remotely via FAHControl app (no password). |
+| `-p 7396` | Folding@home web gui (redirects to [https://app.foldingathome.org](https://app.foldingathome.org)). |
 | `-e PUID=1000` | for UserID - see below for explanation |
 | `-e PGID=1000` | for GroupID - see below for explanation |
 | `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
-| `-e CLI_ARGS=` | Optionally pass additional cli arguments to `FAHClient` on container start. |
+| `-e ACCOUNT_TOKEN=` | Register for an account on `https://app.foldingathome.org` and retrieve account token in settings. Required on first start. |
+| `-e MACHINE_NAME=` | Assign a friendly name to this instance (no spaces). Required on first start. |
+| `-e CLI_ARGS=` | Optionally pass additional cli arguments to `fah-client` on container start. |
 | `-v /config` | Where Folding@home should store its database and config. |
 
 ## Environment variables from files (Docker secrets)
@@ -291,6 +300,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
 
 ## Versions
 
+* **25.06.24:** - ***Breaking Changes*** - Please see the Application Setup section for more details. Restructure image for F@H v8.
 * **15.06.24:** - Rebase to Ubuntu Noble, add optional cli args.
 * **14.12.22:** - Rebase to Ubuntu Jammy, migrate to s6v3.
 * **15.01.22:** - Rebase to Ubuntu Focal. Add arm64v8 builds (cpu only). Increase verbosity about gpu driver permission settings.

jenkins-vars.yml

@@ -3,7 +3,7 @@
 # jenkins variables
 project_name: docker-foldingathome
 external_type: na
-custom_version_command: "curl -H 'Accept-Encoding: gzip' -fSsL --compressed https://download.foldingathome.org/releases.py?series=7.6 | jq -r '.[] | select(.title==\"64bit Linux\") | .groups[0].files[0].filename' | awk -F'(fahclient_|_amd64.deb)' '{print $2}'"
+custom_version_command: "curl -H 'Accept-Encoding: gzip' -fSsL --compressed https://download.foldingathome.org/releases.py | jq -r '.[] | select(.title==\"64bit Linux\") | .groups[0].files[0].filename' | awk -F'(fah-client_|_amd64.deb)' '{print $2}'"
 release_type: stable
 release_tag: latest
 ls_branch: master
@@ -23,8 +23,8 @@ repo_vars:
   - CI_PORT='7396'
   - CI_SSL='false'
   - CI_DELAY='120'
-  - CI_DOCKERENV='TZ=US/Pacific'
-  - CI_AUTH='user:password'
+  - CI_DOCKERENV=''
+  - CI_AUTH=''
   - CI_WEBPATH=''
 sponsor_links:
   - { name: "Folding@home", url: "https://foldingathome.org/about/donate/" }

readme-vars.yml

@@ -19,40 +19,41 @@ development_versions: false
 # container parameters
 common_param_env_vars_enabled: true
 param_container_name: "{{ project_name }}"
-param_usage_include_net: false
 param_usage_include_env: true
+param_env_vars:
+  - { env_var: "ACCOUNT_TOKEN", env_value: "", desc: "Register for an account on `https://app.foldingathome.org` and retrieve account token in settings. Required on first start." }
+  - { env_var: "MACHINE_NAME", env_value: "", desc: "Assign a friendly name to this instance (no spaces). Required on first start." }
 param_usage_include_vols: true
 param_volumes:
-  - { vol_path: "/config", vol_host_path: "/path/to/data", desc: "Where Folding@home should store its database and config." }
-param_usage_include_ports: true
-param_ports:
-  - { external_port: "7396", internal_port: "7396", port_desc: "Folding@home web gui." }
-param_device_map: false
-cap_add_param: false
-cap_add_param_vars: ''
+  - { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Where Folding@home should store its database and config." }
 
 # optional container parameters
 opt_param_usage_include_env: true
 opt_param_env_vars:
-  - { env_var: "CLI_ARGS", env_value: "", desc: "Optionally pass additional cli arguments to `FAHClient` on container start." }
-opt_param_usage_include_vols: false
+  - { env_var: "CLI_ARGS", env_value: "", desc: "Optionally pass additional cli arguments to `fah-client` on container start." }
 opt_param_usage_include_ports: true
 opt_param_ports:
-  - { external_port: "36330", internal_port: "36330", port_desc: "Optional port for connecting remotely via FAHControl app (no password)." }
+  - { external_port: "7396", internal_port: "7396", port_desc: "Folding@home web gui (redirects to [https://app.foldingathome.org](https://app.foldingathome.org))." }
 opt_param_device_map: false
 opt_param_devices:
   - { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "Only needed if you want to use your Intel GPU (vaapi)." }
 
 # application setup block
 app_setup_block_enabled: true
 app_setup_block: |
-  This image sets up the Folding@home client. The interface is available at `http://your-ip:7396`.
-  
-  The built-in webserver provides very basic control (ie. GPUs are only active when set to `Medium` or higher). For more fine grained control of individual devices, you can use the FAHControl app on a different device and connect remotely via port `36330` (no password).
-  
-  There are a couple of minor issues with the webgui:
-  - If you get an "ERR_EMPTY_RESPONSE" error when trying to access via IP, it's most likely due to a clash of cookies/cache. Try opening in an incgnito window.
-  - If you're getting a constant refresh of the window but no display of info, try a force refresh via `shft-F5` or `ctrl-F5`.
+  This image sets up the Folding@home client. The interface is available at [https://app.foldingathome.org](https://app.foldingathome.org).
+
+  Before setting up this container, please register for an account on [https://app.foldingathome.org](https://app.foldingathome.org) and retrieve the account token shown in the account settings. That value should be populated in the `ACCOUNT_TOKEN` env var.
+
+  Once the container is created with the token and the machine name, the instance should be listed in the web app and can be controlled there.
+
+  Afterwards, the `ACCOUNT_TOKEN` and the `MACHINE_NAME` vars can be removed as the instance will already be associated with the online account and the info stored in the config folder.
+
+  ## Migration from version 7.6
+
+  Version 8 of fah-client has been rewritten and has some breaking changes that we can't automatically mitigate in this container.
+
+  Unlike v7, v8 no longer bundles a local webgui. The web app is loaded from an online source and can only auto-detect instances that are running on the same machine (bare metal) as the browser. This is not possible in a docker container. Therefore, upgrading to v8 requires registering for an online account, retrieving the account token and setting it in the new env var `ACCOUNT_TOKEN`, along with a friendly name in `MACHINE_NAME`.
 
   ## GPU Hardware Acceleration
   
@@ -64,6 +65,7 @@ app_setup_block: |
 
 # changelog
 changelogs:
+  - { date: "25.06.24:", desc: "***Breaking Changes*** - Please see the Application Setup section for more details. Restructure image for F@H v8." }
   - { date: "15.06.24:", desc: "Rebase to Ubuntu Noble, add optional cli args." }
   - { date: "14.12.22:", desc: "Rebase to Ubuntu Jammy, migrate to s6v3." }
   - { date: "15.01.22:", desc: "Rebase to Ubuntu Focal. Add arm64v8 builds (cpu only). Increase verbosity about gpu driver permission settings." }

root/etc/s6-overlay/s6-rc.d/init-foldingathome-config/run

@@ -6,5 +6,4 @@ mkdir -p /config
 
 # permissions on config root and folders
 lsiown -R abc:abc \
-    /app \
     /config

root/etc/s6-overlay/s6-rc.d/svc-foldingathome/run

@@ -1,8 +1,27 @@
 #!/usr/bin/with-contenv bash
 # shellcheck shell=bash
 
+if [[ -n "${ACCOUNT_TOKEN}" ]] && [[ -n "${MACHINE_NAME}" ]]; then
+    TOKEN_AND_NAME="--account-token ${ACCOUNT_TOKEN} --machine-name ${MACHINE_NAME}"
+else
+    echo '
+***************************************************************************
+***************************************************************************
+****                                                                   ****
+****                                                                   ****
+****    On first run, both the ACCOUNT_TOKEN and the MACHINE_NAME      ****
+**** env vars are required. Please set them and recreate the container ****
+****    unless the instance was previously added to online account.    ****
+****                                                                   ****
+****                                                                   ****
+***************************************************************************
+***************************************************************************
+'
+fi
+
+
 exec \
     s6-notifyoncheck -d -n 300 -w 1000 -c "nc -z localhost 7396" \
-        cd /config s6-setuidgid abc /app/usr/bin/FAHClient \
-            --http-addresses 0.0.0.0:7396 --allow 0/0 --web-allow 0/0 --command-allow-no-pass 0/0 \
-            $CLI_ARGS
+        cd /config s6-setuidgid abc fah-client \
+            --http-addresses 0.0.0.0:7396 --allow 0/0 ${TOKEN_AND_NAME} \
+            ${CLI_ARGS}