├── last_release.txt ├── new_version.txt ├── tutorial ├── edit.jpeg ├── fans.jpeg ├── flash.jpeg ├── graph.jpeg ├── it8689.jpeg ├── rename.jpeg ├── webui.jpeg ├── adddevice.jpeg ├── cputemp.jpeg ├── fanspeed.jpeg ├── hddtemps.jpeg ├── locations.jpeg ├── schedule.jpeg ├── sensors.jpeg ├── syslinux.jpeg ├── template.jpeg ├── addprofile.jpeg ├── bootoptions.jpeg ├── cpuprofile.jpeg ├── mixfunction.jpeg ├── privileged.jpeg ├── systemtemp.jpeg ├── userscript.jpeg ├── advancedview.jpeg ├── introduction.jpeg ├── ledcontroller.jpeg ├── syslinuxedit.jpeg ├── addcustomsensor.jpeg ├── extraparameters.jpeg └── nvidia_power.sh ├── .gitignore ├── .github └── workflows │ ├── dockerhub-push.yml │ ├── ghcr-push.yml │ ├── check-upstream.yml │ └── build.yml ├── README.md ├── entrypoint.sh ├── Dockerfile ├── setup.md └── LICENSE /last_release.txt: -------------------------------------------------------------------------------- 1 | 2.2.2 2 | -------------------------------------------------------------------------------- /new_version.txt: -------------------------------------------------------------------------------- 1 | 3.0.1 2 | -------------------------------------------------------------------------------- /tutorial/edit.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/edit.jpeg -------------------------------------------------------------------------------- /tutorial/fans.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/fans.jpeg -------------------------------------------------------------------------------- /tutorial/flash.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/flash.jpeg -------------------------------------------------------------------------------- /tutorial/graph.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/graph.jpeg -------------------------------------------------------------------------------- /tutorial/it8689.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/it8689.jpeg -------------------------------------------------------------------------------- /tutorial/rename.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/rename.jpeg -------------------------------------------------------------------------------- /tutorial/webui.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/webui.jpeg -------------------------------------------------------------------------------- /tutorial/adddevice.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/adddevice.jpeg -------------------------------------------------------------------------------- /tutorial/cputemp.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/cputemp.jpeg -------------------------------------------------------------------------------- /tutorial/fanspeed.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/fanspeed.jpeg -------------------------------------------------------------------------------- /tutorial/hddtemps.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/hddtemps.jpeg -------------------------------------------------------------------------------- /tutorial/locations.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/locations.jpeg -------------------------------------------------------------------------------- /tutorial/schedule.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/schedule.jpeg -------------------------------------------------------------------------------- /tutorial/sensors.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/sensors.jpeg -------------------------------------------------------------------------------- /tutorial/syslinux.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/syslinux.jpeg -------------------------------------------------------------------------------- /tutorial/template.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/template.jpeg -------------------------------------------------------------------------------- /tutorial/addprofile.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/addprofile.jpeg -------------------------------------------------------------------------------- /tutorial/bootoptions.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/bootoptions.jpeg -------------------------------------------------------------------------------- /tutorial/cpuprofile.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/cpuprofile.jpeg -------------------------------------------------------------------------------- /tutorial/mixfunction.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/mixfunction.jpeg -------------------------------------------------------------------------------- /tutorial/privileged.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/privileged.jpeg -------------------------------------------------------------------------------- /tutorial/systemtemp.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/systemtemp.jpeg -------------------------------------------------------------------------------- /tutorial/userscript.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/userscript.jpeg -------------------------------------------------------------------------------- /tutorial/advancedview.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/advancedview.jpeg -------------------------------------------------------------------------------- /tutorial/introduction.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/introduction.jpeg -------------------------------------------------------------------------------- /tutorial/ledcontroller.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/ledcontroller.jpeg -------------------------------------------------------------------------------- /tutorial/syslinuxedit.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/syslinuxedit.jpeg -------------------------------------------------------------------------------- /tutorial/addcustomsensor.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/addcustomsensor.jpeg -------------------------------------------------------------------------------- /tutorial/extraparameters.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guniv/CoolerControl-Docker/HEAD/tutorial/extraparameters.jpeg -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # General 2 | *.log 3 | *.tmp 4 | .env 5 | dist/ 6 | build/ 7 | 8 | # Docker 9 | .dockerignore 10 | docker-data/ 11 | 12 | # Editors 13 | .vscode/ 14 | .idea/ 15 | 16 | # OS-generated 17 | .DS_Store 18 | Thumbs.db 19 | -------------------------------------------------------------------------------- /.github/workflows/dockerhub-push.yml: -------------------------------------------------------------------------------- 1 | name: Manual Push to Docker Hub 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | version: 7 | description: 'Version tag (e.g., "v1.2.3")' 8 | required: true 9 | build-number: 10 | description: 'Build number (e.g., "1")' 11 | required: true 12 | default: '1' 13 | 14 | permissions: 15 | contents: read 16 | 17 | env: 18 | REGISTRY: docker.io 19 | IMAGE_NAME: gunivx/coolercontrol-docker 20 | 21 | jobs: 22 | push-dockerhub: 23 | runs-on: ubuntu-latest 24 | steps: 25 | - name: Checkout repository 26 | uses: actions/checkout@v4 27 | 28 | - name: Log in to Docker Hub 29 | uses: docker/login-action@v3 30 | with: 31 | username: ${{ secrets.DOCKERHUB_USERNAME }} 32 | password: ${{ secrets.DOCKERHUB_TOKEN }} 33 | 34 | - name: Set up Docker Buildx 35 | uses: docker/setup-buildx-action@v3 36 | 37 | - name: Build and Push to Docker Hub 38 | uses: docker/build-push-action@v5 39 | with: 40 | context: . 41 | push: true 42 | tags: | 43 | ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest 44 | ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ inputs.version }} 45 | ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ inputs.version }}-docker${{ inputs.build-number }} 46 | -------------------------------------------------------------------------------- /.github/workflows/ghcr-push.yml: -------------------------------------------------------------------------------- 1 | name: Manual Push to GHCR 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | version: 7 | description: 'Version tag (e.g., "v1.2.3")' 8 | required: true 9 | build-number: 10 | description: 'Build number (e.g., "1")' 11 | required: true 12 | default: '1' 13 | 14 | permissions: 15 | contents: read # For checking out code 16 | packages: write # For pushing to GHCR 17 | id-token: write # For GitHub OIDC authentication 18 | 19 | env: 20 | REGISTRY: ghcr.io 21 | IMAGE_NAME: guniv/coolercontrol-docker 22 | 23 | jobs: 24 | push-ghcr: 25 | runs-on: ubuntu-latest 26 | steps: 27 | - name: Checkout repository 28 | uses: actions/checkout@v4 29 | 30 | - name: Log in to GHCR 31 | uses: docker/login-action@v3 32 | with: 33 | registry: ${{ env.REGISTRY }} 34 | username: ${{ github.actor }} 35 | password: ${{ secrets.GITHUB_TOKEN }} 36 | 37 | - name: Set up Docker Buildx 38 | uses: docker/setup-buildx-action@v3 39 | 40 | - name: Build and Push to GHCR 41 | uses: docker/build-push-action@v5 42 | with: 43 | context: . 44 | push: true 45 | tags: | 46 | ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest 47 | ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ inputs.version }} 48 | ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ inputs.version }}-docker${{ inputs.build-number }} 49 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 |
3 | 4 | 5 | 6 |
7 |
8 | 9 | # CoolerControl-Docker 10 | 11 | > [!WARNING] 12 | > **🚨 DEPRECATION NOTICE - MIGRATION REQUIRED BY NOVEMBER 1st, 2025 🚨** 13 | > 14 | > This unofficial Docker container is being **SUNSET** due to the release of an official CoolerControl Docker image. 15 | > 16 | > **Please migrate to the official image:** `coolercontrol/coolercontrold:latest` 17 | > 18 | > ⚠️ **Continued maintenance of this container is NOT GUARANTEED past the migration deadline.** 19 | > 20 | > The documentation has also been migrated to the official CoolerControl documentation website: https://docs.coolercontrol.org/installation/unraid.html 21 | 22 | This is my insanely basic attempt at putting [CoolerControl](https://gitlab.com/coolercontrol/coolercontrol) in a Docker container. Let me preface with: I don't really know what I'm doing! I barely pulled this together. 23 | 24 | Why did I do this? I wanted a good way to manage the fans on my Unraid server, and CoolerControl is currently the best way to manage fans on Linux systems. 25 | 26 | The container is Debian slim running the CoolerControl AppImage. 27 | 28 | ### Configuration 29 | 30 | Visit the [setup guide](https://github.com/guniv/CoolerControl-Docker/blob/main/setup.md) for information on setting this up on Unraid. 31 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # ============================================================================ 4 | # DEPRECATION WARNING 5 | # ============================================================================ 6 | echo "╔══════════════════════════════════════════════════════════════════════════════╗" 7 | echo "║ ⚠️ DEPRECATION WARNING ⚠️ ║" 8 | echo "╠══════════════════════════════════════════════════════════════════════════════╣" 9 | echo "║ This unofficial Docker container is being SUNSET due to the release of an ║" 10 | echo "║ official CoolerControl Docker image. ║" 11 | echo "║ ║" 12 | echo "║ 🚨 MIGRATION REQUIRED BY: November 1st, 2025 ║" 13 | echo "║ ║" 14 | echo "║ Please update your Docker configuration to use the official image: ║" 15 | echo "║ 📦 coolercontrol/coolercontrold:latest ║" 16 | echo "║ ║" 17 | echo "║ ⚠️ Continued maintenance of this container is NOT GUARANTEED past the ║" 18 | echo "║ migration deadline. ║" 19 | echo "║ ║" 20 | echo "╚══════════════════════════════════════════════════════════════════════════════╝" 21 | echo "" 22 | echo "Container will start in 10 seconds..." 23 | sleep 10 24 | 25 | # Initialize essential directories first 26 | sudo mkdir -p "${XDG_RUNTIME_DIR}" 27 | sudo chown cooleruser:cooleruser "${XDG_RUNTIME_DIR}" 28 | sudo chmod 0700 "${XDG_RUNTIME_DIR}" 29 | 30 | # Initialize DBUS 31 | sudo mkdir -p /var/run/dbus 32 | sudo dbus-daemon --system --fork 33 | 34 | # Create essential runtime directories 35 | mkdir -p "${XDG_RUNTIME_DIR}" 36 | sudo chown cooleruser:cooleruser "${XDG_RUNTIME_DIR}" 37 | chmod 0700 "${XDG_RUNTIME_DIR}" 38 | 39 | # Initialize configuration 40 | if [ ! -f /etc/coolercontrol/config.toml ]; then 41 | echo "Initializing configuration..." 42 | CC_VERSION=$(cat /opt/coolercontrol/version) 43 | curl -s -o /tmp/default-config.toml \ 44 | "https://gitlab.com/coolercontrol/coolercontrol/-/raw/${CC_VERSION}/coolercontrold/resources/config-default.toml" 45 | sed -i '/^ipv4_address = .*/d' /tmp/default-config.toml 46 | sed -i '/^\[settings\]/a ipv4_address = "0.0.0.0"' /tmp/default-config.toml 47 | sudo mv /tmp/default-config.toml /etc/coolercontrol/config.toml 48 | sudo chmod 644 /etc/coolercontrol/config.toml 49 | fi 50 | 51 | # Start with direct hardware access 52 | exec sudo -E ./CoolerControlD-x86_64.AppImage --appimage-extract-and-run 53 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # Stage 1: Builder 2 | FROM debian:stable-slim AS builder 3 | 4 | # Set non-interactive frontend for debian packages 5 | ENV DEBIAN_FRONTEND=noninteractive 6 | 7 | RUN apt-get update && \ 8 | apt-get install -y --no-install-recommends \ 9 | curl \ 10 | jq \ 11 | ca-certificates \ 12 | && rm -rf /var/lib/apt/lists/* 13 | 14 | RUN mkdir -p /opt/coolercontrol && \ 15 | CC_VERSION=$(curl -s "https://gitlab.com/api/v4/projects/coolercontrol%2Fcoolercontrol/releases" | jq -r '.[0].tag_name') && \ 16 | echo "${CC_VERSION}" > /opt/coolercontrol/version 17 | 18 | RUN CC_VERSION=$(cat /opt/coolercontrol/version) && \ 19 | curl -s -L "https://gitlab.com/coolercontrol/coolercontrol/-/releases/${CC_VERSION}/downloads/packages/CoolerControlD-x86_64.AppImage" \ 20 | -o /CoolerControlD-x86_64.AppImage && \ 21 | chmod +x /CoolerControlD-x86_64.AppImage 22 | 23 | # Stage 2: Runtime 24 | FROM debian:stable-slim 25 | 26 | # Create required system groups first 27 | RUN groupadd --system -f sensors && \ 28 | groupadd --system -f i2c && \ 29 | groupadd --system -f plugdev && \ 30 | groupadd --system -f dialout && \ 31 | groupadd --system -f audio && \ 32 | groupadd --system -f video 33 | 34 | # Add this after group creation but before user setup 35 | ENV XDG_RUNTIME_DIR=/tmp/runtime-cooleruser 36 | 37 | # Install packages with proper cleanup 38 | ENV DEBIAN_FRONTEND=noninteractive 39 | RUN apt-get update && \ 40 | apt-get install -y --no-install-recommends \ 41 | libdrm-amdgpu1 \ 42 | libglib2.0-0 \ 43 | libusb-1.0-0 \ 44 | libfuse2 \ 45 | sudo \ 46 | dbus \ 47 | curl \ 48 | ca-certificates \ 49 | && apt-get clean \ 50 | && rm -rf /var/lib/apt/lists/* 51 | 52 | # Configure user and permissions 53 | RUN useradd -m cooleruser && \ 54 | usermod -a -G plugdev,i2c,sensors,dialout,audio,video cooleruser && \ 55 | echo "cooleruser ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers 56 | 57 | # Set non-interactive frontend and install packages 58 | ENV DEBIAN_FRONTEND=noninteractive 59 | RUN apt-get update && \ 60 | apt-get install -y --no-install-recommends \ 61 | libdrm-amdgpu1 \ 62 | libglib2.0-0 \ 63 | libusb-1.0-0 \ 64 | libfuse2 \ 65 | sudo \ 66 | dbus \ 67 | curl \ 68 | && rm -rf /var/lib/apt/lists/* 69 | 70 | # Create essential directories 71 | RUN mkdir -p \ 72 | /etc/coolercontrol \ 73 | /run/dbus \ 74 | /var/run/dbus && \ 75 | chown cooleruser:cooleruser /etc/coolercontrol 76 | 77 | COPY --from=builder /CoolerControlD-x86_64.AppImage / 78 | COPY --from=builder /opt/coolercontrol/version /opt/coolercontrol/version 79 | 80 | COPY entrypoint.sh / 81 | RUN chmod +x /entrypoint.sh && chown cooleruser:cooleruser /entrypoint.sh 82 | 83 | USER cooleruser 84 | WORKDIR / 85 | EXPOSE 11987 86 | 87 | ENTRYPOINT ["/entrypoint.sh"] 88 | -------------------------------------------------------------------------------- /.github/workflows/check-upstream.yml: -------------------------------------------------------------------------------- 1 | name: Check Upstream Version 2 | 3 | permissions: 4 | contents: write # Required for pushing changes 5 | pull-requests: write 6 | issues: write 7 | 8 | on: 9 | schedule: 10 | - cron: '30 15 * * *' # Daily check 11 | workflow_dispatch: # Allow manual triggering 12 | 13 | jobs: 14 | check-upstream: 15 | runs-on: ubuntu-latest 16 | steps: 17 | - name: Checkout 18 | uses: actions/checkout@v4 19 | with: 20 | token: ${{ secrets.GITHUB_TOKEN }} 21 | fetch-depth: 0 22 | 23 | - name: Get Latest Upstream Tag 24 | id: get-tag 25 | env: 26 | PROJECT_ID: 30707566 27 | run: | 28 | LATEST_TAG=$(curl -s "https://gitlab.com/api/v4/projects/$PROJECT_ID/repository/tags" | jq -r '.[0].name') 29 | echo "UPSTREAM_TAG=$LATEST_TAG" >> $GITHUB_OUTPUT 30 | 31 | - name: Verify AppImage Availability 32 | id: verify-appimage 33 | env: 34 | GL_PAT: ${{ secrets.GL_PAT }} # Add authentication 35 | run: | 36 | CC_VERSION=${{ steps.get-tag.outputs.UPSTREAM_TAG}} 37 | URL="https://gitlab.com/coolercontrol/coolercontrol/-/releases/${CC_VERSION}/downloads/packages/CoolerControlD-x86_64.AppImage" 38 | 39 | # Add required headers and follow redirects 40 | STATUS_CODE=$(curl -sL \ 41 | -H "PRIVATE-TOKEN: $GL_PAT" \ 42 | -H "User-Agent: GitHub-Actions" \ 43 | -o /dev/null \ 44 | -w "%{http_code}" \ 45 | "$URL") 46 | 47 | echo "Debug - URL: $URL" # Verify URL construction 48 | echo "Debug - Status: $STATUS_CODE" # See actual response 49 | 50 | if [ "$STATUS_CODE" -eq 200 ]; then 51 | echo "APPIMAGE_AVAILABLE=true" >> $GITHUB_OUTPUT 52 | else 53 | echo "APPIMAGE_AVAILABLE=false" >> $GITHUB_OUTPUT 54 | exit 1 55 | fi 56 | - name: Create Version Check File 57 | if: steps.verify-appimage.outputs.APPIMAGE_AVAILABLE == 'true' 58 | env: 59 | GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} 60 | run: | 61 | git config --global user.name "GitHub Actions" 62 | git config --global user.email "actions@github.com" 63 | git remote set-url origin "https://x-access-token:$GH_TOKEN@github.com/${{ github.repository }}.git" 64 | 65 | # Check if version changed 66 | NEW_TAG="${{ steps.get-tag.outputs.UPSTREAM_TAG }}" 67 | CURRENT_TAG=$(cat new_version.txt 2>/dev/null || echo "") 68 | if [ "$NEW_TAG" != "$CURRENT_TAG" ]; then 69 | echo "$NEW_TAG" > new_version.txt 70 | git add new_version.txt 71 | git commit -m "New upstream version detected: $NEW_TAG" 72 | git pull --rebase origin main 73 | git push origin main 74 | else 75 | echo "No version change detected. Skipping commit." 76 | fi 77 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build and Release Docker Image 2 | 3 | on: 4 | workflow_run: 5 | workflows: ["Check Upstream Version"] 6 | types: 7 | - completed 8 | push: 9 | branches: 10 | - main 11 | paths: 12 | - 'Dockerfile' 13 | - 'entrypoint.sh' 14 | - 'last_release.txt' 15 | workflow_dispatch: 16 | 17 | permissions: 18 | contents: write 19 | packages: write 20 | id-token: write 21 | 22 | env: 23 | GHCR_IMAGE_NAME: guniv/coolercontrol-docker 24 | DOCKERHUB_IMAGE_NAME: gunivx/coolercontrol-docker 25 | REGISTRY: ghcr.io 26 | DOCKERHUB_REGISTRY: docker.io 27 | PROJECT_ID: 30707566 28 | 29 | jobs: 30 | build-and-release: 31 | runs-on: ubuntu-latest 32 | steps: 33 | - name: Checkout repository 34 | uses: actions/checkout@v4 35 | with: 36 | fetch-depth: 0 37 | token: ${{ secrets.GITHUB_TOKEN }} 38 | 39 | - name: Determine Version and Build Number 40 | id: version 41 | env: 42 | GH_TOKEN: ${{ github.token }} 43 | run: | 44 | # Configure git 45 | git config --global user.name "GitHub Actions" 46 | git config --global user.email "actions@github.com" 47 | 48 | if [[ -f new_version.txt ]]; then 49 | UPSTREAM_TAG=$(cat new_version.txt) 50 | LAST_RELEASE=$(cat last_release.txt 2>/dev/null || echo "") 51 | 52 | # Validate if the version is actually new 53 | if [[ "$UPSTREAM_TAG" != "$LAST_RELEASE" ]]; then 54 | IS_NEW_UPSTREAM=true 55 | echo "Detected new version: $UPSTREAM_TAG" 56 | else 57 | IS_NEW_UPSTREAM=false 58 | echo "No new version. Removing trigger file..." 59 | rm -f new_version.txt 60 | fi 61 | 62 | # Remove trigger file if it still exists and commit the change 63 | if [ -f new_version.txt ]; then 64 | git rm new_version.txt 65 | git commit -m "Remove version trigger file" || echo "No changes to commit" 66 | git push origin main || echo "Push failed or no changes" 67 | fi 68 | else 69 | UPSTREAM_TAG=$(cat last_release.txt || echo "v0.0.0") 70 | IS_NEW_UPSTREAM=false 71 | fi 72 | 73 | # Define a build number. Adjust logic as needed. 74 | DOCKER_BUILD=1 75 | 76 | # Set outputs so they can be used by later steps 77 | echo "UPSTREAM_VERSION=${UPSTREAM_TAG}" >> $GITHUB_OUTPUT 78 | echo "DOCKER_BUILD=${DOCKER_BUILD}" >> $GITHUB_OUTPUT 79 | echo "IS_NEW_UPSTREAM=${IS_NEW_UPSTREAM}" >> $GITHUB_OUTPUT 80 | 81 | - name: Log in to GHCR 82 | uses: docker/login-action@v3 83 | with: 84 | registry: ${{ env.REGISTRY }} 85 | username: ${{ github.actor }} 86 | password: ${{ secrets.GITHUB_TOKEN }} 87 | 88 | - name: Log in to Docker Hub 89 | uses: docker/login-action@v3 90 | with: 91 | username: ${{ secrets.DOCKERHUB_USERNAME }} 92 | password: ${{ secrets.DOCKERHUB_TOKEN }} 93 | 94 | - name: Set up Docker Buildx 95 | uses: docker/setup-buildx-action@v3 96 | with: 97 | driver: docker-container 98 | 99 | - name: Build and Push Docker Image 100 | if: steps.version.outputs.IS_NEW_UPSTREAM == 'true' 101 | uses: docker/build-push-action@v5 102 | with: 103 | context: . 104 | push: true 105 | tags: | 106 | ${{ env.REGISTRY }}/${{ env.GHCR_IMAGE_NAME }}:latest 107 | ${{ env.REGISTRY }}/${{ env.GHCR_IMAGE_NAME }}:${{ steps.version.outputs.UPSTREAM_VERSION }} 108 | ${{ env.REGISTRY }}/${{ env.GHCR_IMAGE_NAME }}:${{ steps.version.outputs.UPSTREAM_VERSION }}-docker${{ steps.version.outputs.DOCKER_BUILD }} 109 | ${{ env.DOCKERHUB_REGISTRY }}/${{ env.DOCKERHUB_IMAGE_NAME }}:latest 110 | ${{ env.DOCKERHUB_REGISTRY }}/${{ env.DOCKERHUB_IMAGE_NAME }}:${{ steps.version.outputs.UPSTREAM_VERSION }} 111 | ${{ env.DOCKERHUB_REGISTRY }}/${{ env.DOCKERHUB_IMAGE_NAME }}:${{ steps.version.outputs.UPSTREAM_VERSION }}-docker${{ steps.version.outputs.DOCKER_BUILD }} 112 | 113 | - name: Update Version Tracker 114 | if: steps.version.outputs.IS_NEW_UPSTREAM == 'true' 115 | run: | 116 | git config --global user.name "GitHub Actions" 117 | git config --global user.email "actions@github.com" 118 | 119 | # Reset any changes except last_release.txt 120 | git reset --hard HEAD 121 | git clean -fd 122 | 123 | echo "${{ steps.version.outputs.UPSTREAM_VERSION }}" > last_release.txt 124 | git add last_release.txt 125 | git commit -m "Track upstream version ${{ steps.version.outputs.UPSTREAM_VERSION }}" 126 | git push origin main 127 | -------------------------------------------------------------------------------- /tutorial/nvidia_power.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 3 | # # Script for saving power on Unraid server with Nvidia GPUs when they are not passed to a VM # # 4 | # # (needs Unraid nvidia driver if you want to enable the show power savings bc will need to be installed from nerd tools plugin) # # # # 5 | # # by - SpaceInvaderOne # # 6 | # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 7 | # 8 | #################### 9 | # Set these variable for a rough estimate of how much saving you would have in a year from the power saved 10 | #################### 11 | show_saving="yes" # Set to "yes" to show savings 12 | hours_server_running="24" # set this for how many hours server running for 13 | electricity_cost_KWH=".28" # set this for you cost of electric in cost per unit per kwh 14 | Currency="£" # set your currency symbol 15 | 16 | #################### 17 | # Do not change below this line # 18 | # arrays to store initial and final power usages 19 | declare -A initial_power_usage final_power_usage 20 | 21 | # calculate and display potential savings 22 | calculate_savings() { 23 | local initial_power=$1 24 | local final_power=$2 25 | local hours_per_day=$3 26 | local cost_per_kwh=$4 27 | local currency=$5 28 | 29 | local power_saved=$(echo "$initial_power - $final_power" | bc -l) 30 | 31 | if [ $(echo "$power_saved > 0" | bc -l) -eq 1 ]; then 32 | local daily_saving=$(echo "$power_saved * $hours_per_day / 1000 * $cost_per_kwh" | bc -l) 33 | local yearly_saving=$(echo "$daily_saving * 365" | bc -l) 34 | 35 | # Redirecting textual output to stderr 36 | >&2 echo "Power saved from before for GPU $gpu_id is ${power_saved} watts." 37 | >&2 echo "This could save you up to ${currency}$(printf "%.2f" $yearly_saving) per year." 38 | 39 | # Only echoing the numeric value for capturing 40 | echo "$yearly_saving" 41 | else 42 | # If no savings, output 0 and redirect message to stderr 43 | >&2 echo "No significant power savings for GPU $gpu_id." 44 | echo "0" 45 | fi 46 | } 47 | # variable to hold the total savings 48 | total_yearly_savings=0 49 | 50 | # check if a Graphics Card is being used by any docker container 51 | is_gpu_in_use_by_docker() { 52 | local gpu_id=$1 53 | # List processes using the Graphics Card 54 | local gpu_processes=$(nvidia-smi -i ${gpu_id} --query-compute-apps=pid --format=csv,noheader) 55 | for pid in $gpu_processes; do 56 | # Check if this process belongs to a Docker container 57 | if grep -q "docker" /proc/${pid}/cgroup 2> /dev/null; then 58 | return 0 # Graphics Card is in use by a Docker container 59 | fi 60 | done 61 | return 1 # Graphics Card is not in use by any docker container 62 | } 63 | 64 | terminate_non_docker_gpu_processes() { 65 | echo "Checking for process termination eligibility…" 66 | 67 | if all_gpus_free; then 68 | echo "No Docker containers are using the GPUs. Terminating non-Docker processes using NVIDIA devices…" 69 | mapfile -t pids < <(fuser /dev/nvidia* 2>&1 | awk '{for(i=2;i<=NF;i++) print $i}') 70 | for pid in "${pids[@]}"; do 71 | cmd=$(ps -p "$pid" -o comm=) 72 | if [[ "$cmd" == "coolercontrold" ]]; then 73 | echo "Skipping coolercontrold (PID $pid)" 74 | continue 75 | fi 76 | echo "Killing $cmd (PID $pid)" 77 | kill -9 "$pid" 78 | done 79 | else 80 | echo "At least one GPU is being used by a Docker container. Will not terminate GPU-related processes." 81 | exit 1 82 | fi 83 | } 84 | 85 | # check if any GPU is being used by Docker 86 | all_gpus_free() { 87 | local gpu_count=$(nvidia-smi --list-gpus | wc -l) 88 | for (( gpu_id=0; gpu_id /dev/null || { echo >&2 "NVIDIA driver is not installed. Exiting."; exit 1; } 137 | 138 | # list NVIDIA GPUs and get initial power usage and state 139 | echo "NVIDIA drivers are installed." 140 | echo 141 | echo "Listing NVIDIA Graphics Cards in your server..." 142 | nvidia-smi --list-gpus 143 | echo 144 | 145 | echo "Initial Power Usage and State" 146 | echo "--------------------------------------------" 147 | gpu_count=$(nvidia-smi --list-gpus | wc -l) 148 | for (( gpu_id=0; gpu_id /dev/null; then 186 | echo "Show savings will only work with bc installed. Please install this using the NerdTools plugin from CA." 187 | exit 1 188 | fi 189 | 190 | total_yearly_savings=0 191 | 192 | for (( gpu_id=0; gpu_id 0" | bc)" -eq 1 ]; then 201 | echo "Potential max savings over year for all GPUs combined: ${Currency}$(printf "%.2f" "$total_yearly_savings") per year" 202 | else 203 | echo "Overall, no significant power savings across all Graphics Cards." 204 | fi 205 | fi 206 | -------------------------------------------------------------------------------- /setup.md: -------------------------------------------------------------------------------- 1 | # Setting up CoolerControl in Unraid 2 | 3 | > [!WARNING] 4 | > **🚨 DEPRECATION NOTICE - MIGRATION REQUIRED BY NOVEMBER 1st, 2025 🚨** 5 | > 6 | > This unofficial Docker container is being **SUNSET** due to the release of an official CoolerControl Docker image. 7 | > 8 | > **Please migrate to the official image:** `coolercontrol/coolercontrold:latest` 9 | > 10 | > ⚠️ **Continued maintenance of this container is NOT GUARANTEED past the migration deadline.** 11 | > 12 | > The below documentation has also been migrated to the official CoolerControl documentation website: https://docs.coolercontrol.org/installation/unraid.html 13 | 14 | Setting up CoolerControl in Unraid is fairly straightforward but does require a little manual work to make sure it's working correctly. This tutorial will walk through setting it up. 15 | 16 | ## Table of Contents 17 | 18 | - [Prerequisites](#prerequisites) 19 | - [Enabling hard drive temperature reporting](#enabling-hard-drive-temperature-reporting) 20 | - [Confirm fans are visible to Unraid](#confirm-fans-are-visible-to-unraid) 21 | - [Last resort: editing a kernel boot parameter](#last-resort-editing-a-kernel-boot-parameter) 22 | - [Nvidia GPU support](#nvidia-gpu-support) 23 | - [Initial CoolerControl setup](#initial-coolercontrol-setup) 24 | - [Adding Nvidia GPUs](#adding-nvidia-gpus) 25 | - [Privileged mode](#privileged-mode) 26 | - [Checking devices in CoolerControl](#checking-devices-in-coolercontrol) 27 | - [Checking devices for hwmon](#checking-devices-for-hwmon) 28 | - [Example: adding an LED controller](#example-adding-an-led-controller) 29 | - [Example: adding fan controls](#example-adding-fan-controls) 30 | - [Finalizing device setup](#finalizing-device-setup) 31 | - [Configuring CoolerControl](#configuring-coolercontrol) 32 | - [Identify and name devices](#identify-and-name-devices) 33 | - [Setting up a profile](#setting-up-a-profile) 34 | - [Combining sensors to create a custom sensor](#combining-sensors-to-create-a-custom-sensor) 35 | - [Troubleshooting](#troubleshooting) 36 | - [Could not connect to DBUS](#could-not-connect-to-dbus) 37 | - [Issues with nct6687 drivers](#issues-with-nct6687-drivers) 38 | - [Controlling Nvidia GPU fans](#controlling-nvidia-gpu-fans) 39 | - [Issues with Nvidia powersaving](#issues-with-nvidia-powersaving) 40 | - ["Unable to set PWM Value" and/or fan not staying on curve](#unable-to-set-pwm-value-andor-fan-not-staying-on-curve) 41 | - [Slow HWMon Device detected](#slow-hwmon-device-detected) 42 | - [Known issues](#known-issues) 43 | - [Hard drive spin down temperatures](#hard-drive-spin-down-temperatures) 44 | 45 | ## Prerequisites 46 | 47 | There is some setup required to get the full functionality of CoolerControl on Unraid. 48 | 49 | ### Enabling hard drive temperature reporting 50 | 51 | CoolerControl relies on the [Linux Hardware Monitoring kernel API](https://docs.kernel.org/hwmon/hwmon-kernel-api.html) (hwmon) to collect information like sensor temperatures from the system. By default, SATA devices like hard drives do not have their temperatures reported to hwmon. Enabling this in Unraid is simple: open the Unraid terminal and enter the command `sudo modprobe drivetemp`. 52 | 53 | > [!WARNING] 54 | > On some systems running drivetemp can prevent drives from spinning down and may cause other issues. If the system becomes unstable, try running CoolerControl without enabling drivetemp. 55 | > There is also an issue with drivetemp on Unraid versions lower than 7.0.1 due to a bug in the Linux kernel. 56 | 57 | This command has to be run every time the system is rebooted. To do this, use the User Scripts plugin from Andrew Zawadzki. In User Scripts, add a new script, and then edit the script to include that command: 58 | 59 |

60 | sudo modprobe drivetemp is entered into the user scripts edit field 65 |

66 | 67 | Save the script, and then edit the schedule for the script to run on first array start. 68 | 69 |

70 | the schedule for the script is set to At First Array Start Only 75 |

76 | 77 | ### Confirm fans are visible to Unraid 78 | 79 | To check if fans are already visible to Unraid, install the __Dynamix System Temp plugin from Bergware.__ In the settings for this plugin, it is possible to select which fan is shown on the Unraid dashboard footer. 80 | 81 |

82 | in the Dynamix System Temp settings, we see settings set for CPU temp, Mainboard temp, and Array fan speed 87 |

88 | 89 | If no fans are available under the _Array fan speed_ menu, it means the system fans are not currently visible to Unraid. 90 | 91 | A potential fix for this is drivers from Community Applications. The __ITE IT87 Driver from ich777__ has worked for others in making the fans available. The __Nuvoton NCT6687 Driver from ich777__ may also work. 92 | 93 | #### Last resort: editing a kernel boot parameter 94 | 95 | A more extreme measure that may make fans available to Unraid involves editing the kernel boot parameter `acpi_enforce_resources`. This option is normally set to `strict`, but editing it to `lax` may allow the system to access hardware that is also claimed by the system's Advanced Configuration and Power Interface. 96 | 97 | > [!CAUTION] 98 | > Making this change can cause system instability. Read and follow the instructions below carefully to ensure the system can be recovered if an issue arises, and always make sure to have system backups, including the boot USB drive. 99 | 100 | On the Unraid server, go to the _Main_ tab and click on _Flash_ under _Boot Device_ to access the boot USB's settings. 101 | 102 |

103 | in the Unraid dashboard, we see Flash under Boot Device 107 |

108 | 109 | Scroll down on the page to the _Syslinux Configuration_ section. On the top right of the section, select the toggle to change from _Menu View_ to _Raw View_. 110 | 111 | This section defines the set of options that appear when booting the Unraid system. The configuration below is just an example and may be different on each system. 112 | 113 |

114 | in the Unraid boot USB settings, a typical default configuration is seen 119 |

120 | 121 | Edit this configuration by copying the default `label Unraid OS` section and pasting it again underneath before the next label. Then, add `acpi_enforce_resources=lax` after `append initrd=/bzroot`. Remove `menu default` from the original `Unraid OS` and rename the new section to something like `Unraid OS lax`. This name will be how it appears when the system is booting. 122 | 123 |

124 | in the Unraid boot USB settings, the configuration has been edited 129 |

130 | 131 | Apply the changes and once again select the toggle to change from _Raw View_ to _Menu View_. 132 | 133 | Make sure the new option created appears and is selected and highlighted, which indicates it will be the default boot option. 134 | 135 | Next, reboot the system and ensure the new option is the default selection when booting the system. 136 | 137 |

138 | the system boot menu is shown with the new option added 143 |

144 | 145 | Make sure the system boots correctly. If it does not boot correctly, reboot the server and select the original _Unraid OS_ option. Make sure in the _Flash_ settings that this option is set back to default. This should also be done if the new setting does not successfully expose the fans to Unraid. 146 | 147 | ### Nvidia GPU support 148 | 149 | To add Nvidia GPUs to CoolerControl, the __Nvidia-Driver plugin__ from Community Applications needs to be installed and the plugin must be used to install a Nvidia driver on the system. 150 | 151 | If these are installed, Nvidia GPUs will be able to show up in CoolerControl. See the [Nvidia section below](#adding-nvidia-gpus) for information on how to set this up. 152 | 153 | If using the [Nvidia powersaving script by SpaceInvaderOne](https://github.com/SpaceinvaderOne/nvidia_powersave) it may interfere with this container. See the [Issues with Nvidia powersaving](#issues-with-nvidia-powersaving) section below for how to fix this. 154 | 155 | ## Initial CoolerControl setup 156 | 157 | Search for _CoolerControl_ in Community Applications and select _Install._ 158 | 159 | The Unraid template has three settings by default: the configuration storage, the WebUI port, and read-only access to hwmon on the Unraid system. 160 | 161 |

162 | in the Unraid template, the CoolerControl configuration, WebUI port, and hwmon are all set to their default values 167 |

168 | 169 | The CoolerControl configuration host path can be changed to store it somewhere else if needed, and the port can be changed if it conflicts with another container. 170 | 171 | ### Adding Nvidia GPUs 172 | 173 | > [!WARNING] 174 | > There is currently no way to control Nvidia GPU fans without leaving the container in privileged mode, and it is not recommended to leave the container in privileged mode. 175 | 176 | To add Nvidia GPUs to CoolerControl, change _Basic View_ to _Advanced view_ in the top right of the _Add Container_ or _Update Container_ page when configuring the container. 177 | 178 |

179 | showing where advanced view and basic view are 184 |

185 | 186 | Next, edit the _Extra Parameters_ section to add `--runtime=nvidia --gpus=all`. 187 | 188 |

189 | extra parameters is edited to include --runtime=nvidia --gpus=all 194 |

195 | 196 | If using the [Nvidia powersaving script by SpaceInvaderOne](https://github.com/SpaceinvaderOne/nvidia_powersave) it may interfere with this container. See the [Issues with Nvidia powersaving](#issues-with-nvidia-powersaving) section below for how to fix this. 197 | 198 | ### Privileged mode 199 | 200 | > [!WARNING] 201 | > It is not recommended to leave the container in privileged mode, and it should be disabled after setup of the container has been finished. 202 | 203 | While following this tutorial and while performing initial setup on the container, run it in privileged mode. This gives the container unrestricted access to the Unraid system, which will allow CoolerControl to discover any available devices on the system. 204 | 205 |

206 | extra parameters is edited to include --runtime=nvidia --gpus=all 211 |

212 | 213 | Hit apply to download and run the container. 214 | 215 | ## Checking devices in CoolerControl 216 | 217 | Now that CoolerControl is running, go to Unraid's Docker tab and click on the icon next to CoolerControl, and click on _WebUI_ to open CoolerControl itself. 218 | 219 |

220 | the webui button is shown after clicking on the container 224 |

225 | 226 | On first run, CoolerControl will walk through a basic introduction of how to use it. 227 | 228 |

229 | the coolercontol introduction 234 |

235 | 236 | After this introduction, check the devices that are available in CoolerControl. Each device should have a variety of sensors for temperature, frequency, load, power, and more. 237 | 238 |

239 | coolercontrol shows sensors from an i5-14600k and a GTX 1070 243 |

244 | 245 | ### Checking devices for hwmon 246 | 247 | Check each device to see if it's being exposed by hwmon, which is already mounted to the container. The CPU sensors should be provided by hwmon. Click on the ⓘ next to the device (labeled _Device Details_) and look at the locations. 248 | 249 |

250 | coolercontrol shows the locations under a device 255 |

256 | 257 | The first location is `/sys/class/hwmon/hwmon2` which is being mounted to the container under hwmon. This means that this device is already being provided to the container regardless of whether privilged mode is on or not. 258 | 259 | Check each device and see if it is being provided by hwmon by checking under _Locations_. 260 | 261 | ### Example: adding an LED controller 262 | 263 | In this example system, CoolerControl is also discovering an LED controller built into the motherboard. 264 | 265 |

266 | coolercontrol shows the LED controller and its locations 271 |

272 | 273 | Under locations, the LED controller is identified at `/dev/hidraw4`. Because it is not provided by hwmon, it needs to be manually added to the container in Unraid. Return to the docker tab of Unraid and edit the container. 274 | 275 |

276 | edit is highlighted for CoolerControl in the Unraid docker menu 280 |

281 | 282 | In the Update Container screen, scroll to the bottom and select _Add another Path, Port, Variable, Label, or Device._ In the _Add Configuration_ menu, set the _Config Type_ to _Device_, because the device is located in `/dev`, which means it is a device. Add the path listed in CoolerControl, and name the device accordingly. 283 | 284 |

285 | in the edit configuration menu, the device info has been added 290 |

291 | 292 | Save this configuration and apply it to the container. This will update the container so that the LED controller will show up even if privileged mode is turned off. 293 | 294 | ### Example: adding fan controls 295 | 296 | On CoolerControl, find the device that is exposing the fans to the container. In this example, the fans are exposed under _it8689_. Notice that the locations does include hwmon. 297 | 298 |

299 | the fan configuration is seen under it8689 and hwmon is listed as a location 304 |

305 | 306 | However, because hwmon is mounted as read-only in the container, the fan speed can not be controlled if the container is not run in privileged mode. To get around this, the fan directory can be directly mounted in the Unraid container with read-write permissions. Return to the docker tab of Unraid and edit the container. 307 | 308 |

309 | edit is highlighted for CoolerControl in the Unraid docker menu 313 |

314 | 315 | In the _Update Container_ screen, scroll to the bottom and select _Add another Path, Port, Variable, Label, or Device._ In the _Add Configuration_ menu, keep the _Config Type_ on _Path_. Add the second path listed in CoolerControl's locations, and name the device accordingly. 316 | 317 |

318 | in the edit configuration menu, the path has been added 323 |

324 | 325 | Save this configuration and apply it to the container. This will update the container so that the fans are controllable even if privileged mode is turned off. 326 | 327 | ### Finalizing device setup 328 | 329 | Once the devices have been checked and set up in the Unraid _Update container_ screen, edit the container a final time to turn off privileged mode. Once privileged mode is off, open CoolerControl and check that all of the devices still appear, and that devices like fans can be controlled. Fans can be checked by setting them to manual and adjusting the fan speed. 330 | 331 |

332 | in coolercontrol, the fan has been set to manual and the speed has been adjusted 336 |

337 | 338 | If no error appears when applying the new fan speed, the configuration is working. 339 | 340 | > [!IMPORTANT] 341 | > There is currently no way to control Nvidia GPU fans without leaving the container in privileged mode, and it is not recommended to leave the container in privileged mode. 342 | 343 | ## Configuring CoolerControl 344 | 345 | ### Identify and name devices 346 | 347 | In CoolerControl, start by identifying fans by manually spinning them up and down. Then, give them a recognizable name by clicking on the rename button (🖉). 348 | 349 |

350 | the rename box is open in CoolerControl and filled in with CPU Fan 354 |

355 | 356 | The hard drives can also be named. Compare the temperature on the Unraid dashboard to the temperature in CoolerControl and name them accordingly, e.g. Parity, Disk 1, etc. 357 | 358 | ### Setting up a profile 359 | 360 | In CoolerControl, find profiles, found above the devices and sensors, and hit _Add Profile._ 361 | 362 |

363 | the add profile button is shown in coolercontrol 367 |

368 | 369 | Rename the profile appropriately, i.e. _CPU Profile_ for a profile that will be used for cooling the CPU. 370 | 371 | Next, edit the profile in the top right of the screen to choose the type of profile. This guide will focus on using a graph for the profile. 372 | 373 |

374 | the profile type selection menu is shown in CoolerControl 378 |

379 | 380 | Next, select a temperature sensor source for the profile. Since this example is for the CPU, this profile will use the CPU Temp Package Id 0. 381 | 382 |

383 | the temperature sensor selection menu is shown in CoolerControl 387 |

388 | 389 | CoolerControl by default applies a simple graph that increases the fan speed between 20°C to 100°C. 390 | 391 | Next, apply the profile to a fan. Select an appropriate fan and change the profile in the top right from _Default Profile_ to the profile created. 392 | 393 |

394 | the fan profile selection menu is shown in CoolerControl 398 |

399 | 400 | After saving, the fan speed should now follow the curve set in the profile. Return to the profile and adjust the points on the graph until it fits the server's cooling needs. It is also possible to have a fan not run until a particular temperature is hit. 401 | 402 | ### Combining sensors to create a custom sensor 403 | 404 | CoolerControl only allows one sensor to be set per profile, but it is possible to combine sensors to create one custom sensor. In this tutorial, the average of multiple hard drive temperatures will be combined into a custom sensor 405 | 406 | First, select the _Add Custom Sensor_ button next to Custom Sensors, found above the devices and sensors. 407 | 408 |

409 | the add custom sensor button is seen in CoolerControl 413 |

414 | 415 | Next, to make a sensor that is based on the averages of these temperatures, select _Avg_ under _Mix Function._ Depending on how the system's hard drives are physically organized, it may be better to have the _Mix Function_ be based on _Max_, which will use the sensor that has the highest temperature. 416 | 417 |

418 | the mix function options are seen in the custom sensors menu in CoolerControl 423 |

424 | 425 | Finally, under _Temp Sources_ select sensors that will be used for this custom sensor, and hit _Save Sensor_ in the top left. CoolerControl will do a quick reboot to make the new sensor. 426 | 427 |

428 | the sensor options are seen in the custom sensors menu in CoolerControl 432 |

433 | 434 | This sensor can now be used in a profile. 435 | 436 | ## Troubleshooting 437 | 438 | ### Could not connect to DBUS 439 | 440 | The "Could not connect to DBUS" error is normal when running in a Docker container. This feature is normally used by CoolerControl to check whether the system is sleeping, which will not happen with a Docker container. This error can be safely ignored. 441 | 442 | ### Issues with nct6687 drivers 443 | 444 | In some cases, Unraid may see devices using the nct6687 driver that is built-in to the Linux kernel but not be able to control them. Using the __Nuvoton NCT6687 Driver from ich777__ from Community Applications will likely work. If using the Nuvoton driver, make sure in Dynamix System Temp that the _Available Drivers_ option does NOT include nct6683 even if it is detected and available. These drivers will conflict and interfere with each other. 445 | 446 | ### Controlling Nvidia GPU fans 447 | 448 | There is currently no way to control Nvidia GPU fans without leaving the container in privileged mode, and it is **not recommended to leave the container in privileged mode.** 449 | 450 | ### Issues with Nvidia powersaving 451 | 452 | The [Nvidia powersaving script by SpaceInvaderOne](https://github.com/SpaceinvaderOne/nvidia_powersave) will stop the coolercontrold process used by this container if no other Docker containers are using the GPUs. To fix this, use [this revised script](https://github.com/guniv/CoolerControl-Docker/blob/main/tutorial/nvidia_power.sh) that specifically carves out an exception for coolercontrold. 453 | 454 | ### "Unable to set PWM value" and/or fan not staying on curve 455 | 456 | If CoolerControl is encountering this error or the fans won't stay at a speed to match the set curve, the system's BIOS settings may be interfering with CoolerControl. The fix will vary from BIOS to BIOS but it is recommended to set the system fans at full speed in the system BIOS. 457 | 458 | ### Slow HWMon Device detected 459 | 460 | The "Slow HWMon Device detected" error may be detected when Unraid spins disks down depending on the settings. This error can usually be safely ignored but may require attention in some scenarios. 461 | 462 | ## Known issues 463 | 464 | ### Hard drive spin down temperatures 465 | 466 | In CoolerControl versions earlier than 2.2.0, the last known temperature of a hard drive being reported to hwmon by drivetemp that has been spun down will only report the last known temperature of the device. This may impact a configuration that has a curve based on the drive speeds. For instance, fans could continue to run at a high speed if the drive spins down while running warm. Version 2.2.0 added support in the settings under "Daemon" to detect drive power state. 467 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------