" 5 | labels: [Bug] 6 | body: 7 | - type: checkboxes 8 | attributes: 9 | label: Is there an existing issue for this? 10 | description: Please search to see if an issue already exists for the bug you encountered. 11 | options: 12 | - label: I have searched the existing issues 13 | required: true 14 | - type: textarea 15 | attributes: 16 | label: Current Behavior 17 | description: Tell us what happens instead of the expected behavior. 18 | validations: 19 | required: true 20 | - type: textarea 21 | attributes: 22 | label: Expected Behavior 23 | description: Tell us what should happen. 24 | validations: 25 | required: false 26 | - type: textarea 27 | attributes: 28 | label: Steps To Reproduce 29 | description: Steps to reproduce the behavior. 30 | placeholder: | 31 | 1. In this environment... 32 | 2. With this config... 33 | 3. Run '...' 34 | 4. See error... 35 | validations: 36 | required: true 37 | - type: textarea 38 | attributes: 39 | label: Environment 40 | description: | 41 | examples: 42 | - **OS**: Ubuntu 20.04 43 | - **How docker service was installed**: distro's packagemanager 44 | value: | 45 | - OS: 46 | - How docker service was installed: 47 | render: markdown 48 | validations: 49 | required: false 50 | - type: textarea 51 | attributes: 52 | label: Docker creation 53 | description: | 54 | Command used to create docker container 55 | Provide your docker create/run command or compose yaml snippet, or a screenshot of settings if using a gui to create the container 56 | render: bash 57 | validations: 58 | required: true 59 | - type: textarea 60 | attributes: 61 | description: | 62 | Provide a full docker log, output of "docker logs socket-proxy" 63 | label: Container logs 64 | placeholder: | 65 | Output of `docker logs socket-proxy` 66 | render: bash 67 | validations: 68 | required: true 69 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/issue.feature.yml: -------------------------------------------------------------------------------- 1 | # Based on the issue template 2 | name: Feature request 3 | description: Suggest an idea for this project 4 | title: "[FEAT] <title>" 5 | labels: [enhancement] 6 | body: 7 | - type: checkboxes 8 | attributes: 9 | label: Is this a new feature request? 10 | description: Please search to see if a feature request already exists. 11 | options: 12 | - label: I have searched the existing issues 13 | required: true 14 | - type: textarea 15 | attributes: 16 | label: Wanted change 17 | description: Tell us what you want to happen. 18 | validations: 19 | required: true 20 | - type: textarea 21 | attributes: 22 | label: Reason for change 23 | description: Justify your request, why do you want it, what is the benefit. 24 | validations: 25 | required: true 26 | - type: textarea 27 | attributes: 28 | label: Proposed code change 29 | description: Do you have a potential code change in mind? 30 | validations: 31 | required: false 32 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 |  2 | 3 | [linuxserverurl]: https://linuxserver.io 4 | [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] 5 | 6 | 7 |  8 | 9 |  10 |  11 |  12 |  13 |  14 | 15 | 16 |  17 |  18 |  19 |  20 |  21 | 22 | ------------------------------ 23 | 24 | - [ ] I have read the [contributing](https://github.com/linuxserver/docker-socket-proxy/blob/main/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications 25 | 26 | ------------------------------ 27 | 28 |  29 | 30 | ## Description: 31 |  32 | 33 | ## Benefits of this PR and context: 34 |  35 | 36 | ## How Has This Been Tested? 37 |  38 |  39 |  40 | 41 | 42 | ## Source / References: 43 |  44 | -------------------------------------------------------------------------------- /.github/workflows/call_issue_pr_tracker.yml: -------------------------------------------------------------------------------- 1 | name: Issue & PR Tracker 2 | 3 | on: 4 | issues: 5 | types: [opened,reopened,labeled,unlabeled,closed] 6 | pull_request_target: 7 | types: [opened,reopened,review_requested,review_request_removed,labeled,unlabeled,closed] 8 | pull_request_review: 9 | types: [submitted,edited,dismissed] 10 | 11 | jobs: 12 | manage-project: 13 | permissions: 14 | issues: write 15 | uses: linuxserver/github-workflows/.github/workflows/issue-pr-tracker.yml@v1 16 | secrets: inherit 17 | -------------------------------------------------------------------------------- /.github/workflows/call_issues_cron.yml: -------------------------------------------------------------------------------- 1 | name: Mark stale issues and pull requests 2 | on: 3 | schedule: 4 | - cron: '40 6 * * *' 5 | workflow_dispatch: 6 | 7 | jobs: 8 | stale: 9 | permissions: 10 | issues: write 11 | pull-requests: write 12 | uses: linuxserver/github-workflows/.github/workflows/issues-cron.yml@v1 13 | secrets: inherit 14 | -------------------------------------------------------------------------------- /.github/workflows/external_trigger.yml: -------------------------------------------------------------------------------- 1 | name: External Trigger Main 2 | 3 | on: 4 | workflow_dispatch: 5 | 6 | jobs: 7 | external-trigger-main: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v4.1.1 11 | 12 | - name: External Trigger 13 | if: github.ref == 'refs/heads/main' 14 | env: 15 | SKIP_EXTERNAL_TRIGGER: ${{ vars.SKIP_EXTERNAL_TRIGGER }} 16 | run: | 17 | printf "# External trigger for docker-socket-proxy\n\n" >> $GITHUB_STEP_SUMMARY 18 | if grep -q "^socket-proxy_main_" <<< "${SKIP_EXTERNAL_TRIGGER}"; then 19 | echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY 20 | echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` contains \`socket-proxy_main_\`; will skip trigger if version matches." >> $GITHUB_STEP_SUMMARY 21 | elif grep -q "^socket-proxy_main" <<< "${SKIP_EXTERNAL_TRIGGER}"; then 22 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 23 | echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` contains \`socket-proxy_main\`; skipping trigger." >> $GITHUB_STEP_SUMMARY 24 | exit 0 25 | fi 26 | echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY 27 | echo "> External trigger running off of main branch. To disable this trigger, add \`socket-proxy_main\` into the Github organizational variable \`SKIP_EXTERNAL_TRIGGER\`." >> $GITHUB_STEP_SUMMARY 28 | printf "\n## Retrieving external version\n\n" >> $GITHUB_STEP_SUMMARY 29 | EXT_RELEASE=$(curl -sL "http://dl-cdn.alpinelinux.org/alpine/v3.22/main/x86_64/APKINDEX.tar.gz" | tar -xz -C /tmp \ 30 | && awk '/^P:'"haproxy"'$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://') 31 | echo "Type is \`alpine_repo\`" >> $GITHUB_STEP_SUMMARY 32 | if grep -q "^socket-proxy_main_${EXT_RELEASE}" <<< "${SKIP_EXTERNAL_TRIGGER}"; then 33 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 34 | echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` matches current external release; skipping trigger." >> $GITHUB_STEP_SUMMARY 35 | exit 0 36 | fi 37 | if [ -z "${EXT_RELEASE}" ] || [ "${EXT_RELEASE}" == "null" ]; then 38 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 39 | echo "> Can't retrieve external version, exiting" >> $GITHUB_STEP_SUMMARY 40 | FAILURE_REASON="Can't retrieve external version for socket-proxy branch main" 41 | GHA_TRIGGER_URL="https://github.com/linuxserver/docker-socket-proxy/actions/runs/${{ github.run_id }}" 42 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680, 43 | "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n**Trigger URL:** '"${GHA_TRIGGER_URL}"' \n"}], 44 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 45 | exit 1 46 | fi 47 | EXT_RELEASE=$(echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g') 48 | echo "External version: \`${EXT_RELEASE}\`" >> $GITHUB_STEP_SUMMARY 49 | echo "Retrieving last pushed version" >> $GITHUB_STEP_SUMMARY 50 | image="linuxserver/socket-proxy" 51 | tag="latest" 52 | token=$(curl -sX GET \ 53 | "https://ghcr.io/token?scope=repository%3Alinuxserver%2Fsocket-proxy%3Apull" \ 54 | | jq -r '.token') 55 | multidigest=$(curl -s \ 56 | --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \ 57 | --header "Accept: application/vnd.oci.image.index.v1+json" \ 58 | --header "Authorization: Bearer ${token}" \ 59 | "https://ghcr.io/v2/${image}/manifests/${tag}") 60 | if jq -e '.layers // empty' <<< "${multidigest}" >/dev/null 2>&1; then 61 | # If there's a layer element it's a single-arch manifest so just get that digest 62 | digest=$(jq -r '.config.digest' <<< "${multidigest}") 63 | else 64 | # Otherwise it's multi-arch or has manifest annotations 65 | if jq -e '.manifests[]?.annotations // empty' <<< "${multidigest}" >/dev/null 2>&1; then 66 | # Check for manifest annotations and delete if found 67 | multidigest=$(jq 'del(.manifests[] | select(.annotations))' <<< "${multidigest}") 68 | fi 69 | if [[ $(jq '.manifests | length' <<< "${multidigest}") -gt 1 ]]; then 70 | # If there's still more than one digest, it's multi-arch 71 | multidigest=$(jq -r ".manifests[] | select(.platform.architecture == \"amd64\").digest?" <<< "${multidigest}") 72 | else 73 | # Otherwise it's single arch 74 | multidigest=$(jq -r ".manifests[].digest?" <<< "${multidigest}") 75 | fi 76 | if digest=$(curl -s \ 77 | --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \ 78 | --header "Accept: application/vnd.oci.image.manifest.v1+json" \ 79 | --header "Authorization: Bearer ${token}" \ 80 | "https://ghcr.io/v2/${image}/manifests/${multidigest}"); then 81 | digest=$(jq -r '.config.digest' <<< "${digest}"); 82 | fi 83 | fi 84 | image_info=$(curl -sL \ 85 | --header "Authorization: Bearer ${token}" \ 86 | "https://ghcr.io/v2/${image}/blobs/${digest}") 87 | if [[ $(echo $image_info | jq -r '.container_config') == "null" ]]; then 88 | image_info=$(echo $image_info | jq -r '.config') 89 | else 90 | image_info=$(echo $image_info | jq -r '.container_config') 91 | fi 92 | IMAGE_RELEASE=$(echo ${image_info} | jq -r '.Labels.build_version' | awk '{print $3}') 93 | IMAGE_VERSION=$(echo ${IMAGE_RELEASE} | awk -F'-ls' '{print $1}') 94 | if [ -z "${IMAGE_VERSION}" ]; then 95 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 96 | echo "Can't retrieve last pushed version, exiting" >> $GITHUB_STEP_SUMMARY 97 | FAILURE_REASON="Can't retrieve last pushed version for socket-proxy tag latest" 98 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680, 99 | "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}], 100 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 101 | exit 1 102 | fi 103 | echo "Last pushed version: \`${IMAGE_VERSION}\`" >> $GITHUB_STEP_SUMMARY 104 | if [ "${EXT_RELEASE}" == "${IMAGE_VERSION}" ]; then 105 | echo "Version \`${EXT_RELEASE}\` already pushed, exiting" >> $GITHUB_STEP_SUMMARY 106 | exit 0 107 | elif [[ $(curl -sL "http://dl-cdn.alpinelinux.org/alpine/v3.22/main/aarch64/APKINDEX.tar.gz" | tar -xz -C /tmp && awk '/^P:'"haproxy"'$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://') != "${EXT_RELEASE}" ]]; then 108 | echo "New version \`${EXT_RELEASE}\` found; but not all arch repos updated yet; exiting" >> $GITHUB_STEP_SUMMARY 109 | FAILURE_REASON="New version ${EXT_RELEASE} for socket-proxy tag latest is detected, however not all arch repos are updated yet. Will try again later." 110 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, 111 | "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}], 112 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 113 | exit 0 114 | elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-socket-proxy/job/main/lastBuild/api/json | jq -r '.building') == "true" ]; then 115 | echo "New version \`${EXT_RELEASE}\` found; but there already seems to be an active build on Jenkins; exiting" >> $GITHUB_STEP_SUMMARY 116 | exit 0 117 | else 118 | if [[ "${artifacts_found}" == "false" ]]; then 119 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 120 | echo "> New version detected, but not all artifacts are published yet; skipping trigger" >> $GITHUB_STEP_SUMMARY 121 | FAILURE_REASON="New version ${EXT_RELEASE} for socket-proxy tag latest is detected, however not all artifacts are uploaded to upstream release yet. Will try again later." 122 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, 123 | "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}], 124 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 125 | else 126 | printf "\n## Trigger new build\n\n" >> $GITHUB_STEP_SUMMARY 127 | echo "New version \`${EXT_RELEASE}\` found; old version was \`${IMAGE_VERSION}\`. Triggering new build" >> $GITHUB_STEP_SUMMARY 128 | if [[ "${artifacts_found}" == "true" ]]; then 129 | echo "All artifacts seem to be uploaded." >> $GITHUB_STEP_SUMMARY 130 | fi 131 | response=$(curl -iX POST \ 132 | https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-socket-proxy/job/main/buildWithParameters?PACKAGE_CHECK=false \ 133 | --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: $.*$|\1|") 134 | echo "Jenkins [job queue url](${response%$'\r'})" >> $GITHUB_STEP_SUMMARY 135 | echo "Sleeping 10 seconds until job starts" >> $GITHUB_STEP_SUMMARY 136 | sleep 10 137 | buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url') 138 | buildurl="${buildurl%$'\r'}" 139 | echo "Jenkins job [build url](${buildurl})" >> $GITHUB_STEP_SUMMARY 140 | echo "Attempting to change the Jenkins job description" >> $GITHUB_STEP_SUMMARY 141 | curl -iX POST \ 142 | "${buildurl}submitDescription" \ 143 | --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \ 144 | --data-urlencode "description=GHA external trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \ 145 | --data-urlencode "Submit=Submit" 146 | echo "**** Notifying Discord ****" 147 | TRIGGER_REASON="A version change was detected for socket-proxy tag latest. Old version:${IMAGE_VERSION} New version:${EXT_RELEASE}" 148 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, 149 | "description": "**Build Triggered** \n**Reason:** '"${TRIGGER_REASON}"' \n**Build URL:** '"${buildurl}display/redirect"' \n"}], 150 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 151 | fi 152 | fi 153 | -------------------------------------------------------------------------------- /.github/workflows/external_trigger_scheduler.yml: -------------------------------------------------------------------------------- 1 | name: External Trigger Scheduler 2 | 3 | on: 4 | schedule: 5 | - cron: '40 * * * *' 6 | workflow_dispatch: 7 | 8 | jobs: 9 | external-trigger-scheduler: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v4.1.1 13 | with: 14 | fetch-depth: '0' 15 | 16 | - name: External Trigger Scheduler 17 | run: | 18 | printf "# External trigger scheduler for docker-socket-proxy\n\n" >> $GITHUB_STEP_SUMMARY 19 | printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY 20 | for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes) 21 | do 22 | if [[ "${br}" == "HEAD" ]]; then 23 | printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY 24 | continue 25 | fi 26 | printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY 27 | ls_jenkins_vars=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-socket-proxy/${br}/jenkins-vars.yml) 28 | ls_branch=$(echo "${ls_jenkins_vars}" | yq -r '.ls_branch') 29 | ls_trigger=$(echo "${ls_jenkins_vars}" | yq -r '.external_type') 30 | if [[ "${br}" == "${ls_branch}" ]] && [[ "${ls_trigger}" != "os" ]]; then 31 | echo "Branch appears to be live and trigger is not os; checking workflow." >> $GITHUB_STEP_SUMMARY 32 | if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-socket-proxy/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then 33 | echo "Triggering external trigger workflow for branch." >> $GITHUB_STEP_SUMMARY 34 | curl -iX POST \ 35 | -H "Authorization: token ${{ secrets.CR_PAT }}" \ 36 | -H "Accept: application/vnd.github.v3+json" \ 37 | -d "{\"ref\":\"refs/heads/${br}\"}" \ 38 | https://api.github.com/repos/linuxserver/docker-socket-proxy/actions/workflows/external_trigger.yml/dispatches 39 | else 40 | echo "Skipping branch due to no external trigger workflow present." >> $GITHUB_STEP_SUMMARY 41 | fi 42 | else 43 | echo "Skipping branch due to being detected as dev branch or having no external version." >> $GITHUB_STEP_SUMMARY 44 | fi 45 | done 46 | -------------------------------------------------------------------------------- /.github/workflows/greetings.yml: -------------------------------------------------------------------------------- 1 | name: Greetings 2 | 3 | on: [pull_request_target, issues] 4 | 5 | jobs: 6 | greeting: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/first-interaction@v1 10 | with: 11 | issue-message: 'Thanks for opening your first issue here! Be sure to follow the relevant issue templates, or risk having this issue marked as invalid.' 12 | pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-socket-proxy/blob/main/.github/PULL_REQUEST_TEMPLATE.md)!' 13 | repo-token: ${{ secrets.GITHUB_TOKEN }} 14 | -------------------------------------------------------------------------------- /.github/workflows/package_trigger_scheduler.yml: -------------------------------------------------------------------------------- 1 | name: Package Trigger Scheduler 2 | 3 | on: 4 | schedule: 5 | - cron: '40 20 * * 1' 6 | workflow_dispatch: 7 | 8 | jobs: 9 | package-trigger-scheduler: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v4.1.1 13 | with: 14 | fetch-depth: '0' 15 | 16 | - name: Package Trigger Scheduler 17 | env: 18 | SKIP_PACKAGE_TRIGGER: ${{ vars.SKIP_PACKAGE_TRIGGER }} 19 | run: | 20 | printf "# Package trigger scheduler for docker-socket-proxy\n\n" >> $GITHUB_STEP_SUMMARY 21 | printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY 22 | for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes) 23 | do 24 | if [[ "${br}" == "HEAD" ]]; then 25 | printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY 26 | continue 27 | fi 28 | printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY 29 | JENKINS_VARS=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-socket-proxy/${br}/jenkins-vars.yml) 30 | if ! curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-socket-proxy/${br}/Jenkinsfile >/dev/null 2>&1; then 31 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 32 | echo "> No Jenkinsfile found. Branch is either deprecated or is an early dev branch." >> $GITHUB_STEP_SUMMARY 33 | skipped_branches="${skipped_branches}${br} " 34 | elif [[ "${br}" == $(yq -r '.ls_branch' <<< "${JENKINS_VARS}") ]]; then 35 | echo "Branch appears to be live; checking workflow." >> $GITHUB_STEP_SUMMARY 36 | README_VARS=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-socket-proxy/${br}/readme-vars.yml) 37 | if [[ $(yq -r '.project_deprecation_status' <<< "${README_VARS}") == "true" ]]; then 38 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 39 | echo "> Branch appears to be deprecated; skipping trigger." >> $GITHUB_STEP_SUMMARY 40 | skipped_branches="${skipped_branches}${br} " 41 | elif [[ $(yq -r '.skip_package_check' <<< "${JENKINS_VARS}") == "true" ]]; then 42 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 43 | echo "> Skipping branch ${br} due to \`skip_package_check\` being set in \`jenkins-vars.yml\`." >> $GITHUB_STEP_SUMMARY 44 | skipped_branches="${skipped_branches}${br} " 45 | elif grep -q "^socket-proxy_${br}" <<< "${SKIP_PACKAGE_TRIGGER}"; then 46 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 47 | echo "> Github organizational variable \`SKIP_PACKAGE_TRIGGER\` contains \`socket-proxy_${br}\`; skipping trigger." >> $GITHUB_STEP_SUMMARY 48 | skipped_branches="${skipped_branches}${br} " 49 | elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-socket-proxy/job/${br}/lastBuild/api/json | jq -r '.building' 2>/dev/null) == "true" ]; then 50 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 51 | echo "> There already seems to be an active build on Jenkins; skipping package trigger for ${br}" >> $GITHUB_STEP_SUMMARY 52 | skipped_branches="${skipped_branches}${br} " 53 | else 54 | echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY 55 | echo "> Triggering package trigger for branch ${br}" >> $GITHUB_STEP_SUMMARY 56 | printf "> To disable, add \`socket-proxy_%s\` into the Github organizational variable \`SKIP_PACKAGE_TRIGGER\`.\n\n" "${br}" >> $GITHUB_STEP_SUMMARY 57 | triggered_branches="${triggered_branches}${br} " 58 | response=$(curl -iX POST \ 59 | https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-socket-proxy/job/${br}/buildWithParameters?PACKAGE_CHECK=true \ 60 | --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: $.*$|\1|") 61 | if [[ -z "${response}" ]]; then 62 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 63 | echo "> Jenkins build could not be triggered. Skipping branch." 64 | continue 65 | fi 66 | echo "Jenkins [job queue url](${response%$'\r'})" >> $GITHUB_STEP_SUMMARY 67 | echo "Sleeping 10 seconds until job starts" >> $GITHUB_STEP_SUMMARY 68 | sleep 10 69 | buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url') 70 | buildurl="${buildurl%$'\r'}" 71 | echo "Jenkins job [build url](${buildurl})" >> $GITHUB_STEP_SUMMARY 72 | echo "Attempting to change the Jenkins job description" >> $GITHUB_STEP_SUMMARY 73 | if ! curl -ifX POST \ 74 | "${buildurl}submitDescription" \ 75 | --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \ 76 | --data-urlencode "description=GHA package trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \ 77 | --data-urlencode "Submit=Submit"; then 78 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 79 | echo "> Unable to change the Jenkins job description." 80 | fi 81 | sleep 20 82 | fi 83 | else 84 | echo "Skipping branch ${br} due to being detected as dev branch." >> $GITHUB_STEP_SUMMARY 85 | fi 86 | done 87 | if [[ -n "${triggered_branches}" ]] || [[ -n "${skipped_branches}" ]]; then 88 | if [[ -n "${triggered_branches}" ]]; then 89 | NOTIFY_BRANCHES="**Triggered:** ${triggered_branches} \n" 90 | NOTIFY_BUILD_URL="**Build URL:** https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-socket-proxy/activity/ \n" 91 | echo "**** Package check build(s) triggered for branch(es): ${triggered_branches} ****" 92 | fi 93 | if [[ -n "${skipped_branches}" ]]; then 94 | NOTIFY_BRANCHES="${NOTIFY_BRANCHES}**Skipped:** ${skipped_branches} \n" 95 | fi 96 | echo "**** Notifying Discord ****" 97 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, 98 | "description": "**Package Check Build(s) for socket-proxy** \n'"${NOTIFY_BRANCHES}"''"${NOTIFY_BUILD_URL}"'"}], 99 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 100 | fi 101 | -------------------------------------------------------------------------------- /.github/workflows/permissions.yml: -------------------------------------------------------------------------------- 1 | name: Permission check 2 | on: 3 | pull_request_target: 4 | paths: 5 | - '**/run' 6 | - '**/finish' 7 | - '**/check' 8 | - 'root/migrations/*' 9 | 10 | jobs: 11 | permission_check: 12 | uses: linuxserver/github-workflows/.github/workflows/init-svc-executable-permissions.yml@v1 13 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Windows image file caches 2 | Thumbs.db 3 | ehthumbs.db 4 | 5 | # Folder config file 6 | Desktop.ini 7 | 8 | # Recycle Bin used on file shares 9 | $RECYCLE.BIN/ 10 | 11 | # Windows Installer files 12 | *.cab 13 | *.msi 14 | *.msm 15 | *.msp 16 | 17 | # Windows shortcuts 18 | *.lnk 19 | 20 | # ========================= 21 | # Operating System Files 22 | # ========================= 23 | 24 | # OSX 25 | # ========================= 26 | 27 | .DS_Store 28 | .AppleDouble 29 | .LSOverride 30 | 31 | # Thumbnails 32 | ._* 33 | 34 | # Files that might appear on external disk 35 | .Spotlight-V100 36 | .Trashes 37 | 38 | # Directories potentially created on remote AFP share 39 | .AppleDB 40 | .AppleDesktop 41 | Network Trash Folder 42 | Temporary Items 43 | .apdisk 44 | .jenkins-external 45 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # syntax=docker/dockerfile:1 2 | 3 | FROM docker.io/alpine:3.22 4 | 5 | # set version label 6 | ARG BUILD_DATE 7 | ARG VERSION 8 | ARG HAPROXY_VERSION 9 | LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}" 10 | LABEL maintainer="thespad" 11 | 12 | # install packages 13 | RUN \ 14 | echo "**** install build packages ****" && \ 15 | apk add --no-cache \ 16 | alpine-release \ 17 | curl && \ 18 | if [ -z ${HAPROXY_VERSION+x} ]; then \ 19 | HAPROXY_VERSION=$(curl -sL "http://dl-cdn.alpinelinux.org/alpine/v3.22/main/x86_64/APKINDEX.tar.gz" | tar -xz -C /tmp \ 20 | && awk '/^P:haproxy$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://'); \ 21 | fi && \ 22 | apk add --no-cache \ 23 | haproxy==${HAPROXY_VERSION} && \ 24 | printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \ 25 | apk del --no-cache \ 26 | curl && \ 27 | rm -rf \ 28 | /etc/haproxy \ 29 | /tmp/* 30 | 31 | ENV ALLOW_RESTARTS=0 \ 32 | ALLOW_STOP=0 \ 33 | ALLOW_START=0 \ 34 | AUTH=0 \ 35 | BUILD=0 \ 36 | COMMIT=0 \ 37 | CONFIGS=0 \ 38 | CONTAINERS=0 \ 39 | DISTRIBUTION=0 \ 40 | EVENTS=1 \ 41 | EXEC=0 \ 42 | IMAGES=0 \ 43 | INFO=0 \ 44 | LOG_LEVEL=info \ 45 | NETWORKS=0 \ 46 | NODES=0 \ 47 | PING=1 \ 48 | PLUGINS=0 \ 49 | POST=0 \ 50 | SECRETS=0 \ 51 | SERVICES=0 \ 52 | SESSION=0 \ 53 | SOCKET_PATH=/var/run/docker.sock \ 54 | SWARM=0 \ 55 | SYSTEM=0 \ 56 | TASKS=0 \ 57 | VERSION=1 \ 58 | VOLUMES=0 59 | 60 | # add local files 61 | COPY root/ / 62 | 63 | ENTRYPOINT ["/docker-entrypoint.sh"] 64 | -------------------------------------------------------------------------------- /Dockerfile.aarch64: -------------------------------------------------------------------------------- 1 | # syntax=docker/dockerfile:1 2 | 3 | FROM docker.io/alpine:3.22 4 | 5 | # set version label 6 | ARG BUILD_DATE 7 | ARG VERSION 8 | ARG HAPROXY_VERSION 9 | LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}" 10 | LABEL maintainer="thespad" 11 | 12 | # install packages 13 | RUN \ 14 | echo "**** install build packages ****" && \ 15 | apk add --no-cache \ 16 | alpine-release \ 17 | curl && \ 18 | if [ -z ${HAPROXY_VERSION+x} ]; then \ 19 | HAPROXY_VERSION=$(curl -sL "http://dl-cdn.alpinelinux.org/alpine/v3.22/main/x86_64/APKINDEX.tar.gz" | tar -xz -C /tmp \ 20 | && awk '/^P:haproxy$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://'); \ 21 | fi && \ 22 | apk add --no-cache \ 23 | haproxy==${HAPROXY_VERSION} && \ 24 | printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \ 25 | apk del --no-cache \ 26 | curl && \ 27 | rm -rf \ 28 | /etc/haproxy \ 29 | /tmp/* 30 | 31 | ENV ALLOW_RESTARTS=0 \ 32 | ALLOW_STOP=0 \ 33 | ALLOW_START=0 \ 34 | AUTH=0 \ 35 | BUILD=0 \ 36 | COMMIT=0 \ 37 | CONFIGS=0 \ 38 | CONTAINERS=0 \ 39 | DISTRIBUTION=0 \ 40 | EVENTS=1 \ 41 | EXEC=0 \ 42 | IMAGES=0 \ 43 | INFO=0 \ 44 | LOG_LEVEL=info \ 45 | NETWORKS=0 \ 46 | NODES=0 \ 47 | PING=1 \ 48 | PLUGINS=0 \ 49 | POST=0 \ 50 | SECRETS=0 \ 51 | SERVICES=0 \ 52 | SESSION=0 \ 53 | SOCKET_PATH=/var/run/docker.sock \ 54 | SWARM=0 \ 55 | SYSTEM=0 \ 56 | TASKS=0 \ 57 | VERSION=1 \ 58 | VOLUMES=0 59 | 60 | # add local files 61 | COPY root/ / 62 | 63 | ENTRYPOINT ["/docker-entrypoint.sh"] 64 | -------------------------------------------------------------------------------- /Dockerfile.riscv64: -------------------------------------------------------------------------------- 1 | # syntax=docker/dockerfile:1 2 | 3 | FROM docker.io/alpine:3.22 4 | 5 | # set version label 6 | ARG BUILD_DATE 7 | ARG VERSION 8 | ARG HAPROXY_VERSION 9 | LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}" 10 | LABEL maintainer="thespad" 11 | 12 | # install packages 13 | RUN \ 14 | echo "**** install build packages ****" && \ 15 | apk add --no-cache \ 16 | alpine-release \ 17 | curl && \ 18 | if [ -z ${HAPROXY_VERSION+x} ]; then \ 19 | HAPROXY_VERSION=$(curl -sL "http://dl-cdn.alpinelinux.org/alpine/v3.22/main/x86_64/APKINDEX.tar.gz" | tar -xz -C /tmp \ 20 | && awk '/^P:haproxy$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://'); \ 21 | fi && \ 22 | apk add --no-cache \ 23 | haproxy==${HAPROXY_VERSION} && \ 24 | printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \ 25 | apk del --no-cache \ 26 | curl && \ 27 | rm -rf \ 28 | /etc/haproxy \ 29 | /tmp/* 30 | 31 | ENV ALLOW_RESTARTS=0 \ 32 | ALLOW_STOP=0 \ 33 | ALLOW_START=0 \ 34 | AUTH=0 \ 35 | BUILD=0 \ 36 | COMMIT=0 \ 37 | CONFIGS=0 \ 38 | CONTAINERS=0 \ 39 | DISTRIBUTION=0 \ 40 | EVENTS=1 \ 41 | EXEC=0 \ 42 | IMAGES=0 \ 43 | INFO=0 \ 44 | LOG_LEVEL=info \ 45 | NETWORKS=0 \ 46 | NODES=0 \ 47 | PING=1 \ 48 | PLUGINS=0 \ 49 | POST=0 \ 50 | SECRETS=0 \ 51 | SERVICES=0 \ 52 | SESSION=0 \ 53 | SOCKET_PATH=/var/run/docker.sock \ 54 | SWARM=0 \ 55 | SYSTEM=0 \ 56 | TASKS=0 \ 57 | VERSION=1 \ 58 | VOLUMES=0 59 | 60 | # add local files 61 | COPY root/ / 62 | 63 | ENTRYPOINT ["/docker-entrypoint.sh"] 64 | -------------------------------------------------------------------------------- /Jenkinsfile: -------------------------------------------------------------------------------- 1 | pipeline { 2 | agent { 3 | label 'X86-64-MULTI' 4 | } 5 | options { 6 | buildDiscarder(logRotator(numToKeepStr: '10', daysToKeepStr: '60')) 7 | parallelsAlwaysFailFast() 8 | } 9 | // Input to determine if this is a package check 10 | parameters { 11 | string(defaultValue: 'false', description: 'package check run', name: 'PACKAGE_CHECK') 12 | } 13 | // Configuration for the variables used for this specific repo 14 | environment { 15 | BUILDS_DISCORD=credentials('build_webhook_url') 16 | GITHUB_TOKEN=credentials('498b4638-2d02-4ce5-832d-8a57d01d97ab') 17 | GITLAB_TOKEN=credentials('b6f0f1dd-6952-4cf6-95d1-9c06380283f0') 18 | GITLAB_NAMESPACE=credentials('gitlab-namespace-id') 19 | DOCKERHUB_TOKEN=credentials('docker-hub-ci-pat') 20 | QUAYIO_API_TOKEN=credentials('quayio-repo-api-token') 21 | GIT_SIGNING_KEY=credentials('484fbca6-9a4f-455e-b9e3-97ac98785f5f') 22 | BUILD_VERSION_ARG = 'HAPROXY_VERSION' 23 | LS_USER = 'linuxserver' 24 | LS_REPO = 'docker-socket-proxy' 25 | CONTAINER_NAME = 'socket-proxy' 26 | DOCKERHUB_IMAGE = 'linuxserver/socket-proxy' 27 | DEV_DOCKERHUB_IMAGE = 'lsiodev/socket-proxy' 28 | PR_DOCKERHUB_IMAGE = 'lspipepr/socket-proxy' 29 | DIST_IMAGE = 'alpine' 30 | DIST_REPO = 'http://dl-cdn.alpinelinux.org/alpine/v3.22/main/' 31 | DIST_REPO_PACKAGES = 'haproxy' 32 | MULTIARCH='true' 33 | CI='true' 34 | CI_WEB='false' 35 | CI_PORT='2375' 36 | CI_SSL='false' 37 | CI_DELAY='120' 38 | CI_DOCKERENV='' 39 | CI_AUTH='' 40 | CI_WEBPATH='' 41 | } 42 | stages { 43 | stage("Set git config"){ 44 | steps{ 45 | sh '''#!/bin/bash 46 | cat ${GIT_SIGNING_KEY} > /config/.ssh/id_sign 47 | chmod 600 /config/.ssh/id_sign 48 | ssh-keygen -y -f /config/.ssh/id_sign > /config/.ssh/id_sign.pub 49 | echo "Using $(ssh-keygen -lf /config/.ssh/id_sign) to sign commits" 50 | git config --global gpg.format ssh 51 | git config --global user.signingkey /config/.ssh/id_sign 52 | git config --global commit.gpgsign true 53 | ''' 54 | } 55 | } 56 | // Setup all the basic environment variables needed for the build 57 | stage("Set ENV Variables base"){ 58 | steps{ 59 | echo "Running on node: ${NODE_NAME}" 60 | sh '''#! /bin/bash 61 | echo "Pruning builder" 62 | docker builder prune -f --builder container || : 63 | containers=$(docker ps -q) 64 | if [[ -n "${containers}" ]]; then 65 | BUILDX_CONTAINER_ID=$(docker ps -qf 'name=buildx_buildkit') 66 | for container in ${containers}; do 67 | if [[ "${container}" == "${BUILDX_CONTAINER_ID}" ]]; then 68 | echo "skipping buildx container in docker stop" 69 | else 70 | echo "Stopping container ${container}" 71 | docker stop ${container} 72 | fi 73 | done 74 | fi 75 | docker system prune -f --volumes || : 76 | docker image prune -af || : 77 | ''' 78 | script{ 79 | env.EXIT_STATUS = '' 80 | env.LS_RELEASE = sh( 81 | script: '''docker run --rm quay.io/skopeo/stable:v1 inspect docker://ghcr.io/${LS_USER}/${CONTAINER_NAME}:latest 2>/dev/null | jq -r '.Labels.build_version' | awk '{print $3}' | grep '\\-ls' || : ''', 82 | returnStdout: true).trim() 83 | env.LS_RELEASE_NOTES = sh( 84 | script: '''cat readme-vars.yml | awk -F \\" '/date: "[0-9][0-9].[0-9][0-9].[0-9][0-9]:/ {print $4;exit;}' | sed -E ':a;N;$!ba;s/\\r{0,1}\\n/\\\\n/g' ''', 85 | returnStdout: true).trim() 86 | env.GITHUB_DATE = sh( 87 | script: '''date '+%Y-%m-%dT%H:%M:%S%:z' ''', 88 | returnStdout: true).trim() 89 | env.COMMIT_SHA = sh( 90 | script: '''git rev-parse HEAD''', 91 | returnStdout: true).trim() 92 | env.GH_DEFAULT_BRANCH = sh( 93 | script: '''git remote show origin | grep "HEAD branch:" | sed 's|.*HEAD branch: ||' ''', 94 | returnStdout: true).trim() 95 | env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/commit/' + env.GIT_COMMIT 96 | env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DOCKERHUB_IMAGE + '/tags/' 97 | env.PULL_REQUEST = env.CHANGE_ID 98 | env.TEMPLATED_FILES = 'Jenkinsfile README.md LICENSE .editorconfig ./.github/CONTRIBUTING.md ./.github/FUNDING.yml ./.github/ISSUE_TEMPLATE/config.yml ./.github/ISSUE_TEMPLATE/issue.bug.yml ./.github/ISSUE_TEMPLATE/issue.feature.yml ./.github/PULL_REQUEST_TEMPLATE.md ./.github/workflows/external_trigger_scheduler.yml ./.github/workflows/greetings.yml ./.github/workflows/package_trigger_scheduler.yml ./.github/workflows/call_issue_pr_tracker.yml ./.github/workflows/call_issues_cron.yml ./.github/workflows/permissions.yml ./.github/workflows/external_trigger.yml' 99 | } 100 | sh '''#! /bin/bash 101 | echo "The default github branch detected as ${GH_DEFAULT_BRANCH}" ''' 102 | script{ 103 | env.LS_RELEASE_NUMBER = sh( 104 | script: '''echo ${LS_RELEASE} |sed 's/^.*-ls//g' ''', 105 | returnStdout: true).trim() 106 | } 107 | script{ 108 | env.LS_TAG_NUMBER = sh( 109 | script: '''#! /bin/bash 110 | tagsha=$(git rev-list -n 1 ${LS_RELEASE} 2>/dev/null) 111 | if [ "${tagsha}" == "${COMMIT_SHA}" ]; then 112 | echo ${LS_RELEASE_NUMBER} 113 | elif [ -z "${GIT_COMMIT}" ]; then 114 | echo ${LS_RELEASE_NUMBER} 115 | else 116 | echo $((${LS_RELEASE_NUMBER} + 1)) 117 | fi''', 118 | returnStdout: true).trim() 119 | } 120 | } 121 | } 122 | /* ####################### 123 | Package Version Tagging 124 | ####################### */ 125 | // Grab the current package versions in Git to determine package tag 126 | stage("Set Package tag"){ 127 | steps{ 128 | script{ 129 | env.PACKAGE_TAG = sh( 130 | script: '''#!/bin/bash 131 | if [ -e package_versions.txt ] ; then 132 | cat package_versions.txt | md5sum | cut -c1-8 133 | else 134 | echo none 135 | fi''', 136 | returnStdout: true).trim() 137 | } 138 | } 139 | } 140 | /* ######################## 141 | External Release Tagging 142 | ######################## */ 143 | // If this is an alpine repo change for external version determine an md5 from the version string 144 | stage("Set tag Alpine Repo"){ 145 | steps{ 146 | script{ 147 | env.EXT_RELEASE = sh( 148 | script: '''curl -sL "${DIST_REPO}x86_64/APKINDEX.tar.gz" | tar -xz -C /tmp \ 149 | && awk '/^P:'"${DIST_REPO_PACKAGES}"'$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://' ''', 150 | returnStdout: true).trim() 151 | env.RELEASE_LINK = 'alpine_repo' 152 | } 153 | } 154 | } 155 | // Sanitize the release tag and strip illegal docker or github characters 156 | stage("Sanitize tag"){ 157 | steps{ 158 | script{ 159 | env.EXT_RELEASE_CLEAN = sh( 160 | script: '''echo ${EXT_RELEASE} | sed 's/[~,%@+;:/ ]//g' ''', 161 | returnStdout: true).trim() 162 | 163 | def semver = env.EXT_RELEASE_CLEAN =~ /(\d+)\.(\d+)\.(\d+)/ 164 | if (semver.find()) { 165 | env.SEMVER = "${semver[0][1]}.${semver[0][2]}.${semver[0][3]}" 166 | } else { 167 | semver = env.EXT_RELEASE_CLEAN =~ /(\d+)\.(\d+)(?:\.(\d+))?(.*)/ 168 | if (semver.find()) { 169 | if (semver[0][3]) { 170 | env.SEMVER = "${semver[0][1]}.${semver[0][2]}.${semver[0][3]}" 171 | } else if (!semver[0][3] && !semver[0][4]) { 172 | env.SEMVER = "${semver[0][1]}.${semver[0][2]}.${(new Date()).format('YYYYMMdd')}" 173 | } 174 | } 175 | } 176 | 177 | if (env.SEMVER != null) { 178 | if (BRANCH_NAME != "${env.GH_DEFAULT_BRANCH}") { 179 | env.SEMVER = "${env.SEMVER}-${BRANCH_NAME}" 180 | } 181 | println("SEMVER: ${env.SEMVER}") 182 | } else { 183 | println("No SEMVER detected") 184 | } 185 | 186 | } 187 | } 188 | } 189 | // If this is a main build use live docker endpoints 190 | stage("Set ENV live build"){ 191 | when { 192 | branch "main" 193 | environment name: 'CHANGE_ID', value: '' 194 | } 195 | steps { 196 | script{ 197 | env.IMAGE = env.DOCKERHUB_IMAGE 198 | env.GITHUBIMAGE = 'ghcr.io/' + env.LS_USER + '/' + env.CONTAINER_NAME 199 | env.GITLABIMAGE = 'registry.gitlab.com/linuxserver.io/' + env.LS_REPO + '/' + env.CONTAINER_NAME 200 | env.QUAYIMAGE = 'quay.io/linuxserver.io/' + env.CONTAINER_NAME 201 | if (env.MULTIARCH == 'true') { 202 | env.CI_TAGS = 'amd64-' + env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER + '|riscv64-' + env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER + '|arm64v8-' + env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 203 | } else { 204 | env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 205 | } 206 | env.VERSION_TAG = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 207 | env.META_TAG = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 208 | env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN 209 | env.BUILDCACHE = 'docker.io/lsiodev/buildcache,registry.gitlab.com/linuxserver.io/docker-jenkins-builder/lsiodev-buildcache,ghcr.io/linuxserver/lsiodev-buildcache,quay.io/linuxserver.io/lsiodev-buildcache' 210 | } 211 | } 212 | } 213 | // If this is a dev build use dev docker endpoints 214 | stage("Set ENV dev build"){ 215 | when { 216 | not {branch "main"} 217 | environment name: 'CHANGE_ID', value: '' 218 | } 219 | steps { 220 | script{ 221 | env.IMAGE = env.DEV_DOCKERHUB_IMAGE 222 | env.GITHUBIMAGE = 'ghcr.io/' + env.LS_USER + '/lsiodev-' + env.CONTAINER_NAME 223 | env.GITLABIMAGE = 'registry.gitlab.com/linuxserver.io/' + env.LS_REPO + '/lsiodev-' + env.CONTAINER_NAME 224 | env.QUAYIMAGE = 'quay.io/linuxserver.io/lsiodev-' + env.CONTAINER_NAME 225 | if (env.MULTIARCH == 'true') { 226 | env.CI_TAGS = 'amd64-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '|riscv64-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '|arm64v8-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA 227 | } else { 228 | env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA 229 | } 230 | env.VERSION_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA 231 | env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA 232 | env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN 233 | env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DEV_DOCKERHUB_IMAGE + '/tags/' 234 | env.BUILDCACHE = 'docker.io/lsiodev/buildcache,registry.gitlab.com/linuxserver.io/docker-jenkins-builder/lsiodev-buildcache,ghcr.io/linuxserver/lsiodev-buildcache,quay.io/linuxserver.io/lsiodev-buildcache' 235 | } 236 | } 237 | } 238 | // If this is a pull request build use dev docker endpoints 239 | stage("Set ENV PR build"){ 240 | when { 241 | not {environment name: 'CHANGE_ID', value: ''} 242 | } 243 | steps { 244 | script{ 245 | env.IMAGE = env.PR_DOCKERHUB_IMAGE 246 | env.GITHUBIMAGE = 'ghcr.io/' + env.LS_USER + '/lspipepr-' + env.CONTAINER_NAME 247 | env.GITLABIMAGE = 'registry.gitlab.com/linuxserver.io/' + env.LS_REPO + '/lspipepr-' + env.CONTAINER_NAME 248 | env.QUAYIMAGE = 'quay.io/linuxserver.io/lspipepr-' + env.CONTAINER_NAME 249 | if (env.MULTIARCH == 'true') { 250 | env.CI_TAGS = 'amd64-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST + '|riscv64-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST + '|arm64v8-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST 251 | } else { 252 | env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST 253 | } 254 | env.VERSION_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST 255 | env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST 256 | env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN 257 | env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/pull/' + env.PULL_REQUEST 258 | env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.PR_DOCKERHUB_IMAGE + '/tags/' 259 | env.BUILDCACHE = 'docker.io/lsiodev/buildcache,registry.gitlab.com/linuxserver.io/docker-jenkins-builder/lsiodev-buildcache,ghcr.io/linuxserver/lsiodev-buildcache,quay.io/linuxserver.io/lsiodev-buildcache' 260 | } 261 | } 262 | } 263 | // Run ShellCheck 264 | stage('ShellCheck') { 265 | when { 266 | environment name: 'CI', value: 'true' 267 | } 268 | steps { 269 | withCredentials([ 270 | string(credentialsId: 'ci-tests-s3-key-id', variable: 'S3_KEY'), 271 | string(credentialsId: 'ci-tests-s3-secret-access-key', variable: 'S3_SECRET') 272 | ]) { 273 | script{ 274 | env.SHELLCHECK_URL = 'https://ci-tests.linuxserver.io/' + env.IMAGE + '/' + env.META_TAG + '/shellcheck-result.xml' 275 | } 276 | sh '''curl -sL https://raw.githubusercontent.com/linuxserver/docker-jenkins-builder/master/checkrun.sh | /bin/bash''' 277 | sh '''#! /bin/bash 278 | docker run --rm \ 279 | -v ${WORKSPACE}:/mnt \ 280 | -e AWS_ACCESS_KEY_ID=\"${S3_KEY}\" \ 281 | -e AWS_SECRET_ACCESS_KEY=\"${S3_SECRET}\" \ 282 | ghcr.io/linuxserver/baseimage-alpine:3.20 s6-envdir -fn -- /var/run/s6/container_environment /bin/bash -c "\ 283 | apk add --no-cache python3 && \ 284 | python3 -m venv /lsiopy && \ 285 | pip install --no-cache-dir -U pip && \ 286 | pip install --no-cache-dir s3cmd && \ 287 | s3cmd put --no-preserve --acl-public -m text/xml /mnt/shellcheck-result.xml s3://ci-tests.linuxserver.io/${IMAGE}/${META_TAG}/shellcheck-result.xml" || :''' 288 | } 289 | } 290 | } 291 | // Use helper containers to render templated files 292 | stage('Update-Templates') { 293 | when { 294 | branch "main" 295 | environment name: 'CHANGE_ID', value: '' 296 | expression { 297 | env.CONTAINER_NAME != null 298 | } 299 | } 300 | steps { 301 | sh '''#! /bin/bash 302 | set -e 303 | TEMPDIR=$(mktemp -d) 304 | docker pull ghcr.io/linuxserver/jenkins-builder:latest 305 | # Cloned repo paths for templating: 306 | # ${TEMPDIR}/docker-${CONTAINER_NAME}: Cloned branch main of ${LS_USER}/${LS_REPO} for running the jenkins builder on 307 | # ${TEMPDIR}/repo/${LS_REPO}: Cloned branch main of ${LS_USER}/${LS_REPO} for commiting various templated file changes and pushing back to Github 308 | # ${TEMPDIR}/docs/docker-documentation: Cloned docs repo for pushing docs updates to Github 309 | # ${TEMPDIR}/unraid/docker-templates: Cloned docker-templates repo to check for logos 310 | # ${TEMPDIR}/unraid/templates: Cloned templates repo for commiting unraid template changes and pushing back to Github 311 | git clone --branch main --depth 1 https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/docker-${CONTAINER_NAME} 312 | docker run --rm -v ${TEMPDIR}/docker-${CONTAINER_NAME}:/tmp -e LOCAL=true -e PUID=$(id -u) -e PGID=$(id -g) ghcr.io/linuxserver/jenkins-builder:latest 313 | echo "Starting Stage 1 - Jenkinsfile update" 314 | if [[ "$(md5sum Jenkinsfile | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/Jenkinsfile | awk '{ print $1 }')" ]]; then 315 | mkdir -p ${TEMPDIR}/repo 316 | git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO} 317 | cd ${TEMPDIR}/repo/${LS_REPO} 318 | git checkout -f main 319 | cp ${TEMPDIR}/docker-${CONTAINER_NAME}/Jenkinsfile ${TEMPDIR}/repo/${LS_REPO}/ 320 | git add Jenkinsfile 321 | git commit -m 'Bot Updating Templated Files' 322 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 323 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 324 | echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 325 | echo "Updating Jenkinsfile and exiting build, new one will trigger based on commit" 326 | rm -Rf ${TEMPDIR} 327 | exit 0 328 | else 329 | echo "Jenkinsfile is up to date." 330 | fi 331 | echo "Starting Stage 2 - Delete old templates" 332 | OLD_TEMPLATES=".github/ISSUE_TEMPLATE.md .github/ISSUE_TEMPLATE/issue.bug.md .github/ISSUE_TEMPLATE/issue.feature.md .github/workflows/call_invalid_helper.yml .github/workflows/stale.yml .github/workflows/package_trigger.yml" 333 | for i in ${OLD_TEMPLATES}; do 334 | if [[ -f "${i}" ]]; then 335 | TEMPLATES_TO_DELETE="${i} ${TEMPLATES_TO_DELETE}" 336 | fi 337 | done 338 | if [[ -n "${TEMPLATES_TO_DELETE}" ]]; then 339 | mkdir -p ${TEMPDIR}/repo 340 | git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO} 341 | cd ${TEMPDIR}/repo/${LS_REPO} 342 | git checkout -f main 343 | for i in ${TEMPLATES_TO_DELETE}; do 344 | git rm "${i}" 345 | done 346 | git commit -m 'Bot Updating Templated Files' 347 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 348 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 349 | echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 350 | echo "Deleting old/deprecated templates and exiting build, new one will trigger based on commit" 351 | rm -Rf ${TEMPDIR} 352 | exit 0 353 | else 354 | echo "No templates to delete" 355 | fi 356 | echo "Starting Stage 3 - Update templates" 357 | CURRENTHASH=$(grep -hs ^ ${TEMPLATED_FILES} | md5sum | cut -c1-8) 358 | cd ${TEMPDIR}/docker-${CONTAINER_NAME} 359 | NEWHASH=$(grep -hs ^ ${TEMPLATED_FILES} | md5sum | cut -c1-8) 360 | if [[ "${CURRENTHASH}" != "${NEWHASH}" ]] || ! grep -q '.jenkins-external' "${WORKSPACE}/.gitignore" 2>/dev/null; then 361 | mkdir -p ${TEMPDIR}/repo 362 | git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO} 363 | cd ${TEMPDIR}/repo/${LS_REPO} 364 | git checkout -f main 365 | cd ${TEMPDIR}/docker-${CONTAINER_NAME} 366 | mkdir -p ${TEMPDIR}/repo/${LS_REPO}/.github/workflows 367 | mkdir -p ${TEMPDIR}/repo/${LS_REPO}/.github/ISSUE_TEMPLATE 368 | cp --parents ${TEMPLATED_FILES} ${TEMPDIR}/repo/${LS_REPO}/ || : 369 | cp --parents readme-vars.yml ${TEMPDIR}/repo/${LS_REPO}/ || : 370 | cd ${TEMPDIR}/repo/${LS_REPO}/ 371 | if ! grep -q '.jenkins-external' .gitignore 2>/dev/null; then 372 | echo ".jenkins-external" >> .gitignore 373 | git add .gitignore 374 | fi 375 | git add readme-vars.yml ${TEMPLATED_FILES} 376 | git commit -m 'Bot Updating Templated Files' 377 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 378 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 379 | echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 380 | echo "Updating templates and exiting build, new one will trigger based on commit" 381 | rm -Rf ${TEMPDIR} 382 | exit 0 383 | else 384 | echo "false" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 385 | echo "No templates to update" 386 | fi 387 | echo "Starting Stage 4 - External repo updates: Docs, Unraid Template and Readme Sync to Docker Hub" 388 | mkdir -p ${TEMPDIR}/docs 389 | git clone --depth=1 https://github.com/linuxserver/docker-documentation.git ${TEMPDIR}/docs/docker-documentation 390 | if [[ "${BRANCH_NAME}" == "${GH_DEFAULT_BRANCH}" ]] && [[ (! -f ${TEMPDIR}/docs/docker-documentation/docs/images/docker-${CONTAINER_NAME}.md) || ("$(md5sum ${TEMPDIR}/docs/docker-documentation/docs/images/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')") ]]; then 391 | cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md ${TEMPDIR}/docs/docker-documentation/docs/images/ 392 | cd ${TEMPDIR}/docs/docker-documentation 393 | GH_DOCS_DEFAULT_BRANCH=$(git remote show origin | grep "HEAD branch:" | sed 's|.*HEAD branch: ||') 394 | git add docs/images/docker-${CONTAINER_NAME}.md 395 | echo "Updating docs repo" 396 | git commit -m 'Bot Updating Documentation' 397 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH} --rebase 398 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH} || \ 399 | (MAXWAIT="10" && echo "Push to docs failed, trying again in ${MAXWAIT} seconds" && \ 400 | sleep $((RANDOM % MAXWAIT)) && \ 401 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH} --rebase && \ 402 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH}) 403 | else 404 | echo "Docs update not needed, skipping" 405 | fi 406 | if [[ "${BRANCH_NAME}" == "${GH_DEFAULT_BRANCH}" ]]; then 407 | if [[ $(cat ${TEMPDIR}/docker-${CONTAINER_NAME}/README.md | wc -m) -gt 25000 ]]; then 408 | echo "Readme is longer than 25,000 characters. Syncing the lite version to Docker Hub" 409 | DH_README_SYNC_PATH="${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/README.lite" 410 | else 411 | echo "Syncing readme to Docker Hub" 412 | DH_README_SYNC_PATH="${TEMPDIR}/docker-${CONTAINER_NAME}/README.md" 413 | fi 414 | if curl -s https://hub.docker.com/v2/namespaces/${DOCKERHUB_IMAGE%%/*}/repositories/${DOCKERHUB_IMAGE##*/}/tags | jq -r '.message' | grep -q 404; then 415 | echo "Docker Hub endpoint doesn't exist. Creating endpoint first." 416 | DH_TOKEN=$(curl -d '{"username":"linuxserverci", "password":"'${DOCKERHUB_TOKEN}'"}' -H "Content-Type: application/json" -X POST https://hub.docker.com/v2/users/login | jq -r '.token') 417 | curl -s \ 418 | -H "Authorization: JWT ${DH_TOKEN}" \ 419 | -H "Content-Type: application/json" \ 420 | -X POST \ 421 | -d '{"name":"'${DOCKERHUB_IMAGE##*/}'", "namespace":"'${DOCKERHUB_IMAGE%%/*}'"}' \ 422 | https://hub.docker.com/v2/repositories/ || : 423 | fi 424 | DH_TOKEN=$(curl -d '{"username":"linuxserverci", "password":"'${DOCKERHUB_TOKEN}'"}' -H "Content-Type: application/json" -X POST https://hub.docker.com/v2/users/login | jq -r '.token') 425 | curl -s \ 426 | -H "Authorization: JWT ${DH_TOKEN}" \ 427 | -H "Content-Type: application/json" \ 428 | -X PATCH \ 429 | -d "{\\"full_description\\":$(jq -Rsa . ${DH_README_SYNC_PATH})}" \ 430 | https://hub.docker.com/v2/repositories/${DOCKERHUB_IMAGE} || : 431 | else 432 | echo "Not the default Github branch. Skipping readme sync to Docker Hub." 433 | fi 434 | rm -Rf ${TEMPDIR}''' 435 | script{ 436 | env.FILES_UPDATED = sh( 437 | script: '''cat /tmp/${COMMIT_SHA}-${BUILD_NUMBER}''', 438 | returnStdout: true).trim() 439 | } 440 | } 441 | } 442 | // Exit the build if the Templated files were just updated 443 | stage('Template-exit') { 444 | when { 445 | branch "main" 446 | environment name: 'CHANGE_ID', value: '' 447 | environment name: 'FILES_UPDATED', value: 'true' 448 | expression { 449 | env.CONTAINER_NAME != null 450 | } 451 | } 452 | steps { 453 | script{ 454 | env.EXIT_STATUS = 'ABORTED' 455 | } 456 | } 457 | } 458 | // If this is a main build check the S6 service file perms 459 | stage("Check S6 Service file Permissions"){ 460 | when { 461 | branch "main" 462 | environment name: 'CHANGE_ID', value: '' 463 | environment name: 'EXIT_STATUS', value: '' 464 | } 465 | steps { 466 | script{ 467 | sh '''#! /bin/bash 468 | WRONG_PERM=$(find ./ -path "./.git" -prune -o \$ -name "run" -o -name "finish" -o -name "check" \$ -not -perm -u=x,g=x,o=x -print) 469 | if [[ -n "${WRONG_PERM}" ]]; then 470 | echo "The following S6 service files are missing the executable bit; canceling the faulty build: ${WRONG_PERM}" 471 | exit 1 472 | else 473 | echo "S6 service file perms look good." 474 | fi ''' 475 | } 476 | } 477 | } 478 | /* ####################### 479 | GitLab Mirroring and Quay.io Repo Visibility 480 | ####################### */ 481 | // Ping into Gitlab to mirror this repo and have a registry endpoint & mark this repo on Quay.io as public 482 | stage("GitLab Mirror and Quay.io Visibility"){ 483 | when { 484 | environment name: 'EXIT_STATUS', value: '' 485 | } 486 | steps{ 487 | sh '''curl -H "Content-Type: application/json" -H "Private-Token: ${GITLAB_TOKEN}" -X POST https://gitlab.com/api/v4/projects \ 488 | -d '{"namespace_id":'${GITLAB_NAMESPACE}',\ 489 | "name":"'${LS_REPO}'", 490 | "mirror":true,\ 491 | "import_url":"https://github.com/linuxserver/'${LS_REPO}'.git",\ 492 | "issues_access_level":"disabled",\ 493 | "merge_requests_access_level":"disabled",\ 494 | "repository_access_level":"enabled",\ 495 | "visibility":"public"}' ''' 496 | sh '''curl -H "Private-Token: ${GITLAB_TOKEN}" -X PUT "https://gitlab.com/api/v4/projects/Linuxserver.io%2F${LS_REPO}" \ 497 | -d "mirror=true&import_url=https://github.com/linuxserver/${LS_REPO}.git" ''' 498 | sh '''curl -H "Content-Type: application/json" -H "Authorization: Bearer ${QUAYIO_API_TOKEN}" -X POST "https://quay.io/api/v1/repository${QUAYIMAGE/quay.io/}/changevisibility" \ 499 | -d '{"visibility":"public"}' ||: ''' 500 | } 501 | } 502 | /* ############### 503 | Build Container 504 | ############### */ 505 | // Build Docker container for push to LS Repo 506 | stage('Build-Single') { 507 | when { 508 | expression { 509 | env.MULTIARCH == 'false' || params.PACKAGE_CHECK == 'true' 510 | } 511 | environment name: 'EXIT_STATUS', value: '' 512 | } 513 | steps { 514 | echo "Running on node: ${NODE_NAME}" 515 | sh "sed -r -i 's|(^FROM .*)|\\1\\n\\nENV LSIO_FIRST_PARTY=true|g' Dockerfile" 516 | sh "docker buildx build \ 517 | --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ 518 | --label \"org.opencontainers.image.authors=linuxserver.io\" \ 519 | --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-socket-proxy/packages\" \ 520 | --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-socket-proxy\" \ 521 | --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-socket-proxy\" \ 522 | --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ 523 | --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ 524 | --label \"org.opencontainers.image.vendor=linuxserver.io\" \ 525 | --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ 526 | --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ 527 | --label \"org.opencontainers.image.title=Socket-proxy\" \ 528 | --label \"org.opencontainers.image.description=The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it.\" \ 529 | --no-cache --pull -t ${IMAGE}:${META_TAG} --platform=linux/amd64 \ 530 | --provenance=true --sbom=true --builder=container --load \ 531 | --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." 532 | sh '''#! /bin/bash 533 | set -e 534 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 535 | for i in "${CACHE[@]}"; do 536 | docker tag ${IMAGE}:${META_TAG} ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 537 | done 538 | ''' 539 | withCredentials([ 540 | [ 541 | $class: 'UsernamePasswordMultiBinding', 542 | credentialsId: 'Quay.io-Robot', 543 | usernameVariable: 'QUAYUSER', 544 | passwordVariable: 'QUAYPASS' 545 | ] 546 | ]) { 547 | retry_backoff(5,5) { 548 | sh '''#! /bin/bash 549 | set -e 550 | echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin 551 | echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin 552 | echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin 553 | echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin 554 | if [[ "${PACKAGE_CHECK}" != "true" ]]; then 555 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 556 | for i in "${CACHE[@]}"; do 557 | docker push ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} & 558 | done 559 | for p in $(jobs -p); do 560 | wait "$p" || { echo "job $p failed" >&2; exit 1; } 561 | done 562 | fi 563 | ''' 564 | } 565 | } 566 | } 567 | } 568 | // Build MultiArch Docker containers for push to LS Repo 569 | stage('Build-Multi') { 570 | when { 571 | allOf { 572 | environment name: 'MULTIARCH', value: 'true' 573 | expression { params.PACKAGE_CHECK == 'false' } 574 | } 575 | environment name: 'EXIT_STATUS', value: '' 576 | } 577 | parallel { 578 | stage('Build X86') { 579 | steps { 580 | echo "Running on node: ${NODE_NAME}" 581 | sh "sed -r -i 's|(^FROM .*)|\\1\\n\\nENV LSIO_FIRST_PARTY=true|g' Dockerfile" 582 | sh "docker buildx build \ 583 | --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ 584 | --label \"org.opencontainers.image.authors=linuxserver.io\" \ 585 | --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-socket-proxy/packages\" \ 586 | --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-socket-proxy\" \ 587 | --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-socket-proxy\" \ 588 | --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ 589 | --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ 590 | --label \"org.opencontainers.image.vendor=linuxserver.io\" \ 591 | --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ 592 | --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ 593 | --label \"org.opencontainers.image.title=Socket-proxy\" \ 594 | --label \"org.opencontainers.image.description=The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it.\" \ 595 | --no-cache --pull -t ${IMAGE}:amd64-${META_TAG} --platform=linux/amd64 \ 596 | --provenance=true --sbom=true --builder=container --load \ 597 | --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." 598 | sh '''#! /bin/bash 599 | set -e 600 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 601 | for i in "${CACHE[@]}"; do 602 | docker tag ${IMAGE}:amd64-${META_TAG} ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 603 | done 604 | ''' 605 | withCredentials([ 606 | [ 607 | $class: 'UsernamePasswordMultiBinding', 608 | credentialsId: 'Quay.io-Robot', 609 | usernameVariable: 'QUAYUSER', 610 | passwordVariable: 'QUAYPASS' 611 | ] 612 | ]) { 613 | retry_backoff(5,5) { 614 | sh '''#! /bin/bash 615 | set -e 616 | echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin 617 | echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin 618 | echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin 619 | echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin 620 | if [[ "${PACKAGE_CHECK}" != "true" ]]; then 621 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 622 | for i in "${CACHE[@]}"; do 623 | docker push ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} & 624 | done 625 | for p in $(jobs -p); do 626 | wait "$p" || { echo "job $p failed" >&2; exit 1; } 627 | done 628 | fi 629 | ''' 630 | } 631 | } 632 | } 633 | } 634 | stage('Build ARM64') { 635 | agent { 636 | label 'ARM64' 637 | } 638 | steps { 639 | echo "Running on node: ${NODE_NAME}" 640 | sh "sed -r -i 's|(^FROM .*)|\\1\\n\\nENV LSIO_FIRST_PARTY=true|g' Dockerfile.aarch64" 641 | sh "docker buildx build \ 642 | --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ 643 | --label \"org.opencontainers.image.authors=linuxserver.io\" \ 644 | --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-socket-proxy/packages\" \ 645 | --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-socket-proxy\" \ 646 | --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-socket-proxy\" \ 647 | --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ 648 | --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ 649 | --label \"org.opencontainers.image.vendor=linuxserver.io\" \ 650 | --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ 651 | --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ 652 | --label \"org.opencontainers.image.title=Socket-proxy\" \ 653 | --label \"org.opencontainers.image.description=The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it.\" \ 654 | --no-cache --pull -f Dockerfile.aarch64 -t ${IMAGE}:arm64v8-${META_TAG} --platform=linux/arm64 \ 655 | --provenance=true --sbom=true --builder=container --load \ 656 | --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." 657 | sh '''#! /bin/bash 658 | set -e 659 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 660 | for i in "${CACHE[@]}"; do 661 | docker tag ${IMAGE}:arm64v8-${META_TAG} ${i}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} 662 | done 663 | ''' 664 | withCredentials([ 665 | [ 666 | $class: 'UsernamePasswordMultiBinding', 667 | credentialsId: 'Quay.io-Robot', 668 | usernameVariable: 'QUAYUSER', 669 | passwordVariable: 'QUAYPASS' 670 | ] 671 | ]) { 672 | retry_backoff(5,5) { 673 | sh '''#! /bin/bash 674 | set -e 675 | echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin 676 | echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin 677 | echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin 678 | echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin 679 | if [[ "${PACKAGE_CHECK}" != "true" ]]; then 680 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 681 | for i in "${CACHE[@]}"; do 682 | docker push ${i}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} & 683 | done 684 | for p in $(jobs -p); do 685 | wait "$p" || { echo "job $p failed" >&2; exit 1; } 686 | done 687 | fi 688 | ''' 689 | } 690 | } 691 | sh '''#! /bin/bash 692 | containers=$(docker ps -aq) 693 | if [[ -n "${containers}" ]]; then 694 | docker stop ${containers} 695 | fi 696 | docker system prune -f --volumes || : 697 | docker image prune -af || : 698 | ''' 699 | } 700 | } 701 | stage('Build RISCV64') { 702 | agent { 703 | label 'RISCV64' 704 | } 705 | steps { 706 | echo "Running on node: ${NODE_NAME}" 707 | sh "sed -r -i 's|(^FROM .*)|\\1\\n\\nENV LSIO_FIRST_PARTY=true|g' Dockerfile.riscv64" 708 | sh "docker buildx build \ 709 | --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ 710 | --label \"org.opencontainers.image.authors=linuxserver.io\" \ 711 | --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-socket-proxy/packages\" \ 712 | --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-socket-proxy\" \ 713 | --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-socket-proxy\" \ 714 | --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ 715 | --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ 716 | --label \"org.opencontainers.image.vendor=linuxserver.io\" \ 717 | --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ 718 | --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ 719 | --label \"org.opencontainers.image.title=Socket-proxy\" \ 720 | --label \"org.opencontainers.image.description=The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it.\" \ 721 | --no-cache --pull -f Dockerfile.riscv64 -t ${IMAGE}:riscv64-${META_TAG} --platform=linux/riscv64 \ 722 | --provenance=true --sbom=true --builder=container --load \ 723 | --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." 724 | sh '''#! /bin/bash 725 | set -e 726 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 727 | for i in "${CACHE[@]}"; do 728 | docker tag ${IMAGE}:riscv64-${META_TAG} ${i}:riscv64-${COMMIT_SHA}-${BUILD_NUMBER} 729 | done 730 | ''' 731 | withCredentials([ 732 | [ 733 | $class: 'UsernamePasswordMultiBinding', 734 | credentialsId: 'Quay.io-Robot', 735 | usernameVariable: 'QUAYUSER', 736 | passwordVariable: 'QUAYPASS' 737 | ] 738 | ]) { 739 | retry_backoff(5,5) { 740 | sh '''#! /bin/bash 741 | set -e 742 | echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin 743 | echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin 744 | echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin 745 | echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin 746 | if [[ "${PACKAGE_CHECK}" != "true" ]]; then 747 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 748 | for i in "${CACHE[@]}"; do 749 | docker push ${i}:riscv64-${COMMIT_SHA}-${BUILD_NUMBER} & 750 | done 751 | for p in $(jobs -p); do 752 | wait "$p" || { echo "job $p failed" >&2; exit 1; } 753 | done 754 | fi 755 | ''' 756 | } 757 | } 758 | sh '''#! /bin/bash 759 | containers=$(docker ps -aq) 760 | if [[ -n "${containers}" ]]; then 761 | docker stop ${containers} 762 | fi 763 | docker system prune -f --volumes || : 764 | docker image prune -af || : 765 | ''' 766 | } 767 | } 768 | } 769 | } 770 | // Take the image we just built and dump package versions for comparison 771 | stage('Update-packages') { 772 | when { 773 | branch "main" 774 | environment name: 'CHANGE_ID', value: '' 775 | environment name: 'EXIT_STATUS', value: '' 776 | } 777 | steps { 778 | sh '''#! /bin/bash 779 | set -e 780 | TEMPDIR=$(mktemp -d) 781 | if [ "${MULTIARCH}" == "true" ] && [ "${PACKAGE_CHECK}" != "true" ]; then 782 | LOCAL_CONTAINER=${IMAGE}:amd64-${META_TAG} 783 | else 784 | LOCAL_CONTAINER=${IMAGE}:${META_TAG} 785 | fi 786 | touch ${TEMPDIR}/package_versions.txt 787 | docker run --rm \ 788 | -v /var/run/docker.sock:/var/run/docker.sock:ro \ 789 | -v ${TEMPDIR}:/tmp \ 790 | ghcr.io/anchore/syft:latest \ 791 | ${LOCAL_CONTAINER} -o table=/tmp/package_versions.txt 792 | NEW_PACKAGE_TAG=$(md5sum ${TEMPDIR}/package_versions.txt | cut -c1-8 ) 793 | echo "Package tag sha from current packages in buit container is ${NEW_PACKAGE_TAG} comparing to old ${PACKAGE_TAG} from github" 794 | if [ "${NEW_PACKAGE_TAG}" != "${PACKAGE_TAG}" ]; then 795 | git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/${LS_REPO} 796 | git --git-dir ${TEMPDIR}/${LS_REPO}/.git checkout -f main 797 | cp ${TEMPDIR}/package_versions.txt ${TEMPDIR}/${LS_REPO}/ 798 | cd ${TEMPDIR}/${LS_REPO}/ 799 | wait 800 | git add package_versions.txt 801 | git commit -m 'Bot Updating Package Versions' 802 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 803 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 804 | echo "true" > /tmp/packages-${COMMIT_SHA}-${BUILD_NUMBER} 805 | echo "Package tag updated, stopping build process" 806 | else 807 | echo "false" > /tmp/packages-${COMMIT_SHA}-${BUILD_NUMBER} 808 | echo "Package tag is same as previous continue with build process" 809 | fi 810 | rm -Rf ${TEMPDIR}''' 811 | script{ 812 | env.PACKAGE_UPDATED = sh( 813 | script: '''cat /tmp/packages-${COMMIT_SHA}-${BUILD_NUMBER}''', 814 | returnStdout: true).trim() 815 | } 816 | } 817 | } 818 | // Exit the build if the package file was just updated 819 | stage('PACKAGE-exit') { 820 | when { 821 | branch "main" 822 | environment name: 'CHANGE_ID', value: '' 823 | environment name: 'PACKAGE_UPDATED', value: 'true' 824 | environment name: 'EXIT_STATUS', value: '' 825 | } 826 | steps { 827 | script{ 828 | env.EXIT_STATUS = 'ABORTED' 829 | } 830 | } 831 | } 832 | // Exit the build if this is just a package check and there are no changes to push 833 | stage('PACKAGECHECK-exit') { 834 | when { 835 | branch "main" 836 | environment name: 'CHANGE_ID', value: '' 837 | environment name: 'PACKAGE_UPDATED', value: 'false' 838 | environment name: 'EXIT_STATUS', value: '' 839 | expression { 840 | params.PACKAGE_CHECK == 'true' 841 | } 842 | } 843 | steps { 844 | script{ 845 | env.EXIT_STATUS = 'ABORTED' 846 | } 847 | } 848 | } 849 | /* ####### 850 | Testing 851 | ####### */ 852 | // Run Container tests 853 | stage('Test') { 854 | when { 855 | environment name: 'CI', value: 'true' 856 | environment name: 'EXIT_STATUS', value: '' 857 | } 858 | steps { 859 | withCredentials([ 860 | string(credentialsId: 'ci-tests-s3-key-id', variable: 'S3_KEY'), 861 | string(credentialsId: 'ci-tests-s3-secret-access-key ', variable: 'S3_SECRET') 862 | ]) { 863 | script{ 864 | env.CI_URL = 'https://ci-tests.linuxserver.io/' + env.IMAGE + '/' + env.META_TAG + '/index.html' 865 | env.CI_JSON_URL = 'https://ci-tests.linuxserver.io/' + env.IMAGE + '/' + env.META_TAG + '/report.json' 866 | } 867 | sh '''#! /bin/bash 868 | set -e 869 | if grep -q 'docker-baseimage' <<< "${LS_REPO}"; then 870 | echo "Detected baseimage, setting LSIO_FIRST_PARTY=true" 871 | if [ -n "${CI_DOCKERENV}" ]; then 872 | CI_DOCKERENV="LSIO_FIRST_PARTY=true|${CI_DOCKERENV}" 873 | else 874 | CI_DOCKERENV="LSIO_FIRST_PARTY=true" 875 | fi 876 | fi 877 | docker pull ghcr.io/linuxserver/ci:latest 878 | if [ "${MULTIARCH}" == "true" ]; then 879 | docker pull ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} --platform=arm64 880 | docker tag ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} ${IMAGE}:arm64v8-${META_TAG} 881 | docker pull ghcr.io/linuxserver/lsiodev-buildcache:riscv64-${COMMIT_SHA}-${BUILD_NUMBER} --platform=riscv64 882 | docker tag ghcr.io/linuxserver/lsiodev-buildcache:riscv64-${COMMIT_SHA}-${BUILD_NUMBER} ${IMAGE}:riscv64-${META_TAG} 883 | fi 884 | docker run --rm \ 885 | --shm-size=1gb \ 886 | -v /var/run/docker.sock:/var/run/docker.sock \ 887 | -e IMAGE=\"${IMAGE}\" \ 888 | -e DOCKER_LOGS_TIMEOUT=\"${CI_DELAY}\" \ 889 | -e TAGS=\"${CI_TAGS}\" \ 890 | -e META_TAG=\"${META_TAG}\" \ 891 | -e RELEASE_TAG=\"latest\" \ 892 | -e PORT=\"${CI_PORT}\" \ 893 | -e SSL=\"${CI_SSL}\" \ 894 | -e BASE=\"${DIST_IMAGE}\" \ 895 | -e SECRET_KEY=\"${S3_SECRET}\" \ 896 | -e ACCESS_KEY=\"${S3_KEY}\" \ 897 | -e DOCKER_ENV=\"${CI_DOCKERENV}\" \ 898 | -e WEB_SCREENSHOT=\"${CI_WEB}\" \ 899 | -e WEB_AUTH=\"${CI_AUTH}\" \ 900 | -e WEB_PATH=\"${CI_WEBPATH}\" \ 901 | -e NODE_NAME=\"${NODE_NAME}\" \ 902 | -t ghcr.io/linuxserver/ci:latest \ 903 | python3 test_build.py''' 904 | } 905 | } 906 | } 907 | /* ################## 908 | Release Logic 909 | ################## */ 910 | // If this is an amd64 only image only push a single image 911 | stage('Docker-Push-Single') { 912 | when { 913 | environment name: 'MULTIARCH', value: 'false' 914 | environment name: 'EXIT_STATUS', value: '' 915 | } 916 | steps { 917 | retry_backoff(5,5) { 918 | sh '''#! /bin/bash 919 | set -e 920 | for PUSHIMAGE in "${IMAGE}" "${GITLABIMAGE}" "${GITHUBIMAGE}" "${QUAYIMAGE}"; do 921 | [[ ${PUSHIMAGE%%/*} =~ \\. ]] && PUSHIMAGEPLUS="${PUSHIMAGE}" || PUSHIMAGEPLUS="docker.io/${PUSHIMAGE}" 922 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 923 | for i in "${CACHE[@]}"; do 924 | if [[ "${PUSHIMAGEPLUS}" == "$(cut -d "/" -f1 <<< ${i})"* ]]; then 925 | CACHEIMAGE=${i} 926 | fi 927 | done 928 | docker buildx imagetools create --prefer-index=false -t ${PUSHIMAGE}:${META_TAG} -t ${PUSHIMAGE}:latest -t ${PUSHIMAGE}:${EXT_RELEASE_TAG} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 929 | if [ -n "${SEMVER}" ]; then 930 | docker buildx imagetools create --prefer-index=false -t ${PUSHIMAGE}:${SEMVER} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 931 | fi 932 | done 933 | ''' 934 | } 935 | } 936 | } 937 | // If this is a multi arch release push all images and define the manifest 938 | stage('Docker-Push-Multi') { 939 | when { 940 | environment name: 'MULTIARCH', value: 'true' 941 | environment name: 'EXIT_STATUS', value: '' 942 | } 943 | steps { 944 | retry_backoff(5,5) { 945 | sh '''#! /bin/bash 946 | set -e 947 | for MANIFESTIMAGE in "${IMAGE}" "${GITLABIMAGE}" "${GITHUBIMAGE}" "${QUAYIMAGE}"; do 948 | [[ ${MANIFESTIMAGE%%/*} =~ \\. ]] && MANIFESTIMAGEPLUS="${MANIFESTIMAGE}" || MANIFESTIMAGEPLUS="docker.io/${MANIFESTIMAGE}" 949 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 950 | for i in "${CACHE[@]}"; do 951 | if [[ "${MANIFESTIMAGEPLUS}" == "$(cut -d "/" -f1 <<< ${i})"* ]]; then 952 | CACHEIMAGE=${i} 953 | fi 954 | done 955 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:amd64-${META_TAG} -t ${MANIFESTIMAGE}:amd64-latest -t ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 956 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:arm64v8-${META_TAG} -t ${MANIFESTIMAGE}:arm64v8-latest -t ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG} ${CACHEIMAGE}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} 957 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:riscv64-${META_TAG} -t ${MANIFESTIMAGE}:riscv64-latest -t ${MANIFESTIMAGE}:riscv64-${EXT_RELEASE_TAG} ${CACHEIMAGE}:riscv64-${COMMIT_SHA}-${BUILD_NUMBER} 958 | if [ -n "${SEMVER}" ]; then 959 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:amd64-${SEMVER} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 960 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:arm64v8-${SEMVER} ${CACHEIMAGE}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} 961 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:riscv64-${SEMVER} ${CACHEIMAGE}:riscv64-${COMMIT_SHA}-${BUILD_NUMBER} 962 | fi 963 | done 964 | for MANIFESTIMAGE in "${IMAGE}" "${GITLABIMAGE}" "${GITHUBIMAGE}" "${QUAYIMAGE}"; do 965 | docker buildx imagetools create -t ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:amd64-latest ${MANIFESTIMAGE}:riscv64-latest ${MANIFESTIMAGE}:arm64v8-latest 966 | docker buildx imagetools create -t ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:riscv64-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG} 967 | 968 | docker buildx imagetools create -t ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:riscv64-${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG} 969 | if [ -n "${SEMVER}" ]; then 970 | docker buildx imagetools create -t ${MANIFESTIMAGE}:${SEMVER} ${MANIFESTIMAGE}:amd64-${SEMVER} ${MANIFESTIMAGE}:riscv64-${SEMVER} ${MANIFESTIMAGE}:arm64v8-${SEMVER} 971 | fi 972 | done 973 | ''' 974 | } 975 | } 976 | } 977 | // If this is a public release tag it in the LS Github 978 | stage('Github-Tag-Push-Release') { 979 | when { 980 | branch "main" 981 | expression { 982 | env.LS_RELEASE != env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 983 | } 984 | environment name: 'CHANGE_ID', value: '' 985 | environment name: 'EXIT_STATUS', value: '' 986 | } 987 | steps { 988 | echo "Pushing New tag for current commit ${META_TAG}" 989 | sh '''curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/git/tags \ 990 | -d '{"tag":"'${META_TAG}'",\ 991 | "object": "'${COMMIT_SHA}'",\ 992 | "message": "Tagging Release '${EXT_RELEASE_CLEAN}'-ls'${LS_TAG_NUMBER}' to main",\ 993 | "type": "commit",\ 994 | "tagger": {"name": "LinuxServer-CI","email": "ci@linuxserver.io","date": "'${GITHUB_DATE}'"}}' ''' 995 | echo "Pushing New release for Tag" 996 | sh '''#! /bin/bash 997 | echo "Updating external repo packages to ${EXT_RELEASE_CLEAN}" > releasebody.json 998 | echo '{"tag_name":"'${META_TAG}'",\ 999 | "target_commitish": "main",\ 1000 | "name": "'${META_TAG}'",\ 1001 | "body": "**CI Report:**\\n\\n'${CI_URL:-N/A}'\\n\\n**LinuxServer Changes:**\\n\\n'${LS_RELEASE_NOTES}'\\n\\n**Remote Changes:**\\n\\n' > start 1002 | printf '","draft": false,"prerelease": false}' >> releasebody.json 1003 | paste -d'\\0' start releasebody.json > releasebody.json.done 1004 | curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/releases -d @releasebody.json.done''' 1005 | } 1006 | } 1007 | // Add protection to the release branch 1008 | stage('Github-Release-Branch-Protection') { 1009 | when { 1010 | branch "main" 1011 | environment name: 'CHANGE_ID', value: '' 1012 | environment name: 'EXIT_STATUS', value: '' 1013 | } 1014 | steps { 1015 | echo "Setting up protection for release branch main" 1016 | sh '''#! /bin/bash 1017 | curl -H "Authorization: token ${GITHUB_TOKEN}" -X PUT https://api.github.com/repos/${LS_USER}/${LS_REPO}/branches/main/protection \ 1018 | -d $(jq -c . << EOF 1019 | { 1020 | "required_status_checks": null, 1021 | "enforce_admins": false, 1022 | "required_pull_request_reviews": { 1023 | "dismiss_stale_reviews": false, 1024 | "require_code_owner_reviews": false, 1025 | "require_last_push_approval": false, 1026 | "required_approving_review_count": 1 1027 | }, 1028 | "restrictions": null, 1029 | "required_linear_history": false, 1030 | "allow_force_pushes": false, 1031 | "allow_deletions": false, 1032 | "block_creations": false, 1033 | "required_conversation_resolution": true, 1034 | "lock_branch": false, 1035 | "allow_fork_syncing": false, 1036 | "required_signatures": false 1037 | } 1038 | EOF 1039 | ) ''' 1040 | } 1041 | } 1042 | // If this is a Pull request send the CI link as a comment on it 1043 | stage('Pull Request Comment') { 1044 | when { 1045 | not {environment name: 'CHANGE_ID', value: ''} 1046 | environment name: 'EXIT_STATUS', value: '' 1047 | } 1048 | steps { 1049 | sh '''#! /bin/bash 1050 | # Function to retrieve JSON data from URL 1051 | get_json() { 1052 | local url="$1" 1053 | local response=$(curl -s "$url") 1054 | if [ $? -ne 0 ]; then 1055 | echo "Failed to retrieve JSON data from $url" 1056 | return 1 1057 | fi 1058 | local json=$(echo "$response" | jq .) 1059 | if [ $? -ne 0 ]; then 1060 | echo "Failed to parse JSON data from $url" 1061 | return 1 1062 | fi 1063 | echo "$json" 1064 | } 1065 | 1066 | build_table() { 1067 | local data="$1" 1068 | 1069 | # Get the keys in the JSON data 1070 | local keys=$(echo "$data" | jq -r 'to_entries | map(.key) | .[]') 1071 | 1072 | # Check if keys are empty 1073 | if [ -z "$keys" ]; then 1074 | echo "JSON report data does not contain any keys or the report does not exist." 1075 | return 1 1076 | fi 1077 | 1078 | # Build table header 1079 | local header="| Tag | Passed |\\n| --- | --- |\\n" 1080 | 1081 | # Loop through the JSON data to build the table rows 1082 | local rows="" 1083 | for build in $keys; do 1084 | local status=$(echo "$data" | jq -r ".[\\"$build\\"].test_success") 1085 | if [ "$status" = "true" ]; then 1086 | status="✅" 1087 | else 1088 | status="❌" 1089 | fi 1090 | local row="| "$build" | "$status" |\\n" 1091 | rows="${rows}${row}" 1092 | done 1093 | 1094 | local table="${header}${rows}" 1095 | local escaped_table=$(echo "$table" | sed 's/\"/\\\\"/g') 1096 | echo "$escaped_table" 1097 | } 1098 | 1099 | if [[ "${CI}" = "true" ]]; then 1100 | # Retrieve JSON data from URL 1101 | data=$(get_json "$CI_JSON_URL") 1102 | # Create table from JSON data 1103 | table=$(build_table "$data") 1104 | echo -e "$table" 1105 | 1106 | curl -X POST -H "Authorization: token $GITHUB_TOKEN" \ 1107 | -H "Accept: application/vnd.github.v3+json" \ 1108 | "https://api.github.com/repos/$LS_USER/$LS_REPO/issues/$PULL_REQUEST/comments" \ 1109 | -d "{\\"body\\": \\"I am a bot, here are the test results for this PR: \\n${CI_URL}\\n${SHELLCHECK_URL}\\n${table}\\"}" 1110 | else 1111 | curl -X POST -H "Authorization: token $GITHUB_TOKEN" \ 1112 | -H "Accept: application/vnd.github.v3+json" \ 1113 | "https://api.github.com/repos/$LS_USER/$LS_REPO/issues/$PULL_REQUEST/comments" \ 1114 | -d "{\\"body\\": \\"I am a bot, here is the pushed image/manifest for this PR: \\n\\n\\`${GITHUBIMAGE}:${META_TAG}\\`\\"}" 1115 | fi 1116 | ''' 1117 | 1118 | } 1119 | } 1120 | } 1121 | /* ###################### 1122 | Send status to Discord 1123 | ###################### */ 1124 | post { 1125 | always { 1126 | sh '''#!/bin/bash 1127 | rm -rf /config/.ssh/id_sign 1128 | rm -rf /config/.ssh/id_sign.pub 1129 | git config --global --unset gpg.format 1130 | git config --global --unset user.signingkey 1131 | git config --global --unset commit.gpgsign 1132 | ''' 1133 | script{ 1134 | env.JOB_DATE = sh( 1135 | script: '''date '+%Y-%m-%dT%H:%M:%S%:z' ''', 1136 | returnStdout: true).trim() 1137 | if (env.EXIT_STATUS == "ABORTED"){ 1138 | sh 'echo "build aborted"' 1139 | }else{ 1140 | if (currentBuild.currentResult == "SUCCESS"){ 1141 | if (env.GITHUBIMAGE =~ /lspipepr/){ 1142 | env.JOB_WEBHOOK_STATUS='Success' 1143 | env.JOB_WEBHOOK_COLOUR=3957028 1144 | env.JOB_WEBHOOK_FOOTER='PR Build' 1145 | }else if (env.GITHUBIMAGE =~ /lsiodev/){ 1146 | env.JOB_WEBHOOK_STATUS='Success' 1147 | env.JOB_WEBHOOK_COLOUR=3957028 1148 | env.JOB_WEBHOOK_FOOTER='Dev Build' 1149 | }else{ 1150 | env.JOB_WEBHOOK_STATUS='Success' 1151 | env.JOB_WEBHOOK_COLOUR=1681177 1152 | env.JOB_WEBHOOK_FOOTER='Live Build' 1153 | } 1154 | }else{ 1155 | if (env.GITHUBIMAGE =~ /lspipepr/){ 1156 | env.JOB_WEBHOOK_STATUS='Failure' 1157 | env.JOB_WEBHOOK_COLOUR=12669523 1158 | env.JOB_WEBHOOK_FOOTER='PR Build' 1159 | }else if (env.GITHUBIMAGE =~ /lsiodev/){ 1160 | env.JOB_WEBHOOK_STATUS='Failure' 1161 | env.JOB_WEBHOOK_COLOUR=12669523 1162 | env.JOB_WEBHOOK_FOOTER='Dev Build' 1163 | }else{ 1164 | env.JOB_WEBHOOK_STATUS='Failure' 1165 | env.JOB_WEBHOOK_COLOUR=16711680 1166 | env.JOB_WEBHOOK_FOOTER='Live Build' 1167 | } 1168 | } 1169 | sh ''' curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/jenkins-avatar.png","embeds": [{"'color'": '${JOB_WEBHOOK_COLOUR}',\ 1170 | "footer": {"text" : "'"${JOB_WEBHOOK_FOOTER}"'"},\ 1171 | "timestamp": "'${JOB_DATE}'",\ 1172 | "description": "**Build:** '${BUILD_NUMBER}'\\n**CI Results:** '${CI_URL}'\\n**ShellCheck Results:** '${SHELLCHECK_URL}'\\n**Status:** '${JOB_WEBHOOK_STATUS}'\\n**Job:** '${RUN_DISPLAY_URL}'\\n**Change:** '${CODE_URL}'\\n**External Release:**: '${RELEASE_LINK}'\\n**DockerHub:** '${DOCKERHUB_LINK}'\\n"}],\ 1173 | "username": "Jenkins"}' ${BUILDS_DISCORD} ''' 1174 | } 1175 | } 1176 | } 1177 | cleanup { 1178 | sh '''#! /bin/bash 1179 | echo "Pruning builder!!" 1180 | docker builder prune -f --builder container || : 1181 | containers=$(docker ps -q) 1182 | if [[ -n "${containers}" ]]; then 1183 | BUILDX_CONTAINER_ID=$(docker ps -qf 'name=buildx_buildkit') 1184 | for container in ${containers}; do 1185 | if [[ "${container}" == "${BUILDX_CONTAINER_ID}" ]]; then 1186 | echo "skipping buildx container in docker stop" 1187 | else 1188 | echo "Stopping container ${container}" 1189 | docker stop ${container} 1190 | fi 1191 | done 1192 | fi 1193 | docker system prune -f --volumes || : 1194 | docker image prune -af || : 1195 | ''' 1196 | cleanWs() 1197 | } 1198 | } 1199 | } 1200 | 1201 | def retry_backoff(int max_attempts, int power_base, Closure c) { 1202 | int n = 0 1203 | while (n < max_attempts) { 1204 | try { 1205 | c() 1206 | return 1207 | } catch (err) { 1208 | if ((n + 1) >= max_attempts) { 1209 | throw err 1210 | } 1211 | sleep(power_base ** n) 1212 | n++ 1213 | } 1214 | } 1215 | return 1216 | } 1217 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> 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 | <one line to give the program's name and a brief idea of what it does.> 635 | Copyright (C) <year> <name of author> 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 <https://www.gnu.org/licenses/>. 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 | <program> Copyright (C) <year> <name of author> 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 | <https://www.gnu.org/licenses/>. 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 | <https://www.gnu.org/licenses/why-not-lgpl.html>. 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |  2 |  3 | [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) 4 | 5 | [![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!") 6 | [![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.") 7 | [![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.") 8 | [![Fleet](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Fleet)](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.") 9 | [![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.") 10 | [![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget") 11 | 12 | The [LinuxServer.io](https://linuxserver.io) team brings you another container release. 13 | 14 | Find us at: 15 | 16 | * [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more! 17 | * [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team. 18 | * [Discourse](https://discourse.linuxserver.io) - post on our community forum. 19 | * [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images. 20 | * [GitHub](https://github.com/linuxserver) - view the source for all of our repositories. 21 | * [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget 22 | 23 | # [linuxserver/socket-proxy](https://github.com/linuxserver/docker-socket-proxy) 24 | 25 | [![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fsocket-proxy?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fsocket-proxy) 26 | [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-socket-proxy) 27 | [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-socket-proxy/releases) 28 | [![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-socket-proxy/packages) 29 | [![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-socket-proxy/container_registry) 30 | [![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/socket-proxy) 31 | [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/socket-proxy) 32 | [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/socket-proxy) 33 | [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-socket-proxy%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-socket-proxy/job/main/) 34 | 35 | The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it. 36 | 37 | ![socket-proxy](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/docker-logo.png) 38 | 39 | ## Supported Architectures 40 | 41 | We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). 42 | 43 | Simply pulling `lscr.io/linuxserver/socket-proxy:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 44 | 45 | The architectures supported by this image are: 46 | 47 | | Architecture | Available | Tag | 48 | | :----: | :----: | ---- | 49 | | x86-64 | ✅ | amd64-\<version tag\> | 50 | | riscv64 | ✅ | riscv64-\<version tag\> | 51 | | arm64 | ✅ | arm64v8-\<version tag\> | 52 | | armhf | ❌ | | 53 | 54 | ## Application Setup 55 | 56 | This container is conceptually based on [https://github.com/Tecnativa/docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy) and as such does not follow our usual container conventions. It *does not* support mods or custom scripts/services, or running as a user other than root (or the docker user in a rootless environment). It is designed to act as a drop-in replacement for the Tecnativa container. 57 | 58 | The container should be run on the same docker network as the service(s) using it. Most containers that would normally connect to a mounted docker.sock can have their endpoint overridden using the `DOCKER_HOST` environment variable if they do not offer the option in their configuration; it should typically be pointed to `tcp://socket-proxy:2375`. 59 | 60 | * Never expose this container's port to a public network. It should be treated the same way you would treat the docker socket or TCP endpoint. 61 | * Revoke access to any API section that you consider your service should not need. 62 | * To see the versions of the API your Docker daemon and client support, use `docker version` and check the `API version`. 63 | * [Read the docs](https://docs.docker.com/engine/api/) for the API version you are using for an explanation of all the available endpoints. 64 | 65 | ## Read-Only Operation 66 | 67 | This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/). 68 | 69 | ## Usage 70 | 71 | To help you get started creating a container from this image you can either use docker compose or the docker cli. 72 | 73 | >[!NOTE] 74 | >Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided. 75 | 76 | ### docker compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) 77 | 78 | ```yaml 79 | --- 80 | services: 81 | socket-proxy: 82 | image: lscr.io/linuxserver/socket-proxy:latest 83 | container_name: socket-proxy 84 | environment: 85 | - ALLOW_START=0 #optional 86 | - ALLOW_STOP=0 #optional 87 | - ALLOW_RESTARTS=0 #optional 88 | - AUTH=0 #optional 89 | - BUILD=0 #optional 90 | - COMMIT=0 #optional 91 | - CONFIGS=0 #optional 92 | - CONTAINERS=0 #optional 93 | - DISABLE_IPV6=0 #optional 94 | - DISTRIBUTION=0 #optional 95 | - EVENTS=1 #optional 96 | - EXEC=0 #optional 97 | - IMAGES=0 #optional 98 | - INFO=0 #optional 99 | - LOG_LEVEL=info #optional 100 | - NETWORKS=0 #optional 101 | - NODES=0 #optional 102 | - PING=1 #optional 103 | - PLUGINS=0 #optional 104 | - POST=0 #optional 105 | - SECRETS=0 #optional 106 | - SERVICES=0 #optional 107 | - SESSION=0 #optional 108 | - SWARM=0 #optional 109 | - SYSTEM=0 #optional 110 | - TASKS=0 #optional 111 | - VERSION=1 #optional 112 | - VOLUMES=0 #optional 113 | volumes: 114 | - /var/run/docker.sock:/var/run/docker.sock:ro 115 | restart: unless-stopped 116 | read_only: true 117 | tmpfs: 118 | - /run 119 | ``` 120 | 121 | ### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) 122 | 123 | ```bash 124 | docker run -d \ 125 | --name=socket-proxy \ 126 | -e ALLOW_START=0 `#optional` \ 127 | -e ALLOW_STOP=0 `#optional` \ 128 | -e ALLOW_RESTARTS=0 `#optional` \ 129 | -e AUTH=0 `#optional` \ 130 | -e BUILD=0 `#optional` \ 131 | -e COMMIT=0 `#optional` \ 132 | -e CONFIGS=0 `#optional` \ 133 | -e CONTAINERS=0 `#optional` \ 134 | -e DISTRIBUTION=0 `#optional` \ 135 | -e DISABLE_IPV6=0 `#optional` \ 136 | -e EVENTS=1 `#optional` \ 137 | -e EXEC=0 `#optional` \ 138 | -e IMAGES=0 `#optional` \ 139 | -e INFO=0 `#optional` \ 140 | -e LOG_LEVEL=info `#optional` \ 141 | -e NETWORKS=0 `#optional` \ 142 | -e NODES=0 `#optional` \ 143 | -e PING=1 `#optional` \ 144 | -e PLUGINS=0 `#optional` \ 145 | -e POST=0 `#optional` \ 146 | -e SECRETS=0 `#optional` \ 147 | -e SERVICES=0 `#optional` \ 148 | -e SESSION=0 `#optional` \ 149 | -e SWARM=0 `#optional` \ 150 | -e SYSTEM=0 `#optional` \ 151 | -e TASKS=0 `#optional` \ 152 | -e VERSION=1 `#optional` \ 153 | -e VOLUMES=0 `#optional` \ 154 | -v /var/run/docker.sock:/var/run/docker.sock:ro \ 155 | --restart unless-stopped \ 156 | --read-only \ 157 | --tmpfs /run \ 158 | lscr.io/linuxserver/socket-proxy:latest 159 | ``` 160 | 161 | ## Parameters 162 | 163 | Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. 164 | 165 | | Parameter | Function | 166 | | :----: | --- | 167 | | `-e ALLOW_START=0` | `/containers/{id}/start` - **This option will work even if `POST=0`** | 168 | | `-e ALLOW_STOP=0` | `/containers/{id}/stop` - **This option will work even if `POST=0`** | 169 | | `-e ALLOW_RESTARTS=0` | `/containers/{id}/stop`, `/containers/{id}/restart`, and `/containers/{id}/kill` - **This option will work even if `POST=0`** | 170 | | `-e AUTH=0` | `/auth` | 171 | | `-e BUILD=0` | `/build` | 172 | | `-e COMMIT=0` | `/commit` | 173 | | `-e CONFIGS=0` | `/configs` | 174 | | `-e CONTAINERS=0` | `/containers` | 175 | | `-e DISTRIBUTION=0` | `/distribution` | 176 | | `-e DISABLE_IPV6=0` | Set to `1` to prevent binding to the IPv6 interface for legacy systems that cannot support IPv6. | 177 | | `-e EVENTS=1` | `/events` | 178 | | `-e EXEC=0` | `/exec` & `/containers/{id}/exec` | 179 | | `-e IMAGES=0` | `/images` | 180 | | `-e INFO=0` | `/info` | 181 | | `-e LOG_LEVEL=info` | Possible values are: debug, info, notice, warning, err, crit, alert and emerg. Defaults to info. | 182 | | `-e NETWORKS=0` | `/networks` | 183 | | `-e NODES=0` | `/nodes` | 184 | | `-e PING=1` | `/_ping` | 185 | | `-e PLUGINS=0` | `/plugins` | 186 | | `-e POST=0` | When set to `0`, only `GET` and `HEAD` operations are allowed, making API access read-only. | 187 | | `-e SECRETS=0` | `/secrets` | 188 | | `-e SERVICES=0` | `/services` | 189 | | `-e SESSION=0` | `/session` | 190 | | `-e SWARM=0` | `/swarm` | 191 | | `-e SYSTEM=0` | `/system` | 192 | | `-e TASKS=0` | `/tasks` | 193 | | `-e VERSION=1` | `/version` | 194 | | `-e VOLUMES=0` | `/volumes` | 195 | | `-v /var/run/docker.sock:ro` | Mount the host docker socket into the container. | 196 | | `--read-only` | Make the container filesystem read-only. | 197 | | `--tmpfs /run` | Mount /run to tmpfs (RAM) to make it writeable. | 198 | 199 | ## Support Info 200 | 201 | * Shell access whilst the container is running: 202 | 203 | ```bash 204 | docker exec -it socket-proxy /bin/sh 205 | ``` 206 | 207 | * To monitor the logs of the container in realtime: 208 | 209 | ```bash 210 | docker logs -f socket-proxy 211 | ``` 212 | 213 | * Container version number: 214 | 215 | ```bash 216 | docker inspect -f '{{ index .Config.Labels "build_version" }}' socket-proxy 217 | ``` 218 | 219 | * Image version number: 220 | 221 | ```bash 222 | docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/socket-proxy:latest 223 | ``` 224 | 225 | ## Updating Info 226 | 227 | Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image. 228 | 229 | Below are the instructions for updating containers: 230 | 231 | ### Via Docker Compose 232 | 233 | * Update images: 234 | * All images: 235 | 236 | ```bash 237 | docker compose pull 238 | ``` 239 | 240 | * Single image: 241 | 242 | ```bash 243 | docker compose pull socket-proxy 244 | ``` 245 | 246 | * Update containers: 247 | * All containers: 248 | 249 | ```bash 250 | docker compose up -d 251 | ``` 252 | 253 | * Single container: 254 | 255 | ```bash 256 | docker compose up -d socket-proxy 257 | ``` 258 | 259 | * You can also remove the old dangling images: 260 | 261 | ```bash 262 | docker image prune 263 | ``` 264 | 265 | ### Via Docker Run 266 | 267 | * Update the image: 268 | 269 | ```bash 270 | docker pull lscr.io/linuxserver/socket-proxy:latest 271 | ``` 272 | 273 | * Stop the running container: 274 | 275 | ```bash 276 | docker stop socket-proxy 277 | ``` 278 | 279 | * Delete the container: 280 | 281 | ```bash 282 | docker rm socket-proxy 283 | ``` 284 | 285 | * You can also remove the old dangling images: 286 | 287 | ```bash 288 | docker image prune 289 | ``` 290 | 291 | ### Image Update Notifications - Diun (Docker Image Update Notifier) 292 | 293 | >[!TIP] 294 | >We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported. 295 | 296 | ## Building locally 297 | 298 | If you want to make local modifications to these images for development purposes or just to customize the logic: 299 | 300 | ```bash 301 | git clone https://github.com/linuxserver/docker-socket-proxy.git 302 | cd docker-socket-proxy 303 | docker build \ 304 | --no-cache \ 305 | --pull \ 306 | -t lscr.io/linuxserver/socket-proxy:latest . 307 | ``` 308 | 309 | The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/docker-qemu-static` 310 | 311 | ```bash 312 | docker run --rm --privileged lscr.io/linuxserver/docker-qemu-static --reset 313 | ``` 314 | 315 | Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`. 316 | 317 | ## Versions 318 | 319 | * **03.06.25:** - Rebase to Alpine 3.22. Add RISCV support. 320 | * **08.04.25:** - Add `LOG_LEVEL` back. 321 | * **06.04.25:** - Switch back to haproxy for better handling of `docker exec` connection hijacking. 322 | * **02.01.25:** - Support custom read timeout values. 323 | * **05.12.24:** - Rebase to Alpine 3.21. 324 | * **26.08.24:** - Change `ALLOW_START`, `ALLOW_STOP`, and `ALLOW_RESTARTS` to work even with `POST=0`. 325 | * **24.05.24:** - Rebase to Alpine 3.20. 326 | * **15.04.24:** - Allow disabling IPv6 support for legacy devices. 327 | * **08.04.24:** - Use nginx due to haproxy's wonky websockets handling. 328 | * **07.04.24:** - Initial Release. 329 | -------------------------------------------------------------------------------- /jenkins-vars.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # jenkins variables 4 | project_name: docker-socket-proxy 5 | external_type: alpine_repo 6 | release_type: stable 7 | release_tag: latest 8 | ls_branch: main 9 | build_riscv64: true 10 | repo_vars: 11 | - BUILD_VERSION_ARG = 'HAPROXY_VERSION' 12 | - LS_USER = 'linuxserver' 13 | - LS_REPO = 'docker-socket-proxy' 14 | - CONTAINER_NAME = 'socket-proxy' 15 | - DOCKERHUB_IMAGE = 'linuxserver/socket-proxy' 16 | - DEV_DOCKERHUB_IMAGE = 'lsiodev/socket-proxy' 17 | - PR_DOCKERHUB_IMAGE = 'lspipepr/socket-proxy' 18 | - DIST_IMAGE = 'alpine' 19 | - DIST_REPO = 'http://dl-cdn.alpinelinux.org/alpine/v3.22/main/' 20 | - DIST_REPO_PACKAGES = 'haproxy' 21 | - MULTIARCH='true' 22 | - CI='true' 23 | - CI_WEB='false' 24 | - CI_PORT='2375' 25 | - CI_SSL='false' 26 | - CI_DELAY='120' 27 | - CI_DOCKERENV='' 28 | - CI_AUTH='' 29 | - CI_WEBPATH='' 30 | -------------------------------------------------------------------------------- /package_versions.txt: -------------------------------------------------------------------------------- 1 | NAME VERSION TYPE 2 | alpine-baselayout 3.7.0-r0 apk 3 | alpine-baselayout-data 3.7.0-r0 apk 4 | alpine-keys 2.5-r0 apk 5 | alpine-release 3.22.0-r0 apk 6 | apk-tools 2.14.9-r2 apk 7 | busybox 1.37.0-r18 apk 8 | busybox-binsh 1.37.0-r18 apk 9 | ca-certificates-bundle 20241121-r2 apk 10 | haproxy 3.0.10-r0 apk 11 | libapk2 2.14.9-r2 apk 12 | libcrypto3 3.5.0-r0 apk 13 | libssl3 3.5.0-r0 apk 14 | lua5.4-libs 5.4.7-r0 apk 15 | musl 1.2.5-r10 apk 16 | musl-utils 1.2.5-r10 apk 17 | pcre2 10.43-r1 apk 18 | scanelf 1.3.8-r1 apk 19 | ssl_client 1.37.0-r18 apk 20 | zlib 1.3.1-r2 apk 21 | -------------------------------------------------------------------------------- /readme-vars.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # project information 4 | project_name: socket-proxy 5 | project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/docker-logo.png" 6 | project_blurb: The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it. 7 | project_categories: "Docker" 8 | full_custom_readme: | 9 | {% raw -%} 10 | [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) 11 | 12 | [![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!") 13 | [![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.") 14 | [![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.") 15 | [![Fleet](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Fleet)](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.") 16 | [![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.") 17 | [![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget") 18 | 19 | The [LinuxServer.io](https://linuxserver.io) team brings you another container release. 20 | 21 | Find us at: 22 | 23 | * [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more! 24 | * [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team. 25 | * [Discourse](https://discourse.linuxserver.io) - post on our community forum. 26 | * [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images. 27 | * [GitHub](https://github.com/linuxserver) - view the source for all of our repositories. 28 | * [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget 29 | 30 | # [linuxserver/socket-proxy](https://github.com/linuxserver/docker-socket-proxy) 31 | 32 | [![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fsocket-proxy?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fsocket-proxy) 33 | [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-socket-proxy) 34 | [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-socket-proxy/releases) 35 | [![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-socket-proxy/packages) 36 | [![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-socket-proxy/container_registry) 37 | [![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/socket-proxy) 38 | [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/socket-proxy) 39 | [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/socket-proxy) 40 | [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-socket-proxy%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-socket-proxy/job/main/) 41 | 42 | The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it. 43 | 44 | ![socket-proxy](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/docker-logo.png) 45 | 46 | ## Supported Architectures 47 | 48 | We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). 49 | 50 | Simply pulling `lscr.io/linuxserver/socket-proxy:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 51 | 52 | The architectures supported by this image are: 53 | 54 | | Architecture | Available | Tag | 55 | | :----: | :----: | ---- | 56 | | x86-64 | ✅ | amd64-\<version tag\> | 57 | | riscv64 | ✅ | riscv64-\<version tag\> | 58 | | arm64 | ✅ | arm64v8-\<version tag\> | 59 | | armhf | ❌ | | 60 | 61 | ## Application Setup 62 | 63 | This container is conceptually based on [https://github.com/Tecnativa/docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy) and as such does not follow our usual container conventions. It *does not* support mods or custom scripts/services, or running as a user other than root (or the docker user in a rootless environment). It is designed to act as a drop-in replacement for the Tecnativa container. 64 | 65 | The container should be run on the same docker network as the service(s) using it. Most containers that would normally connect to a mounted docker.sock can have their endpoint overridden using the `DOCKER_HOST` environment variable if they do not offer the option in their configuration; it should typically be pointed to `tcp://socket-proxy:2375`. 66 | 67 | * Never expose this container's port to a public network. It should be treated the same way you would treat the docker socket or TCP endpoint. 68 | * Revoke access to any API section that you consider your service should not need. 69 | * To see the versions of the API your Docker daemon and client support, use `docker version` and check the `API version`. 70 | * [Read the docs](https://docs.docker.com/engine/api/) for the API version you are using for an explanation of all the available endpoints. 71 | 72 | ## Read-Only Operation 73 | 74 | This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/). 75 | 76 | ## Usage 77 | 78 | To help you get started creating a container from this image you can either use docker compose or the docker cli. 79 | 80 | >[!NOTE] 81 | >Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided. 82 | 83 | ### docker compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) 84 | 85 | ```yaml 86 | --- 87 | services: 88 | socket-proxy: 89 | image: lscr.io/linuxserver/socket-proxy:latest 90 | container_name: socket-proxy 91 | environment: 92 | - ALLOW_START=0 #optional 93 | - ALLOW_STOP=0 #optional 94 | - ALLOW_RESTARTS=0 #optional 95 | - AUTH=0 #optional 96 | - BUILD=0 #optional 97 | - COMMIT=0 #optional 98 | - CONFIGS=0 #optional 99 | - CONTAINERS=0 #optional 100 | - DISABLE_IPV6=0 #optional 101 | - DISTRIBUTION=0 #optional 102 | - EVENTS=1 #optional 103 | - EXEC=0 #optional 104 | - IMAGES=0 #optional 105 | - INFO=0 #optional 106 | - LOG_LEVEL=info #optional 107 | - NETWORKS=0 #optional 108 | - NODES=0 #optional 109 | - PING=1 #optional 110 | - PLUGINS=0 #optional 111 | - POST=0 #optional 112 | - SECRETS=0 #optional 113 | - SERVICES=0 #optional 114 | - SESSION=0 #optional 115 | - SWARM=0 #optional 116 | - SYSTEM=0 #optional 117 | - TASKS=0 #optional 118 | - VERSION=1 #optional 119 | - VOLUMES=0 #optional 120 | volumes: 121 | - /var/run/docker.sock:/var/run/docker.sock:ro 122 | restart: unless-stopped 123 | read_only: true 124 | tmpfs: 125 | - /run 126 | ``` 127 | 128 | ### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) 129 | 130 | ```bash 131 | docker run -d \ 132 | --name=socket-proxy \ 133 | -e ALLOW_START=0 `#optional` \ 134 | -e ALLOW_STOP=0 `#optional` \ 135 | -e ALLOW_RESTARTS=0 `#optional` \ 136 | -e AUTH=0 `#optional` \ 137 | -e BUILD=0 `#optional` \ 138 | -e COMMIT=0 `#optional` \ 139 | -e CONFIGS=0 `#optional` \ 140 | -e CONTAINERS=0 `#optional` \ 141 | -e DISTRIBUTION=0 `#optional` \ 142 | -e DISABLE_IPV6=0 `#optional` \ 143 | -e EVENTS=1 `#optional` \ 144 | -e EXEC=0 `#optional` \ 145 | -e IMAGES=0 `#optional` \ 146 | -e INFO=0 `#optional` \ 147 | -e LOG_LEVEL=info `#optional` \ 148 | -e NETWORKS=0 `#optional` \ 149 | -e NODES=0 `#optional` \ 150 | -e PING=1 `#optional` \ 151 | -e PLUGINS=0 `#optional` \ 152 | -e POST=0 `#optional` \ 153 | -e SECRETS=0 `#optional` \ 154 | -e SERVICES=0 `#optional` \ 155 | -e SESSION=0 `#optional` \ 156 | -e SWARM=0 `#optional` \ 157 | -e SYSTEM=0 `#optional` \ 158 | -e TASKS=0 `#optional` \ 159 | -e VERSION=1 `#optional` \ 160 | -e VOLUMES=0 `#optional` \ 161 | -v /var/run/docker.sock:/var/run/docker.sock:ro \ 162 | --restart unless-stopped \ 163 | --read-only \ 164 | --tmpfs /run \ 165 | lscr.io/linuxserver/socket-proxy:latest 166 | ``` 167 | 168 | ## Parameters 169 | 170 | Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. 171 | 172 | | Parameter | Function | 173 | | :----: | --- | 174 | | `-e ALLOW_START=0` | `/containers/{id}/start` - **This option will work even if `POST=0`** | 175 | | `-e ALLOW_STOP=0` | `/containers/{id}/stop` - **This option will work even if `POST=0`** | 176 | | `-e ALLOW_RESTARTS=0` | `/containers/{id}/stop`, `/containers/{id}/restart`, and `/containers/{id}/kill` - **This option will work even if `POST=0`** | 177 | | `-e AUTH=0` | `/auth` | 178 | | `-e BUILD=0` | `/build` | 179 | | `-e COMMIT=0` | `/commit` | 180 | | `-e CONFIGS=0` | `/configs` | 181 | | `-e CONTAINERS=0` | `/containers` | 182 | | `-e DISTRIBUTION=0` | `/distribution` | 183 | | `-e DISABLE_IPV6=0` | Set to `1` to prevent binding to the IPv6 interface for legacy systems that cannot support IPv6. | 184 | | `-e EVENTS=1` | `/events` | 185 | | `-e EXEC=0` | `/exec` & `/containers/{id}/exec` | 186 | | `-e IMAGES=0` | `/images` | 187 | | `-e INFO=0` | `/info` | 188 | | `-e LOG_LEVEL=info` | Possible values are: debug, info, notice, warning, err, crit, alert and emerg. Defaults to info. | 189 | | `-e NETWORKS=0` | `/networks` | 190 | | `-e NODES=0` | `/nodes` | 191 | | `-e PING=1` | `/_ping` | 192 | | `-e PLUGINS=0` | `/plugins` | 193 | | `-e POST=0` | When set to `0`, only `GET` and `HEAD` operations are allowed, making API access read-only. | 194 | | `-e SECRETS=0` | `/secrets` | 195 | | `-e SERVICES=0` | `/services` | 196 | | `-e SESSION=0` | `/session` | 197 | | `-e SWARM=0` | `/swarm` | 198 | | `-e SYSTEM=0` | `/system` | 199 | | `-e TASKS=0` | `/tasks` | 200 | | `-e VERSION=1` | `/version` | 201 | | `-e VOLUMES=0` | `/volumes` | 202 | | `-v /var/run/docker.sock:ro` | Mount the host docker socket into the container. | 203 | | `--read-only` | Make the container filesystem read-only. | 204 | | `--tmpfs /run` | Mount /run to tmpfs (RAM) to make it writeable. | 205 | 206 | ## Support Info 207 | 208 | * Shell access whilst the container is running: 209 | 210 | ```bash 211 | docker exec -it socket-proxy /bin/sh 212 | ``` 213 | 214 | * To monitor the logs of the container in realtime: 215 | 216 | ```bash 217 | docker logs -f socket-proxy 218 | ``` 219 | 220 | * Container version number: 221 | 222 | ```bash 223 | docker inspect -f '{{ index .Config.Labels "build_version" }}' socket-proxy 224 | ``` 225 | 226 | * Image version number: 227 | 228 | ```bash 229 | docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/socket-proxy:latest 230 | ``` 231 | 232 | ## Updating Info 233 | 234 | Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image. 235 | 236 | Below are the instructions for updating containers: 237 | 238 | ### Via Docker Compose 239 | 240 | * Update images: 241 | * All images: 242 | 243 | ```bash 244 | docker compose pull 245 | ``` 246 | 247 | * Single image: 248 | 249 | ```bash 250 | docker compose pull socket-proxy 251 | ``` 252 | 253 | * Update containers: 254 | * All containers: 255 | 256 | ```bash 257 | docker compose up -d 258 | ``` 259 | 260 | * Single container: 261 | 262 | ```bash 263 | docker compose up -d socket-proxy 264 | ``` 265 | 266 | * You can also remove the old dangling images: 267 | 268 | ```bash 269 | docker image prune 270 | ``` 271 | 272 | ### Via Docker Run 273 | 274 | * Update the image: 275 | 276 | ```bash 277 | docker pull lscr.io/linuxserver/socket-proxy:latest 278 | ``` 279 | 280 | * Stop the running container: 281 | 282 | ```bash 283 | docker stop socket-proxy 284 | ``` 285 | 286 | * Delete the container: 287 | 288 | ```bash 289 | docker rm socket-proxy 290 | ``` 291 | 292 | * You can also remove the old dangling images: 293 | 294 | ```bash 295 | docker image prune 296 | ``` 297 | 298 | ### Image Update Notifications - Diun (Docker Image Update Notifier) 299 | 300 | >[!TIP] 301 | >We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported. 302 | 303 | ## Building locally 304 | 305 | If you want to make local modifications to these images for development purposes or just to customize the logic: 306 | 307 | ```bash 308 | git clone https://github.com/linuxserver/docker-socket-proxy.git 309 | cd docker-socket-proxy 310 | docker build \ 311 | --no-cache \ 312 | --pull \ 313 | -t lscr.io/linuxserver/socket-proxy:latest . 314 | ``` 315 | 316 | The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/docker-qemu-static` 317 | 318 | ```bash 319 | docker run --rm --privileged lscr.io/linuxserver/docker-qemu-static --reset 320 | ``` 321 | 322 | Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`. 323 | 324 | ## Versions 325 | 326 | * **03.06.25:** - Rebase to Alpine 3.22. Add RISCV support. 327 | * **08.04.25:** - Add `LOG_LEVEL` back. 328 | * **06.04.25:** - Switch back to haproxy for better handling of `docker exec` connection hijacking. 329 | * **02.01.25:** - Support custom read timeout values. 330 | * **05.12.24:** - Rebase to Alpine 3.21. 331 | * **26.08.24:** - Change `ALLOW_START`, `ALLOW_STOP`, and `ALLOW_RESTARTS` to work even with `POST=0`. 332 | * **24.05.24:** - Rebase to Alpine 3.20. 333 | * **15.04.24:** - Allow disabling IPv6 support for legacy devices. 334 | * **08.04.24:** - Use nginx due to haproxy's wonky websockets handling. 335 | * **07.04.24:** - Initial Release. 336 | 337 | {%- endraw %} 338 | -------------------------------------------------------------------------------- /root/docker-entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | mkdir -p /run/haproxy 4 | 5 | if [ "${DISABLE_IPV6}" = 1 ]; then 6 | BIND_PROTO=":2375" 7 | else 8 | BIND_PROTO="[::]:2375 v4v6" 9 | fi 10 | 11 | sed "s/@@BIND_PROTO@@/${BIND_PROTO}/g" /templates/haproxy.cfg > /run/haproxy/haproxy.cfg 12 | 13 | echo ' 14 | ─────────────────────────────────────── 15 | 16 | ██╗ ███████╗██╗ ██████╗ 17 | ██║ ██╔════╝██║██╔═══██╗ 18 | ██║ ███████╗██║██║ ██║ 19 | ██║ ╚════██║██║██║ ██║ 20 | ███████╗███████║██║╚██████╔╝ 21 | ╚══════╝╚══════╝╚═╝ ╚═════╝ 22 | 23 | Brought to you by linuxserver.io 24 | ─────────────────────────────────────── 25 | ─────────────────────────────────────── 26 | 27 | To support LSIO projects visit: 28 | https://www.linuxserver.io/donate/ 29 | 30 | ───────────────────────────────────────' 31 | if [ -f /build_version ]; then 32 | cat /build_version 33 | echo ' 34 | ─────────────────────────────────────── 35 | ' 36 | fi 37 | 38 | echo "[ls.io-init] done." 39 | 40 | exec /usr/sbin/haproxy -f /run/haproxy/haproxy.cfg -W -db 41 | -------------------------------------------------------------------------------- /root/templates/haproxy.cfg: -------------------------------------------------------------------------------- 1 | global 2 | log stdout format raw daemon "${LOG_LEVEL}" 3 | pidfile /run/haproxy.pid 4 | maxconn 2000 5 | 6 | defaults 7 | mode http 8 | log global 9 | option httplog 10 | option dontlognull 11 | option http-server-close 12 | option redispatch 13 | retries 3 14 | timeout http-request 10s 15 | timeout queue 1m 16 | timeout connect 10s 17 | timeout client 10m 18 | timeout server 10m 19 | timeout http-keep-alive 10s 20 | timeout check 10s 21 | maxconn 2000 22 | 23 | backend docker 24 | server socket $SOCKET_PATH 25 | 26 | frontend proxy 27 | bind @@BIND_PROTO@@ 28 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/containers/[a-zA-Z0-9_.-]+/((stop)|(restart)|(kill)) } { env(ALLOW_RESTARTS) -m bool } 29 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/containers/[a-zA-Z0-9_.-]+/start } { env(ALLOW_START) -m bool } 30 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/containers/[a-zA-Z0-9_.-]+/stop } { env(ALLOW_STOP) -m bool } 31 | http-request deny unless METH_GET || { env(POST) -m bool } 32 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/auth } { env(AUTH) -m bool } 33 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/build } { env(BUILD) -m bool } 34 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/commit } { env(COMMIT) -m bool } 35 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/configs } { env(CONFIGS) -m bool } 36 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/containers } { env(CONTAINERS) -m bool } 37 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/distribution } { env(DISTRIBUTION) -m bool } 38 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/events } { env(EVENTS) -m bool } 39 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/exec } { env(EXEC) -m bool } 40 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/grpc } { env(GRPC) -m bool } 41 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/images } { env(IMAGES) -m bool } 42 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/info } { env(INFO) -m bool } 43 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/networks } { env(NETWORKS) -m bool } 44 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/nodes } { env(NODES) -m bool } 45 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/_ping } { env(PING) -m bool } 46 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/plugins } { env(PLUGINS) -m bool } 47 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/secrets } { env(SECRETS) -m bool } 48 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/services } { env(SERVICES) -m bool } 49 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/session } { env(SESSION) -m bool } 50 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/swarm } { env(SWARM) -m bool } 51 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/system } { env(SYSTEM) -m bool } 52 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/tasks } { env(TASKS) -m bool } 53 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/version } { env(VERSION) -m bool } 54 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/volumes } { env(VOLUMES) -m bool } 55 | http-request deny 56 | default_backend docker 57 | --------------------------------------------------------------------------------

├── .editorconfig ├── .github ├── CONTRIBUTING.md ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── config.yml │ ├── issue.bug.yml │ └── issue.feature.yml ├── PULL_REQUEST_TEMPLATE.md └── workflows │ ├── call_issue_pr_tracker.yml │ ├── call_issues_cron.yml │ ├── external_trigger.yml │ ├── external_trigger_scheduler.yml │ ├── greetings.yml │ ├── package_trigger_scheduler.yml │ └── permissions.yml ├── .gitignore ├── Dockerfile ├── Dockerfile.aarch64 ├── Dockerfile.riscv64 ├── Jenkinsfile ├── LICENSE ├── README.md ├── jenkins-vars.yml ├── package_versions.txt ├── readme-vars.yml └── root ├── docker-entrypoint.sh └── templates └── haproxy.cfg /.editorconfig: -------------------------------------------------------------------------------- 1 | # This file is globally distributed to all container image projects from 2 | # https://github.com/linuxserver/docker-jenkins-builder/blob/master/.editorconfig 3 | 4 | # top-most EditorConfig file 5 | root = true 6 | 7 | # Unix-style newlines with a newline ending every file 8 | [*] 9 | end_of_line = lf 10 | insert_final_newline = true 11 | # trim_trailing_whitespace may cause unintended issues and should not be globally set true 12 | trim_trailing_whitespace = false 13 | 14 | [{Dockerfile*,**.yml}] 15 | indent_style = space 16 | indent_size = 2 17 | 18 | [{**.sh,root/etc/s6-overlay/s6-rc.d/**,root/etc/cont-init.d/**,root/etc/services.d/**}] 19 | indent_style = space 20 | indent_size = 4 21 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to socket-proxy 2 | 3 | ## Gotchas 4 | 5 | * While contributing make sure to make all your changes before creating a Pull Request, as our pipeline builds each commit after the PR is open. 6 | * Read, and fill the Pull Request template 7 | * If this is a fix for a typo (in code, documentation, or the README) please file an issue and let us sort it out. We do not need a PR 8 | * If the PR is addressing an existing issue include, closes #\, in the body of the PR commit message 9 | * If you want to discuss changes, you can also bring it up in [#dev-talk](https://discordapp.com/channels/354974912613449730/757585807061155840) in our [Discord server](https://linuxserver.io/discord) 10 | 11 | ## Common files 12 | 13 | | File | Use case | 14 | | :----: | --- | 15 | | `Dockerfile` | Dockerfile used to build amd64 images | 16 | | `Dockerfile.aarch64` | Dockerfile used to build 64bit ARM architectures | 17 | | `Dockerfile.armhf` | Dockerfile used to build 32bit ARM architectures | 18 | | `Jenkinsfile` | This file is a product of our builder and should not be edited directly. This is used to build the image | 19 | | `jenkins-vars.yml` | This file is used to generate the `Jenkinsfile` mentioned above, it only affects the build-process | 20 | | `package_versions.txt` | This file is generated as a part of the build-process and should not be edited directly. It lists all the installed packages and their versions | 21 | | `README.md` | This file is a product of our builder and should not be edited directly. This displays the readme for the repository and image registries | 22 | | `readme-vars.yml` | This file is used to generate the `README.md` | 23 | 24 | ## Readme 25 | 26 | If you would like to change our readme, please __**do not**__ directly edit the readme, as it is auto-generated on each commit. 27 | Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-socket-proxy/edit/main/readme-vars.yml). 28 | 29 | These variables are used in a template for our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) as part of an ansible play. 30 | Most of these variables are also carried over to [docs.linuxserver.io](https://docs.linuxserver.io) 31 | 32 | ### Fixing typos or clarify the text in the readme 33 | 34 | There are variables for multiple parts of the readme, the most common ones are: 35 | 36 | | Variable | Description | 37 | | :----: | --- | 38 | | `project_blurb` | This is the short excerpt shown above the project logo. | 39 | | `app_setup_block` | This is the text that shows up under "Application Setup" if enabled | 40 | 41 | ### Parameters 42 | 43 | The compose and run examples are also generated from these variables. 44 | 45 | We have a [reference file](https://github.com/linuxserver/docker-jenkins-builder/blob/master/vars/_container-vars-blank) in our Jenkins Builder. 46 | 47 | These are prefixed with `param_` for required parameters, or `opt_param` for optional parameters, except for `cap_add`. 48 | Remember to enable param, if currently disabled. This differs between parameters, and can be seen in the reference file. 49 | 50 | Devices, environment variables, ports and volumes expects its variables in a certain way. 51 | 52 | ### Devices 53 | 54 | ```yml 55 | param_devices: 56 | - { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" } 57 | opt_param_devices: 58 | - { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" } 59 | ``` 60 | 61 | ### Environment variables 62 | 63 | ```yml 64 | param_env_vars: 65 | - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." } 66 | opt_param_env_vars: 67 | - { env_var: "VERSION", env_value: "latest", desc: "Supported values are LATEST, PLEXPASS or a specific version number." } 68 | ``` 69 | 70 | ### Ports 71 | 72 | ```yml 73 | param_ports: 74 | - { external_port: "80", internal_port: "80", port_desc: "Application WebUI" } 75 | opt_param_ports: 76 | - { external_port: "80", internal_port: "80", port_desc: "Application WebUI" } 77 | ``` 78 | 79 | ### Volumes 80 | 81 | ```yml 82 | param_volumes: 83 | - { vol_path: "/config", vol_host_path: "", desc: "Configuration files." } 84 | opt_param_volumes: 85 | - { vol_path: "/config", vol_host_path: "", desc: "Configuration files." } 86 | ``` 87 | 88 | ### Testing template changes 89 | 90 | After you make any changes to the templates, you can use our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) to have the files updated from the modified templates. Please use the command found under `Running Locally` [on this page](https://github.com/linuxserver/docker-jenkins-builder/blob/master/README.md) to generate them prior to submitting a PR. 91 | 92 | ## Dockerfiles 93 | 94 | We use multiple Dockerfiles in our repos, this is because sometimes some CPU architectures needs different packages to work. 95 | If you are proposing additional packages to be added, ensure that you added the packages to all the Dockerfiles in alphabetical order. 96 | 97 | ### Testing your changes 98 | 99 | ```bash 100 | git clone https://github.com/linuxserver/docker-socket-proxy.git 101 | cd docker-socket-proxy 102 | docker build \ 103 | --no-cache \ 104 | --pull \ 105 | -t linuxserver/socket-proxy:latest . 106 | ``` 107 | 108 | The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static` 109 | 110 | ```bash 111 | docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset 112 | ``` 113 | 114 | Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`. 115 | 116 | ## Update the changelog 117 | 118 | If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-socket-proxy/tree/main/root), add an entry to the changelog 119 | 120 | ```yml 121 | changelogs: 122 | - { date: "DD.MM.YY:", desc: "Added some love to templates" } 123 | ``` 124 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: linuxserver 2 | open_collective: linuxserver 3 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: Discord chat support 4 | url: https://linuxserver.io/discord 5 | about: Realtime support / chat with the community and the team. 6 | 7 | - name: Discourse discussion forum 8 | url: https://discourse.linuxserver.io 9 | about: Post on our community forum. 10 | 11 | - name: Documentation 12 | url: https://docs.linuxserver.io 13 | about: Documentation - information about all of our containers. 14 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/issue.bug.yml: -------------------------------------------------------------------------------- 1 | # Based on the issue template 2 | name: Bug report 3 | description: Create a report to help us improve 4 | title: "[BUG] " 5 | labels: [Bug] 6 | body: 7 | - type: checkboxes 8 | attributes: 9 | label: Is there an existing issue for this? 10 | description: Please search to see if an issue already exists for the bug you encountered. 11 | options: 12 | - label: I have searched the existing issues 13 | required: true 14 | - type: textarea 15 | attributes: 16 | label: Current Behavior 17 | description: Tell us what happens instead of the expected behavior. 18 | validations: 19 | required: true 20 | - type: textarea 21 | attributes: 22 | label: Expected Behavior 23 | description: Tell us what should happen. 24 | validations: 25 | required: false 26 | - type: textarea 27 | attributes: 28 | label: Steps To Reproduce 29 | description: Steps to reproduce the behavior. 30 | placeholder: | 31 | 1. In this environment... 32 | 2. With this config... 33 | 3. Run '...' 34 | 4. See error... 35 | validations: 36 | required: true 37 | - type: textarea 38 | attributes: 39 | label: Environment 40 | description: | 41 | examples: 42 | - **OS**: Ubuntu 20.04 43 | - **How docker service was installed**: distro's packagemanager 44 | value: | 45 | - OS: 46 | - How docker service was installed: 47 | render: markdown 48 | validations: 49 | required: false 50 | - type: textarea 51 | attributes: 52 | label: Docker creation 53 | description: | 54 | Command used to create docker container 55 | Provide your docker create/run command or compose yaml snippet, or a screenshot of settings if using a gui to create the container 56 | render: bash 57 | validations: 58 | required: true 59 | - type: textarea 60 | attributes: 61 | description: | 62 | Provide a full docker log, output of "docker logs socket-proxy" 63 | label: Container logs 64 | placeholder: | 65 | Output of `docker logs socket-proxy` 66 | render: bash 67 | validations: 68 | required: true 69 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/issue.feature.yml: -------------------------------------------------------------------------------- 1 | # Based on the issue template 2 | name: Feature request 3 | description: Suggest an idea for this project 4 | title: "[FEAT] <title>" 5 | labels: [enhancement] 6 | body: 7 | - type: checkboxes 8 | attributes: 9 | label: Is this a new feature request? 10 | description: Please search to see if a feature request already exists. 11 | options: 12 | - label: I have searched the existing issues 13 | required: true 14 | - type: textarea 15 | attributes: 16 | label: Wanted change 17 | description: Tell us what you want to happen. 18 | validations: 19 | required: true 20 | - type: textarea 21 | attributes: 22 | label: Reason for change 23 | description: Justify your request, why do you want it, what is the benefit. 24 | validations: 25 | required: true 26 | - type: textarea 27 | attributes: 28 | label: Proposed code change 29 | description: Do you have a potential code change in mind? 30 | validations: 31 | required: false 32 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 |  2 | 3 | [linuxserverurl]: https://linuxserver.io 4 | [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] 5 | 6 | 7 |  8 | 9 |  10 |  11 |  12 |  13 |  14 | 15 | 16 |  17 |  18 |  19 |  20 |  21 | 22 | ------------------------------ 23 | 24 | - [ ] I have read the [contributing](https://github.com/linuxserver/docker-socket-proxy/blob/main/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications 25 | 26 | ------------------------------ 27 | 28 |  29 | 30 | ## Description: 31 |  32 | 33 | ## Benefits of this PR and context: 34 |  35 | 36 | ## How Has This Been Tested? 37 |  38 |  39 |  40 | 41 | 42 | ## Source / References: 43 |  44 | -------------------------------------------------------------------------------- /.github/workflows/call_issue_pr_tracker.yml: -------------------------------------------------------------------------------- 1 | name: Issue & PR Tracker 2 | 3 | on: 4 | issues: 5 | types: [opened,reopened,labeled,unlabeled,closed] 6 | pull_request_target: 7 | types: [opened,reopened,review_requested,review_request_removed,labeled,unlabeled,closed] 8 | pull_request_review: 9 | types: [submitted,edited,dismissed] 10 | 11 | jobs: 12 | manage-project: 13 | permissions: 14 | issues: write 15 | uses: linuxserver/github-workflows/.github/workflows/issue-pr-tracker.yml@v1 16 | secrets: inherit 17 | -------------------------------------------------------------------------------- /.github/workflows/call_issues_cron.yml: -------------------------------------------------------------------------------- 1 | name: Mark stale issues and pull requests 2 | on: 3 | schedule: 4 | - cron: '40 6 * * *' 5 | workflow_dispatch: 6 | 7 | jobs: 8 | stale: 9 | permissions: 10 | issues: write 11 | pull-requests: write 12 | uses: linuxserver/github-workflows/.github/workflows/issues-cron.yml@v1 13 | secrets: inherit 14 | -------------------------------------------------------------------------------- /.github/workflows/external_trigger.yml: -------------------------------------------------------------------------------- 1 | name: External Trigger Main 2 | 3 | on: 4 | workflow_dispatch: 5 | 6 | jobs: 7 | external-trigger-main: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v4.1.1 11 | 12 | - name: External Trigger 13 | if: github.ref == 'refs/heads/main' 14 | env: 15 | SKIP_EXTERNAL_TRIGGER: ${{ vars.SKIP_EXTERNAL_TRIGGER }} 16 | run: | 17 | printf "# External trigger for docker-socket-proxy\n\n" >> $GITHUB_STEP_SUMMARY 18 | if grep -q "^socket-proxy_main_" <<< "${SKIP_EXTERNAL_TRIGGER}"; then 19 | echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY 20 | echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` contains \`socket-proxy_main_\`; will skip trigger if version matches." >> $GITHUB_STEP_SUMMARY 21 | elif grep -q "^socket-proxy_main" <<< "${SKIP_EXTERNAL_TRIGGER}"; then 22 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 23 | echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` contains \`socket-proxy_main\`; skipping trigger." >> $GITHUB_STEP_SUMMARY 24 | exit 0 25 | fi 26 | echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY 27 | echo "> External trigger running off of main branch. To disable this trigger, add \`socket-proxy_main\` into the Github organizational variable \`SKIP_EXTERNAL_TRIGGER\`." >> $GITHUB_STEP_SUMMARY 28 | printf "\n## Retrieving external version\n\n" >> $GITHUB_STEP_SUMMARY 29 | EXT_RELEASE=$(curl -sL "http://dl-cdn.alpinelinux.org/alpine/v3.22/main/x86_64/APKINDEX.tar.gz" | tar -xz -C /tmp \ 30 | && awk '/^P:'"haproxy"'$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://') 31 | echo "Type is \`alpine_repo\`" >> $GITHUB_STEP_SUMMARY 32 | if grep -q "^socket-proxy_main_${EXT_RELEASE}" <<< "${SKIP_EXTERNAL_TRIGGER}"; then 33 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 34 | echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` matches current external release; skipping trigger." >> $GITHUB_STEP_SUMMARY 35 | exit 0 36 | fi 37 | if [ -z "${EXT_RELEASE}" ] || [ "${EXT_RELEASE}" == "null" ]; then 38 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 39 | echo "> Can't retrieve external version, exiting" >> $GITHUB_STEP_SUMMARY 40 | FAILURE_REASON="Can't retrieve external version for socket-proxy branch main" 41 | GHA_TRIGGER_URL="https://github.com/linuxserver/docker-socket-proxy/actions/runs/${{ github.run_id }}" 42 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680, 43 | "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n**Trigger URL:** '"${GHA_TRIGGER_URL}"' \n"}], 44 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 45 | exit 1 46 | fi 47 | EXT_RELEASE=$(echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g') 48 | echo "External version: \`${EXT_RELEASE}\`" >> $GITHUB_STEP_SUMMARY 49 | echo "Retrieving last pushed version" >> $GITHUB_STEP_SUMMARY 50 | image="linuxserver/socket-proxy" 51 | tag="latest" 52 | token=$(curl -sX GET \ 53 | "https://ghcr.io/token?scope=repository%3Alinuxserver%2Fsocket-proxy%3Apull" \ 54 | | jq -r '.token') 55 | multidigest=$(curl -s \ 56 | --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \ 57 | --header "Accept: application/vnd.oci.image.index.v1+json" \ 58 | --header "Authorization: Bearer ${token}" \ 59 | "https://ghcr.io/v2/${image}/manifests/${tag}") 60 | if jq -e '.layers // empty' <<< "${multidigest}" >/dev/null 2>&1; then 61 | # If there's a layer element it's a single-arch manifest so just get that digest 62 | digest=$(jq -r '.config.digest' <<< "${multidigest}") 63 | else 64 | # Otherwise it's multi-arch or has manifest annotations 65 | if jq -e '.manifests[]?.annotations // empty' <<< "${multidigest}" >/dev/null 2>&1; then 66 | # Check for manifest annotations and delete if found 67 | multidigest=$(jq 'del(.manifests[] | select(.annotations))' <<< "${multidigest}") 68 | fi 69 | if [[ $(jq '.manifests | length' <<< "${multidigest}") -gt 1 ]]; then 70 | # If there's still more than one digest, it's multi-arch 71 | multidigest=$(jq -r ".manifests[] | select(.platform.architecture == \"amd64\").digest?" <<< "${multidigest}") 72 | else 73 | # Otherwise it's single arch 74 | multidigest=$(jq -r ".manifests[].digest?" <<< "${multidigest}") 75 | fi 76 | if digest=$(curl -s \ 77 | --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \ 78 | --header "Accept: application/vnd.oci.image.manifest.v1+json" \ 79 | --header "Authorization: Bearer ${token}" \ 80 | "https://ghcr.io/v2/${image}/manifests/${multidigest}"); then 81 | digest=$(jq -r '.config.digest' <<< "${digest}"); 82 | fi 83 | fi 84 | image_info=$(curl -sL \ 85 | --header "Authorization: Bearer ${token}" \ 86 | "https://ghcr.io/v2/${image}/blobs/${digest}") 87 | if [[ $(echo $image_info | jq -r '.container_config') == "null" ]]; then 88 | image_info=$(echo $image_info | jq -r '.config') 89 | else 90 | image_info=$(echo $image_info | jq -r '.container_config') 91 | fi 92 | IMAGE_RELEASE=$(echo ${image_info} | jq -r '.Labels.build_version' | awk '{print $3}') 93 | IMAGE_VERSION=$(echo ${IMAGE_RELEASE} | awk -F'-ls' '{print $1}') 94 | if [ -z "${IMAGE_VERSION}" ]; then 95 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 96 | echo "Can't retrieve last pushed version, exiting" >> $GITHUB_STEP_SUMMARY 97 | FAILURE_REASON="Can't retrieve last pushed version for socket-proxy tag latest" 98 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680, 99 | "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}], 100 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 101 | exit 1 102 | fi 103 | echo "Last pushed version: \`${IMAGE_VERSION}\`" >> $GITHUB_STEP_SUMMARY 104 | if [ "${EXT_RELEASE}" == "${IMAGE_VERSION}" ]; then 105 | echo "Version \`${EXT_RELEASE}\` already pushed, exiting" >> $GITHUB_STEP_SUMMARY 106 | exit 0 107 | elif [[ $(curl -sL "http://dl-cdn.alpinelinux.org/alpine/v3.22/main/aarch64/APKINDEX.tar.gz" | tar -xz -C /tmp && awk '/^P:'"haproxy"'$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://') != "${EXT_RELEASE}" ]]; then 108 | echo "New version \`${EXT_RELEASE}\` found; but not all arch repos updated yet; exiting" >> $GITHUB_STEP_SUMMARY 109 | FAILURE_REASON="New version ${EXT_RELEASE} for socket-proxy tag latest is detected, however not all arch repos are updated yet. Will try again later." 110 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, 111 | "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}], 112 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 113 | exit 0 114 | elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-socket-proxy/job/main/lastBuild/api/json | jq -r '.building') == "true" ]; then 115 | echo "New version \`${EXT_RELEASE}\` found; but there already seems to be an active build on Jenkins; exiting" >> $GITHUB_STEP_SUMMARY 116 | exit 0 117 | else 118 | if [[ "${artifacts_found}" == "false" ]]; then 119 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 120 | echo "> New version detected, but not all artifacts are published yet; skipping trigger" >> $GITHUB_STEP_SUMMARY 121 | FAILURE_REASON="New version ${EXT_RELEASE} for socket-proxy tag latest is detected, however not all artifacts are uploaded to upstream release yet. Will try again later." 122 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, 123 | "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}], 124 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 125 | else 126 | printf "\n## Trigger new build\n\n" >> $GITHUB_STEP_SUMMARY 127 | echo "New version \`${EXT_RELEASE}\` found; old version was \`${IMAGE_VERSION}\`. Triggering new build" >> $GITHUB_STEP_SUMMARY 128 | if [[ "${artifacts_found}" == "true" ]]; then 129 | echo "All artifacts seem to be uploaded." >> $GITHUB_STEP_SUMMARY 130 | fi 131 | response=$(curl -iX POST \ 132 | https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-socket-proxy/job/main/buildWithParameters?PACKAGE_CHECK=false \ 133 | --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: $.*$|\1|") 134 | echo "Jenkins [job queue url](${response%$'\r'})" >> $GITHUB_STEP_SUMMARY 135 | echo "Sleeping 10 seconds until job starts" >> $GITHUB_STEP_SUMMARY 136 | sleep 10 137 | buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url') 138 | buildurl="${buildurl%$'\r'}" 139 | echo "Jenkins job [build url](${buildurl})" >> $GITHUB_STEP_SUMMARY 140 | echo "Attempting to change the Jenkins job description" >> $GITHUB_STEP_SUMMARY 141 | curl -iX POST \ 142 | "${buildurl}submitDescription" \ 143 | --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \ 144 | --data-urlencode "description=GHA external trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \ 145 | --data-urlencode "Submit=Submit" 146 | echo "**** Notifying Discord ****" 147 | TRIGGER_REASON="A version change was detected for socket-proxy tag latest. Old version:${IMAGE_VERSION} New version:${EXT_RELEASE}" 148 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, 149 | "description": "**Build Triggered** \n**Reason:** '"${TRIGGER_REASON}"' \n**Build URL:** '"${buildurl}display/redirect"' \n"}], 150 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 151 | fi 152 | fi 153 | -------------------------------------------------------------------------------- /.github/workflows/external_trigger_scheduler.yml: -------------------------------------------------------------------------------- 1 | name: External Trigger Scheduler 2 | 3 | on: 4 | schedule: 5 | - cron: '40 * * * *' 6 | workflow_dispatch: 7 | 8 | jobs: 9 | external-trigger-scheduler: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v4.1.1 13 | with: 14 | fetch-depth: '0' 15 | 16 | - name: External Trigger Scheduler 17 | run: | 18 | printf "# External trigger scheduler for docker-socket-proxy\n\n" >> $GITHUB_STEP_SUMMARY 19 | printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY 20 | for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes) 21 | do 22 | if [[ "${br}" == "HEAD" ]]; then 23 | printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY 24 | continue 25 | fi 26 | printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY 27 | ls_jenkins_vars=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-socket-proxy/${br}/jenkins-vars.yml) 28 | ls_branch=$(echo "${ls_jenkins_vars}" | yq -r '.ls_branch') 29 | ls_trigger=$(echo "${ls_jenkins_vars}" | yq -r '.external_type') 30 | if [[ "${br}" == "${ls_branch}" ]] && [[ "${ls_trigger}" != "os" ]]; then 31 | echo "Branch appears to be live and trigger is not os; checking workflow." >> $GITHUB_STEP_SUMMARY 32 | if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-socket-proxy/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then 33 | echo "Triggering external trigger workflow for branch." >> $GITHUB_STEP_SUMMARY 34 | curl -iX POST \ 35 | -H "Authorization: token ${{ secrets.CR_PAT }}" \ 36 | -H "Accept: application/vnd.github.v3+json" \ 37 | -d "{\"ref\":\"refs/heads/${br}\"}" \ 38 | https://api.github.com/repos/linuxserver/docker-socket-proxy/actions/workflows/external_trigger.yml/dispatches 39 | else 40 | echo "Skipping branch due to no external trigger workflow present." >> $GITHUB_STEP_SUMMARY 41 | fi 42 | else 43 | echo "Skipping branch due to being detected as dev branch or having no external version." >> $GITHUB_STEP_SUMMARY 44 | fi 45 | done 46 | -------------------------------------------------------------------------------- /.github/workflows/greetings.yml: -------------------------------------------------------------------------------- 1 | name: Greetings 2 | 3 | on: [pull_request_target, issues] 4 | 5 | jobs: 6 | greeting: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/first-interaction@v1 10 | with: 11 | issue-message: 'Thanks for opening your first issue here! Be sure to follow the relevant issue templates, or risk having this issue marked as invalid.' 12 | pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-socket-proxy/blob/main/.github/PULL_REQUEST_TEMPLATE.md)!' 13 | repo-token: ${{ secrets.GITHUB_TOKEN }} 14 | -------------------------------------------------------------------------------- /.github/workflows/package_trigger_scheduler.yml: -------------------------------------------------------------------------------- 1 | name: Package Trigger Scheduler 2 | 3 | on: 4 | schedule: 5 | - cron: '40 20 * * 1' 6 | workflow_dispatch: 7 | 8 | jobs: 9 | package-trigger-scheduler: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v4.1.1 13 | with: 14 | fetch-depth: '0' 15 | 16 | - name: Package Trigger Scheduler 17 | env: 18 | SKIP_PACKAGE_TRIGGER: ${{ vars.SKIP_PACKAGE_TRIGGER }} 19 | run: | 20 | printf "# Package trigger scheduler for docker-socket-proxy\n\n" >> $GITHUB_STEP_SUMMARY 21 | printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY 22 | for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes) 23 | do 24 | if [[ "${br}" == "HEAD" ]]; then 25 | printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY 26 | continue 27 | fi 28 | printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY 29 | JENKINS_VARS=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-socket-proxy/${br}/jenkins-vars.yml) 30 | if ! curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-socket-proxy/${br}/Jenkinsfile >/dev/null 2>&1; then 31 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 32 | echo "> No Jenkinsfile found. Branch is either deprecated or is an early dev branch." >> $GITHUB_STEP_SUMMARY 33 | skipped_branches="${skipped_branches}${br} " 34 | elif [[ "${br}" == $(yq -r '.ls_branch' <<< "${JENKINS_VARS}") ]]; then 35 | echo "Branch appears to be live; checking workflow." >> $GITHUB_STEP_SUMMARY 36 | README_VARS=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-socket-proxy/${br}/readme-vars.yml) 37 | if [[ $(yq -r '.project_deprecation_status' <<< "${README_VARS}") == "true" ]]; then 38 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 39 | echo "> Branch appears to be deprecated; skipping trigger." >> $GITHUB_STEP_SUMMARY 40 | skipped_branches="${skipped_branches}${br} " 41 | elif [[ $(yq -r '.skip_package_check' <<< "${JENKINS_VARS}") == "true" ]]; then 42 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 43 | echo "> Skipping branch ${br} due to \`skip_package_check\` being set in \`jenkins-vars.yml\`." >> $GITHUB_STEP_SUMMARY 44 | skipped_branches="${skipped_branches}${br} " 45 | elif grep -q "^socket-proxy_${br}" <<< "${SKIP_PACKAGE_TRIGGER}"; then 46 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 47 | echo "> Github organizational variable \`SKIP_PACKAGE_TRIGGER\` contains \`socket-proxy_${br}\`; skipping trigger." >> $GITHUB_STEP_SUMMARY 48 | skipped_branches="${skipped_branches}${br} " 49 | elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-socket-proxy/job/${br}/lastBuild/api/json | jq -r '.building' 2>/dev/null) == "true" ]; then 50 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 51 | echo "> There already seems to be an active build on Jenkins; skipping package trigger for ${br}" >> $GITHUB_STEP_SUMMARY 52 | skipped_branches="${skipped_branches}${br} " 53 | else 54 | echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY 55 | echo "> Triggering package trigger for branch ${br}" >> $GITHUB_STEP_SUMMARY 56 | printf "> To disable, add \`socket-proxy_%s\` into the Github organizational variable \`SKIP_PACKAGE_TRIGGER\`.\n\n" "${br}" >> $GITHUB_STEP_SUMMARY 57 | triggered_branches="${triggered_branches}${br} " 58 | response=$(curl -iX POST \ 59 | https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-socket-proxy/job/${br}/buildWithParameters?PACKAGE_CHECK=true \ 60 | --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: $.*$|\1|") 61 | if [[ -z "${response}" ]]; then 62 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 63 | echo "> Jenkins build could not be triggered. Skipping branch." 64 | continue 65 | fi 66 | echo "Jenkins [job queue url](${response%$'\r'})" >> $GITHUB_STEP_SUMMARY 67 | echo "Sleeping 10 seconds until job starts" >> $GITHUB_STEP_SUMMARY 68 | sleep 10 69 | buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url') 70 | buildurl="${buildurl%$'\r'}" 71 | echo "Jenkins job [build url](${buildurl})" >> $GITHUB_STEP_SUMMARY 72 | echo "Attempting to change the Jenkins job description" >> $GITHUB_STEP_SUMMARY 73 | if ! curl -ifX POST \ 74 | "${buildurl}submitDescription" \ 75 | --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \ 76 | --data-urlencode "description=GHA package trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \ 77 | --data-urlencode "Submit=Submit"; then 78 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 79 | echo "> Unable to change the Jenkins job description." 80 | fi 81 | sleep 20 82 | fi 83 | else 84 | echo "Skipping branch ${br} due to being detected as dev branch." >> $GITHUB_STEP_SUMMARY 85 | fi 86 | done 87 | if [[ -n "${triggered_branches}" ]] || [[ -n "${skipped_branches}" ]]; then 88 | if [[ -n "${triggered_branches}" ]]; then 89 | NOTIFY_BRANCHES="**Triggered:** ${triggered_branches} \n" 90 | NOTIFY_BUILD_URL="**Build URL:** https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-socket-proxy/activity/ \n" 91 | echo "**** Package check build(s) triggered for branch(es): ${triggered_branches} ****" 92 | fi 93 | if [[ -n "${skipped_branches}" ]]; then 94 | NOTIFY_BRANCHES="${NOTIFY_BRANCHES}**Skipped:** ${skipped_branches} \n" 95 | fi 96 | echo "**** Notifying Discord ****" 97 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, 98 | "description": "**Package Check Build(s) for socket-proxy** \n'"${NOTIFY_BRANCHES}"''"${NOTIFY_BUILD_URL}"'"}], 99 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 100 | fi 101 | -------------------------------------------------------------------------------- /.github/workflows/permissions.yml: -------------------------------------------------------------------------------- 1 | name: Permission check 2 | on: 3 | pull_request_target: 4 | paths: 5 | - '**/run' 6 | - '**/finish' 7 | - '**/check' 8 | - 'root/migrations/*' 9 | 10 | jobs: 11 | permission_check: 12 | uses: linuxserver/github-workflows/.github/workflows/init-svc-executable-permissions.yml@v1 13 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Windows image file caches 2 | Thumbs.db 3 | ehthumbs.db 4 | 5 | # Folder config file 6 | Desktop.ini 7 | 8 | # Recycle Bin used on file shares 9 | $RECYCLE.BIN/ 10 | 11 | # Windows Installer files 12 | *.cab 13 | *.msi 14 | *.msm 15 | *.msp 16 | 17 | # Windows shortcuts 18 | *.lnk 19 | 20 | # ========================= 21 | # Operating System Files 22 | # ========================= 23 | 24 | # OSX 25 | # ========================= 26 | 27 | .DS_Store 28 | .AppleDouble 29 | .LSOverride 30 | 31 | # Thumbnails 32 | ._* 33 | 34 | # Files that might appear on external disk 35 | .Spotlight-V100 36 | .Trashes 37 | 38 | # Directories potentially created on remote AFP share 39 | .AppleDB 40 | .AppleDesktop 41 | Network Trash Folder 42 | Temporary Items 43 | .apdisk 44 | .jenkins-external 45 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # syntax=docker/dockerfile:1 2 | 3 | FROM docker.io/alpine:3.22 4 | 5 | # set version label 6 | ARG BUILD_DATE 7 | ARG VERSION 8 | ARG HAPROXY_VERSION 9 | LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}" 10 | LABEL maintainer="thespad" 11 | 12 | # install packages 13 | RUN \ 14 | echo "**** install build packages ****" && \ 15 | apk add --no-cache \ 16 | alpine-release \ 17 | curl && \ 18 | if [ -z ${HAPROXY_VERSION+x} ]; then \ 19 | HAPROXY_VERSION=$(curl -sL "http://dl-cdn.alpinelinux.org/alpine/v3.22/main/x86_64/APKINDEX.tar.gz" | tar -xz -C /tmp \ 20 | && awk '/^P:haproxy$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://'); \ 21 | fi && \ 22 | apk add --no-cache \ 23 | haproxy==${HAPROXY_VERSION} && \ 24 | printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \ 25 | apk del --no-cache \ 26 | curl && \ 27 | rm -rf \ 28 | /etc/haproxy \ 29 | /tmp/* 30 | 31 | ENV ALLOW_RESTARTS=0 \ 32 | ALLOW_STOP=0 \ 33 | ALLOW_START=0 \ 34 | AUTH=0 \ 35 | BUILD=0 \ 36 | COMMIT=0 \ 37 | CONFIGS=0 \ 38 | CONTAINERS=0 \ 39 | DISTRIBUTION=0 \ 40 | EVENTS=1 \ 41 | EXEC=0 \ 42 | IMAGES=0 \ 43 | INFO=0 \ 44 | LOG_LEVEL=info \ 45 | NETWORKS=0 \ 46 | NODES=0 \ 47 | PING=1 \ 48 | PLUGINS=0 \ 49 | POST=0 \ 50 | SECRETS=0 \ 51 | SERVICES=0 \ 52 | SESSION=0 \ 53 | SOCKET_PATH=/var/run/docker.sock \ 54 | SWARM=0 \ 55 | SYSTEM=0 \ 56 | TASKS=0 \ 57 | VERSION=1 \ 58 | VOLUMES=0 59 | 60 | # add local files 61 | COPY root/ / 62 | 63 | ENTRYPOINT ["/docker-entrypoint.sh"] 64 | -------------------------------------------------------------------------------- /Dockerfile.aarch64: -------------------------------------------------------------------------------- 1 | # syntax=docker/dockerfile:1 2 | 3 | FROM docker.io/alpine:3.22 4 | 5 | # set version label 6 | ARG BUILD_DATE 7 | ARG VERSION 8 | ARG HAPROXY_VERSION 9 | LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}" 10 | LABEL maintainer="thespad" 11 | 12 | # install packages 13 | RUN \ 14 | echo "**** install build packages ****" && \ 15 | apk add --no-cache \ 16 | alpine-release \ 17 | curl && \ 18 | if [ -z ${HAPROXY_VERSION+x} ]; then \ 19 | HAPROXY_VERSION=$(curl -sL "http://dl-cdn.alpinelinux.org/alpine/v3.22/main/x86_64/APKINDEX.tar.gz" | tar -xz -C /tmp \ 20 | && awk '/^P:haproxy$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://'); \ 21 | fi && \ 22 | apk add --no-cache \ 23 | haproxy==${HAPROXY_VERSION} && \ 24 | printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \ 25 | apk del --no-cache \ 26 | curl && \ 27 | rm -rf \ 28 | /etc/haproxy \ 29 | /tmp/* 30 | 31 | ENV ALLOW_RESTARTS=0 \ 32 | ALLOW_STOP=0 \ 33 | ALLOW_START=0 \ 34 | AUTH=0 \ 35 | BUILD=0 \ 36 | COMMIT=0 \ 37 | CONFIGS=0 \ 38 | CONTAINERS=0 \ 39 | DISTRIBUTION=0 \ 40 | EVENTS=1 \ 41 | EXEC=0 \ 42 | IMAGES=0 \ 43 | INFO=0 \ 44 | LOG_LEVEL=info \ 45 | NETWORKS=0 \ 46 | NODES=0 \ 47 | PING=1 \ 48 | PLUGINS=0 \ 49 | POST=0 \ 50 | SECRETS=0 \ 51 | SERVICES=0 \ 52 | SESSION=0 \ 53 | SOCKET_PATH=/var/run/docker.sock \ 54 | SWARM=0 \ 55 | SYSTEM=0 \ 56 | TASKS=0 \ 57 | VERSION=1 \ 58 | VOLUMES=0 59 | 60 | # add local files 61 | COPY root/ / 62 | 63 | ENTRYPOINT ["/docker-entrypoint.sh"] 64 | -------------------------------------------------------------------------------- /Dockerfile.riscv64: -------------------------------------------------------------------------------- 1 | # syntax=docker/dockerfile:1 2 | 3 | FROM docker.io/alpine:3.22 4 | 5 | # set version label 6 | ARG BUILD_DATE 7 | ARG VERSION 8 | ARG HAPROXY_VERSION 9 | LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}" 10 | LABEL maintainer="thespad" 11 | 12 | # install packages 13 | RUN \ 14 | echo "**** install build packages ****" && \ 15 | apk add --no-cache \ 16 | alpine-release \ 17 | curl && \ 18 | if [ -z ${HAPROXY_VERSION+x} ]; then \ 19 | HAPROXY_VERSION=$(curl -sL "http://dl-cdn.alpinelinux.org/alpine/v3.22/main/x86_64/APKINDEX.tar.gz" | tar -xz -C /tmp \ 20 | && awk '/^P:haproxy$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://'); \ 21 | fi && \ 22 | apk add --no-cache \ 23 | haproxy==${HAPROXY_VERSION} && \ 24 | printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \ 25 | apk del --no-cache \ 26 | curl && \ 27 | rm -rf \ 28 | /etc/haproxy \ 29 | /tmp/* 30 | 31 | ENV ALLOW_RESTARTS=0 \ 32 | ALLOW_STOP=0 \ 33 | ALLOW_START=0 \ 34 | AUTH=0 \ 35 | BUILD=0 \ 36 | COMMIT=0 \ 37 | CONFIGS=0 \ 38 | CONTAINERS=0 \ 39 | DISTRIBUTION=0 \ 40 | EVENTS=1 \ 41 | EXEC=0 \ 42 | IMAGES=0 \ 43 | INFO=0 \ 44 | LOG_LEVEL=info \ 45 | NETWORKS=0 \ 46 | NODES=0 \ 47 | PING=1 \ 48 | PLUGINS=0 \ 49 | POST=0 \ 50 | SECRETS=0 \ 51 | SERVICES=0 \ 52 | SESSION=0 \ 53 | SOCKET_PATH=/var/run/docker.sock \ 54 | SWARM=0 \ 55 | SYSTEM=0 \ 56 | TASKS=0 \ 57 | VERSION=1 \ 58 | VOLUMES=0 59 | 60 | # add local files 61 | COPY root/ / 62 | 63 | ENTRYPOINT ["/docker-entrypoint.sh"] 64 | -------------------------------------------------------------------------------- /Jenkinsfile: -------------------------------------------------------------------------------- 1 | pipeline { 2 | agent { 3 | label 'X86-64-MULTI' 4 | } 5 | options { 6 | buildDiscarder(logRotator(numToKeepStr: '10', daysToKeepStr: '60')) 7 | parallelsAlwaysFailFast() 8 | } 9 | // Input to determine if this is a package check 10 | parameters { 11 | string(defaultValue: 'false', description: 'package check run', name: 'PACKAGE_CHECK') 12 | } 13 | // Configuration for the variables used for this specific repo 14 | environment { 15 | BUILDS_DISCORD=credentials('build_webhook_url') 16 | GITHUB_TOKEN=credentials('498b4638-2d02-4ce5-832d-8a57d01d97ab') 17 | GITLAB_TOKEN=credentials('b6f0f1dd-6952-4cf6-95d1-9c06380283f0') 18 | GITLAB_NAMESPACE=credentials('gitlab-namespace-id') 19 | DOCKERHUB_TOKEN=credentials('docker-hub-ci-pat') 20 | QUAYIO_API_TOKEN=credentials('quayio-repo-api-token') 21 | GIT_SIGNING_KEY=credentials('484fbca6-9a4f-455e-b9e3-97ac98785f5f') 22 | BUILD_VERSION_ARG = 'HAPROXY_VERSION' 23 | LS_USER = 'linuxserver' 24 | LS_REPO = 'docker-socket-proxy' 25 | CONTAINER_NAME = 'socket-proxy' 26 | DOCKERHUB_IMAGE = 'linuxserver/socket-proxy' 27 | DEV_DOCKERHUB_IMAGE = 'lsiodev/socket-proxy' 28 | PR_DOCKERHUB_IMAGE = 'lspipepr/socket-proxy' 29 | DIST_IMAGE = 'alpine' 30 | DIST_REPO = 'http://dl-cdn.alpinelinux.org/alpine/v3.22/main/' 31 | DIST_REPO_PACKAGES = 'haproxy' 32 | MULTIARCH='true' 33 | CI='true' 34 | CI_WEB='false' 35 | CI_PORT='2375' 36 | CI_SSL='false' 37 | CI_DELAY='120' 38 | CI_DOCKERENV='' 39 | CI_AUTH='' 40 | CI_WEBPATH='' 41 | } 42 | stages { 43 | stage("Set git config"){ 44 | steps{ 45 | sh '''#!/bin/bash 46 | cat ${GIT_SIGNING_KEY} > /config/.ssh/id_sign 47 | chmod 600 /config/.ssh/id_sign 48 | ssh-keygen -y -f /config/.ssh/id_sign > /config/.ssh/id_sign.pub 49 | echo "Using $(ssh-keygen -lf /config/.ssh/id_sign) to sign commits" 50 | git config --global gpg.format ssh 51 | git config --global user.signingkey /config/.ssh/id_sign 52 | git config --global commit.gpgsign true 53 | ''' 54 | } 55 | } 56 | // Setup all the basic environment variables needed for the build 57 | stage("Set ENV Variables base"){ 58 | steps{ 59 | echo "Running on node: ${NODE_NAME}" 60 | sh '''#! /bin/bash 61 | echo "Pruning builder" 62 | docker builder prune -f --builder container || : 63 | containers=$(docker ps -q) 64 | if [[ -n "${containers}" ]]; then 65 | BUILDX_CONTAINER_ID=$(docker ps -qf 'name=buildx_buildkit') 66 | for container in ${containers}; do 67 | if [[ "${container}" == "${BUILDX_CONTAINER_ID}" ]]; then 68 | echo "skipping buildx container in docker stop" 69 | else 70 | echo "Stopping container ${container}" 71 | docker stop ${container} 72 | fi 73 | done 74 | fi 75 | docker system prune -f --volumes || : 76 | docker image prune -af || : 77 | ''' 78 | script{ 79 | env.EXIT_STATUS = '' 80 | env.LS_RELEASE = sh( 81 | script: '''docker run --rm quay.io/skopeo/stable:v1 inspect docker://ghcr.io/${LS_USER}/${CONTAINER_NAME}:latest 2>/dev/null | jq -r '.Labels.build_version' | awk '{print $3}' | grep '\\-ls' || : ''', 82 | returnStdout: true).trim() 83 | env.LS_RELEASE_NOTES = sh( 84 | script: '''cat readme-vars.yml | awk -F \\" '/date: "[0-9][0-9].[0-9][0-9].[0-9][0-9]:/ {print $4;exit;}' | sed -E ':a;N;$!ba;s/\\r{0,1}\\n/\\\\n/g' ''', 85 | returnStdout: true).trim() 86 | env.GITHUB_DATE = sh( 87 | script: '''date '+%Y-%m-%dT%H:%M:%S%:z' ''', 88 | returnStdout: true).trim() 89 | env.COMMIT_SHA = sh( 90 | script: '''git rev-parse HEAD''', 91 | returnStdout: true).trim() 92 | env.GH_DEFAULT_BRANCH = sh( 93 | script: '''git remote show origin | grep "HEAD branch:" | sed 's|.*HEAD branch: ||' ''', 94 | returnStdout: true).trim() 95 | env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/commit/' + env.GIT_COMMIT 96 | env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DOCKERHUB_IMAGE + '/tags/' 97 | env.PULL_REQUEST = env.CHANGE_ID 98 | env.TEMPLATED_FILES = 'Jenkinsfile README.md LICENSE .editorconfig ./.github/CONTRIBUTING.md ./.github/FUNDING.yml ./.github/ISSUE_TEMPLATE/config.yml ./.github/ISSUE_TEMPLATE/issue.bug.yml ./.github/ISSUE_TEMPLATE/issue.feature.yml ./.github/PULL_REQUEST_TEMPLATE.md ./.github/workflows/external_trigger_scheduler.yml ./.github/workflows/greetings.yml ./.github/workflows/package_trigger_scheduler.yml ./.github/workflows/call_issue_pr_tracker.yml ./.github/workflows/call_issues_cron.yml ./.github/workflows/permissions.yml ./.github/workflows/external_trigger.yml' 99 | } 100 | sh '''#! /bin/bash 101 | echo "The default github branch detected as ${GH_DEFAULT_BRANCH}" ''' 102 | script{ 103 | env.LS_RELEASE_NUMBER = sh( 104 | script: '''echo ${LS_RELEASE} |sed 's/^.*-ls//g' ''', 105 | returnStdout: true).trim() 106 | } 107 | script{ 108 | env.LS_TAG_NUMBER = sh( 109 | script: '''#! /bin/bash 110 | tagsha=$(git rev-list -n 1 ${LS_RELEASE} 2>/dev/null) 111 | if [ "${tagsha}" == "${COMMIT_SHA}" ]; then 112 | echo ${LS_RELEASE_NUMBER} 113 | elif [ -z "${GIT_COMMIT}" ]; then 114 | echo ${LS_RELEASE_NUMBER} 115 | else 116 | echo $((${LS_RELEASE_NUMBER} + 1)) 117 | fi''', 118 | returnStdout: true).trim() 119 | } 120 | } 121 | } 122 | /* ####################### 123 | Package Version Tagging 124 | ####################### */ 125 | // Grab the current package versions in Git to determine package tag 126 | stage("Set Package tag"){ 127 | steps{ 128 | script{ 129 | env.PACKAGE_TAG = sh( 130 | script: '''#!/bin/bash 131 | if [ -e package_versions.txt ] ; then 132 | cat package_versions.txt | md5sum | cut -c1-8 133 | else 134 | echo none 135 | fi''', 136 | returnStdout: true).trim() 137 | } 138 | } 139 | } 140 | /* ######################## 141 | External Release Tagging 142 | ######################## */ 143 | // If this is an alpine repo change for external version determine an md5 from the version string 144 | stage("Set tag Alpine Repo"){ 145 | steps{ 146 | script{ 147 | env.EXT_RELEASE = sh( 148 | script: '''curl -sL "${DIST_REPO}x86_64/APKINDEX.tar.gz" | tar -xz -C /tmp \ 149 | && awk '/^P:'"${DIST_REPO_PACKAGES}"'$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://' ''', 150 | returnStdout: true).trim() 151 | env.RELEASE_LINK = 'alpine_repo' 152 | } 153 | } 154 | } 155 | // Sanitize the release tag and strip illegal docker or github characters 156 | stage("Sanitize tag"){ 157 | steps{ 158 | script{ 159 | env.EXT_RELEASE_CLEAN = sh( 160 | script: '''echo ${EXT_RELEASE} | sed 's/[~,%@+;:/ ]//g' ''', 161 | returnStdout: true).trim() 162 | 163 | def semver = env.EXT_RELEASE_CLEAN =~ /(\d+)\.(\d+)\.(\d+)/ 164 | if (semver.find()) { 165 | env.SEMVER = "${semver[0][1]}.${semver[0][2]}.${semver[0][3]}" 166 | } else { 167 | semver = env.EXT_RELEASE_CLEAN =~ /(\d+)\.(\d+)(?:\.(\d+))?(.*)/ 168 | if (semver.find()) { 169 | if (semver[0][3]) { 170 | env.SEMVER = "${semver[0][1]}.${semver[0][2]}.${semver[0][3]}" 171 | } else if (!semver[0][3] && !semver[0][4]) { 172 | env.SEMVER = "${semver[0][1]}.${semver[0][2]}.${(new Date()).format('YYYYMMdd')}" 173 | } 174 | } 175 | } 176 | 177 | if (env.SEMVER != null) { 178 | if (BRANCH_NAME != "${env.GH_DEFAULT_BRANCH}") { 179 | env.SEMVER = "${env.SEMVER}-${BRANCH_NAME}" 180 | } 181 | println("SEMVER: ${env.SEMVER}") 182 | } else { 183 | println("No SEMVER detected") 184 | } 185 | 186 | } 187 | } 188 | } 189 | // If this is a main build use live docker endpoints 190 | stage("Set ENV live build"){ 191 | when { 192 | branch "main" 193 | environment name: 'CHANGE_ID', value: '' 194 | } 195 | steps { 196 | script{ 197 | env.IMAGE = env.DOCKERHUB_IMAGE 198 | env.GITHUBIMAGE = 'ghcr.io/' + env.LS_USER + '/' + env.CONTAINER_NAME 199 | env.GITLABIMAGE = 'registry.gitlab.com/linuxserver.io/' + env.LS_REPO + '/' + env.CONTAINER_NAME 200 | env.QUAYIMAGE = 'quay.io/linuxserver.io/' + env.CONTAINER_NAME 201 | if (env.MULTIARCH == 'true') { 202 | env.CI_TAGS = 'amd64-' + env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER + '|riscv64-' + env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER + '|arm64v8-' + env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 203 | } else { 204 | env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 205 | } 206 | env.VERSION_TAG = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 207 | env.META_TAG = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 208 | env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN 209 | env.BUILDCACHE = 'docker.io/lsiodev/buildcache,registry.gitlab.com/linuxserver.io/docker-jenkins-builder/lsiodev-buildcache,ghcr.io/linuxserver/lsiodev-buildcache,quay.io/linuxserver.io/lsiodev-buildcache' 210 | } 211 | } 212 | } 213 | // If this is a dev build use dev docker endpoints 214 | stage("Set ENV dev build"){ 215 | when { 216 | not {branch "main"} 217 | environment name: 'CHANGE_ID', value: '' 218 | } 219 | steps { 220 | script{ 221 | env.IMAGE = env.DEV_DOCKERHUB_IMAGE 222 | env.GITHUBIMAGE = 'ghcr.io/' + env.LS_USER + '/lsiodev-' + env.CONTAINER_NAME 223 | env.GITLABIMAGE = 'registry.gitlab.com/linuxserver.io/' + env.LS_REPO + '/lsiodev-' + env.CONTAINER_NAME 224 | env.QUAYIMAGE = 'quay.io/linuxserver.io/lsiodev-' + env.CONTAINER_NAME 225 | if (env.MULTIARCH == 'true') { 226 | env.CI_TAGS = 'amd64-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '|riscv64-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '|arm64v8-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA 227 | } else { 228 | env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA 229 | } 230 | env.VERSION_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA 231 | env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA 232 | env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN 233 | env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DEV_DOCKERHUB_IMAGE + '/tags/' 234 | env.BUILDCACHE = 'docker.io/lsiodev/buildcache,registry.gitlab.com/linuxserver.io/docker-jenkins-builder/lsiodev-buildcache,ghcr.io/linuxserver/lsiodev-buildcache,quay.io/linuxserver.io/lsiodev-buildcache' 235 | } 236 | } 237 | } 238 | // If this is a pull request build use dev docker endpoints 239 | stage("Set ENV PR build"){ 240 | when { 241 | not {environment name: 'CHANGE_ID', value: ''} 242 | } 243 | steps { 244 | script{ 245 | env.IMAGE = env.PR_DOCKERHUB_IMAGE 246 | env.GITHUBIMAGE = 'ghcr.io/' + env.LS_USER + '/lspipepr-' + env.CONTAINER_NAME 247 | env.GITLABIMAGE = 'registry.gitlab.com/linuxserver.io/' + env.LS_REPO + '/lspipepr-' + env.CONTAINER_NAME 248 | env.QUAYIMAGE = 'quay.io/linuxserver.io/lspipepr-' + env.CONTAINER_NAME 249 | if (env.MULTIARCH == 'true') { 250 | env.CI_TAGS = 'amd64-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST + '|riscv64-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST + '|arm64v8-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST 251 | } else { 252 | env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST 253 | } 254 | env.VERSION_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST 255 | env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST 256 | env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN 257 | env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/pull/' + env.PULL_REQUEST 258 | env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.PR_DOCKERHUB_IMAGE + '/tags/' 259 | env.BUILDCACHE = 'docker.io/lsiodev/buildcache,registry.gitlab.com/linuxserver.io/docker-jenkins-builder/lsiodev-buildcache,ghcr.io/linuxserver/lsiodev-buildcache,quay.io/linuxserver.io/lsiodev-buildcache' 260 | } 261 | } 262 | } 263 | // Run ShellCheck 264 | stage('ShellCheck') { 265 | when { 266 | environment name: 'CI', value: 'true' 267 | } 268 | steps { 269 | withCredentials([ 270 | string(credentialsId: 'ci-tests-s3-key-id', variable: 'S3_KEY'), 271 | string(credentialsId: 'ci-tests-s3-secret-access-key', variable: 'S3_SECRET') 272 | ]) { 273 | script{ 274 | env.SHELLCHECK_URL = 'https://ci-tests.linuxserver.io/' + env.IMAGE + '/' + env.META_TAG + '/shellcheck-result.xml' 275 | } 276 | sh '''curl -sL https://raw.githubusercontent.com/linuxserver/docker-jenkins-builder/master/checkrun.sh | /bin/bash''' 277 | sh '''#! /bin/bash 278 | docker run --rm \ 279 | -v ${WORKSPACE}:/mnt \ 280 | -e AWS_ACCESS_KEY_ID=\"${S3_KEY}\" \ 281 | -e AWS_SECRET_ACCESS_KEY=\"${S3_SECRET}\" \ 282 | ghcr.io/linuxserver/baseimage-alpine:3.20 s6-envdir -fn -- /var/run/s6/container_environment /bin/bash -c "\ 283 | apk add --no-cache python3 && \ 284 | python3 -m venv /lsiopy && \ 285 | pip install --no-cache-dir -U pip && \ 286 | pip install --no-cache-dir s3cmd && \ 287 | s3cmd put --no-preserve --acl-public -m text/xml /mnt/shellcheck-result.xml s3://ci-tests.linuxserver.io/${IMAGE}/${META_TAG}/shellcheck-result.xml" || :''' 288 | } 289 | } 290 | } 291 | // Use helper containers to render templated files 292 | stage('Update-Templates') { 293 | when { 294 | branch "main" 295 | environment name: 'CHANGE_ID', value: '' 296 | expression { 297 | env.CONTAINER_NAME != null 298 | } 299 | } 300 | steps { 301 | sh '''#! /bin/bash 302 | set -e 303 | TEMPDIR=$(mktemp -d) 304 | docker pull ghcr.io/linuxserver/jenkins-builder:latest 305 | # Cloned repo paths for templating: 306 | # ${TEMPDIR}/docker-${CONTAINER_NAME}: Cloned branch main of ${LS_USER}/${LS_REPO} for running the jenkins builder on 307 | # ${TEMPDIR}/repo/${LS_REPO}: Cloned branch main of ${LS_USER}/${LS_REPO} for commiting various templated file changes and pushing back to Github 308 | # ${TEMPDIR}/docs/docker-documentation: Cloned docs repo for pushing docs updates to Github 309 | # ${TEMPDIR}/unraid/docker-templates: Cloned docker-templates repo to check for logos 310 | # ${TEMPDIR}/unraid/templates: Cloned templates repo for commiting unraid template changes and pushing back to Github 311 | git clone --branch main --depth 1 https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/docker-${CONTAINER_NAME} 312 | docker run --rm -v ${TEMPDIR}/docker-${CONTAINER_NAME}:/tmp -e LOCAL=true -e PUID=$(id -u) -e PGID=$(id -g) ghcr.io/linuxserver/jenkins-builder:latest 313 | echo "Starting Stage 1 - Jenkinsfile update" 314 | if [[ "$(md5sum Jenkinsfile | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/Jenkinsfile | awk '{ print $1 }')" ]]; then 315 | mkdir -p ${TEMPDIR}/repo 316 | git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO} 317 | cd ${TEMPDIR}/repo/${LS_REPO} 318 | git checkout -f main 319 | cp ${TEMPDIR}/docker-${CONTAINER_NAME}/Jenkinsfile ${TEMPDIR}/repo/${LS_REPO}/ 320 | git add Jenkinsfile 321 | git commit -m 'Bot Updating Templated Files' 322 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 323 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 324 | echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 325 | echo "Updating Jenkinsfile and exiting build, new one will trigger based on commit" 326 | rm -Rf ${TEMPDIR} 327 | exit 0 328 | else 329 | echo "Jenkinsfile is up to date." 330 | fi 331 | echo "Starting Stage 2 - Delete old templates" 332 | OLD_TEMPLATES=".github/ISSUE_TEMPLATE.md .github/ISSUE_TEMPLATE/issue.bug.md .github/ISSUE_TEMPLATE/issue.feature.md .github/workflows/call_invalid_helper.yml .github/workflows/stale.yml .github/workflows/package_trigger.yml" 333 | for i in ${OLD_TEMPLATES}; do 334 | if [[ -f "${i}" ]]; then 335 | TEMPLATES_TO_DELETE="${i} ${TEMPLATES_TO_DELETE}" 336 | fi 337 | done 338 | if [[ -n "${TEMPLATES_TO_DELETE}" ]]; then 339 | mkdir -p ${TEMPDIR}/repo 340 | git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO} 341 | cd ${TEMPDIR}/repo/${LS_REPO} 342 | git checkout -f main 343 | for i in ${TEMPLATES_TO_DELETE}; do 344 | git rm "${i}" 345 | done 346 | git commit -m 'Bot Updating Templated Files' 347 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 348 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 349 | echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 350 | echo "Deleting old/deprecated templates and exiting build, new one will trigger based on commit" 351 | rm -Rf ${TEMPDIR} 352 | exit 0 353 | else 354 | echo "No templates to delete" 355 | fi 356 | echo "Starting Stage 3 - Update templates" 357 | CURRENTHASH=$(grep -hs ^ ${TEMPLATED_FILES} | md5sum | cut -c1-8) 358 | cd ${TEMPDIR}/docker-${CONTAINER_NAME} 359 | NEWHASH=$(grep -hs ^ ${TEMPLATED_FILES} | md5sum | cut -c1-8) 360 | if [[ "${CURRENTHASH}" != "${NEWHASH}" ]] || ! grep -q '.jenkins-external' "${WORKSPACE}/.gitignore" 2>/dev/null; then 361 | mkdir -p ${TEMPDIR}/repo 362 | git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO} 363 | cd ${TEMPDIR}/repo/${LS_REPO} 364 | git checkout -f main 365 | cd ${TEMPDIR}/docker-${CONTAINER_NAME} 366 | mkdir -p ${TEMPDIR}/repo/${LS_REPO}/.github/workflows 367 | mkdir -p ${TEMPDIR}/repo/${LS_REPO}/.github/ISSUE_TEMPLATE 368 | cp --parents ${TEMPLATED_FILES} ${TEMPDIR}/repo/${LS_REPO}/ || : 369 | cp --parents readme-vars.yml ${TEMPDIR}/repo/${LS_REPO}/ || : 370 | cd ${TEMPDIR}/repo/${LS_REPO}/ 371 | if ! grep -q '.jenkins-external' .gitignore 2>/dev/null; then 372 | echo ".jenkins-external" >> .gitignore 373 | git add .gitignore 374 | fi 375 | git add readme-vars.yml ${TEMPLATED_FILES} 376 | git commit -m 'Bot Updating Templated Files' 377 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 378 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 379 | echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 380 | echo "Updating templates and exiting build, new one will trigger based on commit" 381 | rm -Rf ${TEMPDIR} 382 | exit 0 383 | else 384 | echo "false" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 385 | echo "No templates to update" 386 | fi 387 | echo "Starting Stage 4 - External repo updates: Docs, Unraid Template and Readme Sync to Docker Hub" 388 | mkdir -p ${TEMPDIR}/docs 389 | git clone --depth=1 https://github.com/linuxserver/docker-documentation.git ${TEMPDIR}/docs/docker-documentation 390 | if [[ "${BRANCH_NAME}" == "${GH_DEFAULT_BRANCH}" ]] && [[ (! -f ${TEMPDIR}/docs/docker-documentation/docs/images/docker-${CONTAINER_NAME}.md) || ("$(md5sum ${TEMPDIR}/docs/docker-documentation/docs/images/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')") ]]; then 391 | cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md ${TEMPDIR}/docs/docker-documentation/docs/images/ 392 | cd ${TEMPDIR}/docs/docker-documentation 393 | GH_DOCS_DEFAULT_BRANCH=$(git remote show origin | grep "HEAD branch:" | sed 's|.*HEAD branch: ||') 394 | git add docs/images/docker-${CONTAINER_NAME}.md 395 | echo "Updating docs repo" 396 | git commit -m 'Bot Updating Documentation' 397 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH} --rebase 398 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH} || \ 399 | (MAXWAIT="10" && echo "Push to docs failed, trying again in ${MAXWAIT} seconds" && \ 400 | sleep $((RANDOM % MAXWAIT)) && \ 401 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH} --rebase && \ 402 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH}) 403 | else 404 | echo "Docs update not needed, skipping" 405 | fi 406 | if [[ "${BRANCH_NAME}" == "${GH_DEFAULT_BRANCH}" ]]; then 407 | if [[ $(cat ${TEMPDIR}/docker-${CONTAINER_NAME}/README.md | wc -m) -gt 25000 ]]; then 408 | echo "Readme is longer than 25,000 characters. Syncing the lite version to Docker Hub" 409 | DH_README_SYNC_PATH="${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/README.lite" 410 | else 411 | echo "Syncing readme to Docker Hub" 412 | DH_README_SYNC_PATH="${TEMPDIR}/docker-${CONTAINER_NAME}/README.md" 413 | fi 414 | if curl -s https://hub.docker.com/v2/namespaces/${DOCKERHUB_IMAGE%%/*}/repositories/${DOCKERHUB_IMAGE##*/}/tags | jq -r '.message' | grep -q 404; then 415 | echo "Docker Hub endpoint doesn't exist. Creating endpoint first." 416 | DH_TOKEN=$(curl -d '{"username":"linuxserverci", "password":"'${DOCKERHUB_TOKEN}'"}' -H "Content-Type: application/json" -X POST https://hub.docker.com/v2/users/login | jq -r '.token') 417 | curl -s \ 418 | -H "Authorization: JWT ${DH_TOKEN}" \ 419 | -H "Content-Type: application/json" \ 420 | -X POST \ 421 | -d '{"name":"'${DOCKERHUB_IMAGE##*/}'", "namespace":"'${DOCKERHUB_IMAGE%%/*}'"}' \ 422 | https://hub.docker.com/v2/repositories/ || : 423 | fi 424 | DH_TOKEN=$(curl -d '{"username":"linuxserverci", "password":"'${DOCKERHUB_TOKEN}'"}' -H "Content-Type: application/json" -X POST https://hub.docker.com/v2/users/login | jq -r '.token') 425 | curl -s \ 426 | -H "Authorization: JWT ${DH_TOKEN}" \ 427 | -H "Content-Type: application/json" \ 428 | -X PATCH \ 429 | -d "{\\"full_description\\":$(jq -Rsa . ${DH_README_SYNC_PATH})}" \ 430 | https://hub.docker.com/v2/repositories/${DOCKERHUB_IMAGE} || : 431 | else 432 | echo "Not the default Github branch. Skipping readme sync to Docker Hub." 433 | fi 434 | rm -Rf ${TEMPDIR}''' 435 | script{ 436 | env.FILES_UPDATED = sh( 437 | script: '''cat /tmp/${COMMIT_SHA}-${BUILD_NUMBER}''', 438 | returnStdout: true).trim() 439 | } 440 | } 441 | } 442 | // Exit the build if the Templated files were just updated 443 | stage('Template-exit') { 444 | when { 445 | branch "main" 446 | environment name: 'CHANGE_ID', value: '' 447 | environment name: 'FILES_UPDATED', value: 'true' 448 | expression { 449 | env.CONTAINER_NAME != null 450 | } 451 | } 452 | steps { 453 | script{ 454 | env.EXIT_STATUS = 'ABORTED' 455 | } 456 | } 457 | } 458 | // If this is a main build check the S6 service file perms 459 | stage("Check S6 Service file Permissions"){ 460 | when { 461 | branch "main" 462 | environment name: 'CHANGE_ID', value: '' 463 | environment name: 'EXIT_STATUS', value: '' 464 | } 465 | steps { 466 | script{ 467 | sh '''#! /bin/bash 468 | WRONG_PERM=$(find ./ -path "./.git" -prune -o \$ -name "run" -o -name "finish" -o -name "check" \$ -not -perm -u=x,g=x,o=x -print) 469 | if [[ -n "${WRONG_PERM}" ]]; then 470 | echo "The following S6 service files are missing the executable bit; canceling the faulty build: ${WRONG_PERM}" 471 | exit 1 472 | else 473 | echo "S6 service file perms look good." 474 | fi ''' 475 | } 476 | } 477 | } 478 | /* ####################### 479 | GitLab Mirroring and Quay.io Repo Visibility 480 | ####################### */ 481 | // Ping into Gitlab to mirror this repo and have a registry endpoint & mark this repo on Quay.io as public 482 | stage("GitLab Mirror and Quay.io Visibility"){ 483 | when { 484 | environment name: 'EXIT_STATUS', value: '' 485 | } 486 | steps{ 487 | sh '''curl -H "Content-Type: application/json" -H "Private-Token: ${GITLAB_TOKEN}" -X POST https://gitlab.com/api/v4/projects \ 488 | -d '{"namespace_id":'${GITLAB_NAMESPACE}',\ 489 | "name":"'${LS_REPO}'", 490 | "mirror":true,\ 491 | "import_url":"https://github.com/linuxserver/'${LS_REPO}'.git",\ 492 | "issues_access_level":"disabled",\ 493 | "merge_requests_access_level":"disabled",\ 494 | "repository_access_level":"enabled",\ 495 | "visibility":"public"}' ''' 496 | sh '''curl -H "Private-Token: ${GITLAB_TOKEN}" -X PUT "https://gitlab.com/api/v4/projects/Linuxserver.io%2F${LS_REPO}" \ 497 | -d "mirror=true&import_url=https://github.com/linuxserver/${LS_REPO}.git" ''' 498 | sh '''curl -H "Content-Type: application/json" -H "Authorization: Bearer ${QUAYIO_API_TOKEN}" -X POST "https://quay.io/api/v1/repository${QUAYIMAGE/quay.io/}/changevisibility" \ 499 | -d '{"visibility":"public"}' ||: ''' 500 | } 501 | } 502 | /* ############### 503 | Build Container 504 | ############### */ 505 | // Build Docker container for push to LS Repo 506 | stage('Build-Single') { 507 | when { 508 | expression { 509 | env.MULTIARCH == 'false' || params.PACKAGE_CHECK == 'true' 510 | } 511 | environment name: 'EXIT_STATUS', value: '' 512 | } 513 | steps { 514 | echo "Running on node: ${NODE_NAME}" 515 | sh "sed -r -i 's|(^FROM .*)|\\1\\n\\nENV LSIO_FIRST_PARTY=true|g' Dockerfile" 516 | sh "docker buildx build \ 517 | --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ 518 | --label \"org.opencontainers.image.authors=linuxserver.io\" \ 519 | --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-socket-proxy/packages\" \ 520 | --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-socket-proxy\" \ 521 | --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-socket-proxy\" \ 522 | --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ 523 | --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ 524 | --label \"org.opencontainers.image.vendor=linuxserver.io\" \ 525 | --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ 526 | --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ 527 | --label \"org.opencontainers.image.title=Socket-proxy\" \ 528 | --label \"org.opencontainers.image.description=The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it.\" \ 529 | --no-cache --pull -t ${IMAGE}:${META_TAG} --platform=linux/amd64 \ 530 | --provenance=true --sbom=true --builder=container --load \ 531 | --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." 532 | sh '''#! /bin/bash 533 | set -e 534 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 535 | for i in "${CACHE[@]}"; do 536 | docker tag ${IMAGE}:${META_TAG} ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 537 | done 538 | ''' 539 | withCredentials([ 540 | [ 541 | $class: 'UsernamePasswordMultiBinding', 542 | credentialsId: 'Quay.io-Robot', 543 | usernameVariable: 'QUAYUSER', 544 | passwordVariable: 'QUAYPASS' 545 | ] 546 | ]) { 547 | retry_backoff(5,5) { 548 | sh '''#! /bin/bash 549 | set -e 550 | echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin 551 | echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin 552 | echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin 553 | echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin 554 | if [[ "${PACKAGE_CHECK}" != "true" ]]; then 555 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 556 | for i in "${CACHE[@]}"; do 557 | docker push ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} & 558 | done 559 | for p in $(jobs -p); do 560 | wait "$p" || { echo "job $p failed" >&2; exit 1; } 561 | done 562 | fi 563 | ''' 564 | } 565 | } 566 | } 567 | } 568 | // Build MultiArch Docker containers for push to LS Repo 569 | stage('Build-Multi') { 570 | when { 571 | allOf { 572 | environment name: 'MULTIARCH', value: 'true' 573 | expression { params.PACKAGE_CHECK == 'false' } 574 | } 575 | environment name: 'EXIT_STATUS', value: '' 576 | } 577 | parallel { 578 | stage('Build X86') { 579 | steps { 580 | echo "Running on node: ${NODE_NAME}" 581 | sh "sed -r -i 's|(^FROM .*)|\\1\\n\\nENV LSIO_FIRST_PARTY=true|g' Dockerfile" 582 | sh "docker buildx build \ 583 | --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ 584 | --label \"org.opencontainers.image.authors=linuxserver.io\" \ 585 | --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-socket-proxy/packages\" \ 586 | --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-socket-proxy\" \ 587 | --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-socket-proxy\" \ 588 | --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ 589 | --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ 590 | --label \"org.opencontainers.image.vendor=linuxserver.io\" \ 591 | --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ 592 | --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ 593 | --label \"org.opencontainers.image.title=Socket-proxy\" \ 594 | --label \"org.opencontainers.image.description=The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it.\" \ 595 | --no-cache --pull -t ${IMAGE}:amd64-${META_TAG} --platform=linux/amd64 \ 596 | --provenance=true --sbom=true --builder=container --load \ 597 | --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." 598 | sh '''#! /bin/bash 599 | set -e 600 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 601 | for i in "${CACHE[@]}"; do 602 | docker tag ${IMAGE}:amd64-${META_TAG} ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 603 | done 604 | ''' 605 | withCredentials([ 606 | [ 607 | $class: 'UsernamePasswordMultiBinding', 608 | credentialsId: 'Quay.io-Robot', 609 | usernameVariable: 'QUAYUSER', 610 | passwordVariable: 'QUAYPASS' 611 | ] 612 | ]) { 613 | retry_backoff(5,5) { 614 | sh '''#! /bin/bash 615 | set -e 616 | echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin 617 | echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin 618 | echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin 619 | echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin 620 | if [[ "${PACKAGE_CHECK}" != "true" ]]; then 621 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 622 | for i in "${CACHE[@]}"; do 623 | docker push ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} & 624 | done 625 | for p in $(jobs -p); do 626 | wait "$p" || { echo "job $p failed" >&2; exit 1; } 627 | done 628 | fi 629 | ''' 630 | } 631 | } 632 | } 633 | } 634 | stage('Build ARM64') { 635 | agent { 636 | label 'ARM64' 637 | } 638 | steps { 639 | echo "Running on node: ${NODE_NAME}" 640 | sh "sed -r -i 's|(^FROM .*)|\\1\\n\\nENV LSIO_FIRST_PARTY=true|g' Dockerfile.aarch64" 641 | sh "docker buildx build \ 642 | --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ 643 | --label \"org.opencontainers.image.authors=linuxserver.io\" \ 644 | --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-socket-proxy/packages\" \ 645 | --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-socket-proxy\" \ 646 | --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-socket-proxy\" \ 647 | --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ 648 | --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ 649 | --label \"org.opencontainers.image.vendor=linuxserver.io\" \ 650 | --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ 651 | --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ 652 | --label \"org.opencontainers.image.title=Socket-proxy\" \ 653 | --label \"org.opencontainers.image.description=The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it.\" \ 654 | --no-cache --pull -f Dockerfile.aarch64 -t ${IMAGE}:arm64v8-${META_TAG} --platform=linux/arm64 \ 655 | --provenance=true --sbom=true --builder=container --load \ 656 | --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." 657 | sh '''#! /bin/bash 658 | set -e 659 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 660 | for i in "${CACHE[@]}"; do 661 | docker tag ${IMAGE}:arm64v8-${META_TAG} ${i}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} 662 | done 663 | ''' 664 | withCredentials([ 665 | [ 666 | $class: 'UsernamePasswordMultiBinding', 667 | credentialsId: 'Quay.io-Robot', 668 | usernameVariable: 'QUAYUSER', 669 | passwordVariable: 'QUAYPASS' 670 | ] 671 | ]) { 672 | retry_backoff(5,5) { 673 | sh '''#! /bin/bash 674 | set -e 675 | echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin 676 | echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin 677 | echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin 678 | echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin 679 | if [[ "${PACKAGE_CHECK}" != "true" ]]; then 680 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 681 | for i in "${CACHE[@]}"; do 682 | docker push ${i}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} & 683 | done 684 | for p in $(jobs -p); do 685 | wait "$p" || { echo "job $p failed" >&2; exit 1; } 686 | done 687 | fi 688 | ''' 689 | } 690 | } 691 | sh '''#! /bin/bash 692 | containers=$(docker ps -aq) 693 | if [[ -n "${containers}" ]]; then 694 | docker stop ${containers} 695 | fi 696 | docker system prune -f --volumes || : 697 | docker image prune -af || : 698 | ''' 699 | } 700 | } 701 | stage('Build RISCV64') { 702 | agent { 703 | label 'RISCV64' 704 | } 705 | steps { 706 | echo "Running on node: ${NODE_NAME}" 707 | sh "sed -r -i 's|(^FROM .*)|\\1\\n\\nENV LSIO_FIRST_PARTY=true|g' Dockerfile.riscv64" 708 | sh "docker buildx build \ 709 | --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ 710 | --label \"org.opencontainers.image.authors=linuxserver.io\" \ 711 | --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-socket-proxy/packages\" \ 712 | --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-socket-proxy\" \ 713 | --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-socket-proxy\" \ 714 | --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ 715 | --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ 716 | --label \"org.opencontainers.image.vendor=linuxserver.io\" \ 717 | --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ 718 | --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ 719 | --label \"org.opencontainers.image.title=Socket-proxy\" \ 720 | --label \"org.opencontainers.image.description=The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it.\" \ 721 | --no-cache --pull -f Dockerfile.riscv64 -t ${IMAGE}:riscv64-${META_TAG} --platform=linux/riscv64 \ 722 | --provenance=true --sbom=true --builder=container --load \ 723 | --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." 724 | sh '''#! /bin/bash 725 | set -e 726 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 727 | for i in "${CACHE[@]}"; do 728 | docker tag ${IMAGE}:riscv64-${META_TAG} ${i}:riscv64-${COMMIT_SHA}-${BUILD_NUMBER} 729 | done 730 | ''' 731 | withCredentials([ 732 | [ 733 | $class: 'UsernamePasswordMultiBinding', 734 | credentialsId: 'Quay.io-Robot', 735 | usernameVariable: 'QUAYUSER', 736 | passwordVariable: 'QUAYPASS' 737 | ] 738 | ]) { 739 | retry_backoff(5,5) { 740 | sh '''#! /bin/bash 741 | set -e 742 | echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin 743 | echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin 744 | echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin 745 | echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin 746 | if [[ "${PACKAGE_CHECK}" != "true" ]]; then 747 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 748 | for i in "${CACHE[@]}"; do 749 | docker push ${i}:riscv64-${COMMIT_SHA}-${BUILD_NUMBER} & 750 | done 751 | for p in $(jobs -p); do 752 | wait "$p" || { echo "job $p failed" >&2; exit 1; } 753 | done 754 | fi 755 | ''' 756 | } 757 | } 758 | sh '''#! /bin/bash 759 | containers=$(docker ps -aq) 760 | if [[ -n "${containers}" ]]; then 761 | docker stop ${containers} 762 | fi 763 | docker system prune -f --volumes || : 764 | docker image prune -af || : 765 | ''' 766 | } 767 | } 768 | } 769 | } 770 | // Take the image we just built and dump package versions for comparison 771 | stage('Update-packages') { 772 | when { 773 | branch "main" 774 | environment name: 'CHANGE_ID', value: '' 775 | environment name: 'EXIT_STATUS', value: '' 776 | } 777 | steps { 778 | sh '''#! /bin/bash 779 | set -e 780 | TEMPDIR=$(mktemp -d) 781 | if [ "${MULTIARCH}" == "true" ] && [ "${PACKAGE_CHECK}" != "true" ]; then 782 | LOCAL_CONTAINER=${IMAGE}:amd64-${META_TAG} 783 | else 784 | LOCAL_CONTAINER=${IMAGE}:${META_TAG} 785 | fi 786 | touch ${TEMPDIR}/package_versions.txt 787 | docker run --rm \ 788 | -v /var/run/docker.sock:/var/run/docker.sock:ro \ 789 | -v ${TEMPDIR}:/tmp \ 790 | ghcr.io/anchore/syft:latest \ 791 | ${LOCAL_CONTAINER} -o table=/tmp/package_versions.txt 792 | NEW_PACKAGE_TAG=$(md5sum ${TEMPDIR}/package_versions.txt | cut -c1-8 ) 793 | echo "Package tag sha from current packages in buit container is ${NEW_PACKAGE_TAG} comparing to old ${PACKAGE_TAG} from github" 794 | if [ "${NEW_PACKAGE_TAG}" != "${PACKAGE_TAG}" ]; then 795 | git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/${LS_REPO} 796 | git --git-dir ${TEMPDIR}/${LS_REPO}/.git checkout -f main 797 | cp ${TEMPDIR}/package_versions.txt ${TEMPDIR}/${LS_REPO}/ 798 | cd ${TEMPDIR}/${LS_REPO}/ 799 | wait 800 | git add package_versions.txt 801 | git commit -m 'Bot Updating Package Versions' 802 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 803 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git main 804 | echo "true" > /tmp/packages-${COMMIT_SHA}-${BUILD_NUMBER} 805 | echo "Package tag updated, stopping build process" 806 | else 807 | echo "false" > /tmp/packages-${COMMIT_SHA}-${BUILD_NUMBER} 808 | echo "Package tag is same as previous continue with build process" 809 | fi 810 | rm -Rf ${TEMPDIR}''' 811 | script{ 812 | env.PACKAGE_UPDATED = sh( 813 | script: '''cat /tmp/packages-${COMMIT_SHA}-${BUILD_NUMBER}''', 814 | returnStdout: true).trim() 815 | } 816 | } 817 | } 818 | // Exit the build if the package file was just updated 819 | stage('PACKAGE-exit') { 820 | when { 821 | branch "main" 822 | environment name: 'CHANGE_ID', value: '' 823 | environment name: 'PACKAGE_UPDATED', value: 'true' 824 | environment name: 'EXIT_STATUS', value: '' 825 | } 826 | steps { 827 | script{ 828 | env.EXIT_STATUS = 'ABORTED' 829 | } 830 | } 831 | } 832 | // Exit the build if this is just a package check and there are no changes to push 833 | stage('PACKAGECHECK-exit') { 834 | when { 835 | branch "main" 836 | environment name: 'CHANGE_ID', value: '' 837 | environment name: 'PACKAGE_UPDATED', value: 'false' 838 | environment name: 'EXIT_STATUS', value: '' 839 | expression { 840 | params.PACKAGE_CHECK == 'true' 841 | } 842 | } 843 | steps { 844 | script{ 845 | env.EXIT_STATUS = 'ABORTED' 846 | } 847 | } 848 | } 849 | /* ####### 850 | Testing 851 | ####### */ 852 | // Run Container tests 853 | stage('Test') { 854 | when { 855 | environment name: 'CI', value: 'true' 856 | environment name: 'EXIT_STATUS', value: '' 857 | } 858 | steps { 859 | withCredentials([ 860 | string(credentialsId: 'ci-tests-s3-key-id', variable: 'S3_KEY'), 861 | string(credentialsId: 'ci-tests-s3-secret-access-key ', variable: 'S3_SECRET') 862 | ]) { 863 | script{ 864 | env.CI_URL = 'https://ci-tests.linuxserver.io/' + env.IMAGE + '/' + env.META_TAG + '/index.html' 865 | env.CI_JSON_URL = 'https://ci-tests.linuxserver.io/' + env.IMAGE + '/' + env.META_TAG + '/report.json' 866 | } 867 | sh '''#! /bin/bash 868 | set -e 869 | if grep -q 'docker-baseimage' <<< "${LS_REPO}"; then 870 | echo "Detected baseimage, setting LSIO_FIRST_PARTY=true" 871 | if [ -n "${CI_DOCKERENV}" ]; then 872 | CI_DOCKERENV="LSIO_FIRST_PARTY=true|${CI_DOCKERENV}" 873 | else 874 | CI_DOCKERENV="LSIO_FIRST_PARTY=true" 875 | fi 876 | fi 877 | docker pull ghcr.io/linuxserver/ci:latest 878 | if [ "${MULTIARCH}" == "true" ]; then 879 | docker pull ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} --platform=arm64 880 | docker tag ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} ${IMAGE}:arm64v8-${META_TAG} 881 | docker pull ghcr.io/linuxserver/lsiodev-buildcache:riscv64-${COMMIT_SHA}-${BUILD_NUMBER} --platform=riscv64 882 | docker tag ghcr.io/linuxserver/lsiodev-buildcache:riscv64-${COMMIT_SHA}-${BUILD_NUMBER} ${IMAGE}:riscv64-${META_TAG} 883 | fi 884 | docker run --rm \ 885 | --shm-size=1gb \ 886 | -v /var/run/docker.sock:/var/run/docker.sock \ 887 | -e IMAGE=\"${IMAGE}\" \ 888 | -e DOCKER_LOGS_TIMEOUT=\"${CI_DELAY}\" \ 889 | -e TAGS=\"${CI_TAGS}\" \ 890 | -e META_TAG=\"${META_TAG}\" \ 891 | -e RELEASE_TAG=\"latest\" \ 892 | -e PORT=\"${CI_PORT}\" \ 893 | -e SSL=\"${CI_SSL}\" \ 894 | -e BASE=\"${DIST_IMAGE}\" \ 895 | -e SECRET_KEY=\"${S3_SECRET}\" \ 896 | -e ACCESS_KEY=\"${S3_KEY}\" \ 897 | -e DOCKER_ENV=\"${CI_DOCKERENV}\" \ 898 | -e WEB_SCREENSHOT=\"${CI_WEB}\" \ 899 | -e WEB_AUTH=\"${CI_AUTH}\" \ 900 | -e WEB_PATH=\"${CI_WEBPATH}\" \ 901 | -e NODE_NAME=\"${NODE_NAME}\" \ 902 | -t ghcr.io/linuxserver/ci:latest \ 903 | python3 test_build.py''' 904 | } 905 | } 906 | } 907 | /* ################## 908 | Release Logic 909 | ################## */ 910 | // If this is an amd64 only image only push a single image 911 | stage('Docker-Push-Single') { 912 | when { 913 | environment name: 'MULTIARCH', value: 'false' 914 | environment name: 'EXIT_STATUS', value: '' 915 | } 916 | steps { 917 | retry_backoff(5,5) { 918 | sh '''#! /bin/bash 919 | set -e 920 | for PUSHIMAGE in "${IMAGE}" "${GITLABIMAGE}" "${GITHUBIMAGE}" "${QUAYIMAGE}"; do 921 | [[ ${PUSHIMAGE%%/*} =~ \\. ]] && PUSHIMAGEPLUS="${PUSHIMAGE}" || PUSHIMAGEPLUS="docker.io/${PUSHIMAGE}" 922 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 923 | for i in "${CACHE[@]}"; do 924 | if [[ "${PUSHIMAGEPLUS}" == "$(cut -d "/" -f1 <<< ${i})"* ]]; then 925 | CACHEIMAGE=${i} 926 | fi 927 | done 928 | docker buildx imagetools create --prefer-index=false -t ${PUSHIMAGE}:${META_TAG} -t ${PUSHIMAGE}:latest -t ${PUSHIMAGE}:${EXT_RELEASE_TAG} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 929 | if [ -n "${SEMVER}" ]; then 930 | docker buildx imagetools create --prefer-index=false -t ${PUSHIMAGE}:${SEMVER} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 931 | fi 932 | done 933 | ''' 934 | } 935 | } 936 | } 937 | // If this is a multi arch release push all images and define the manifest 938 | stage('Docker-Push-Multi') { 939 | when { 940 | environment name: 'MULTIARCH', value: 'true' 941 | environment name: 'EXIT_STATUS', value: '' 942 | } 943 | steps { 944 | retry_backoff(5,5) { 945 | sh '''#! /bin/bash 946 | set -e 947 | for MANIFESTIMAGE in "${IMAGE}" "${GITLABIMAGE}" "${GITHUBIMAGE}" "${QUAYIMAGE}"; do 948 | [[ ${MANIFESTIMAGE%%/*} =~ \\. ]] && MANIFESTIMAGEPLUS="${MANIFESTIMAGE}" || MANIFESTIMAGEPLUS="docker.io/${MANIFESTIMAGE}" 949 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 950 | for i in "${CACHE[@]}"; do 951 | if [[ "${MANIFESTIMAGEPLUS}" == "$(cut -d "/" -f1 <<< ${i})"* ]]; then 952 | CACHEIMAGE=${i} 953 | fi 954 | done 955 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:amd64-${META_TAG} -t ${MANIFESTIMAGE}:amd64-latest -t ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 956 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:arm64v8-${META_TAG} -t ${MANIFESTIMAGE}:arm64v8-latest -t ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG} ${CACHEIMAGE}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} 957 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:riscv64-${META_TAG} -t ${MANIFESTIMAGE}:riscv64-latest -t ${MANIFESTIMAGE}:riscv64-${EXT_RELEASE_TAG} ${CACHEIMAGE}:riscv64-${COMMIT_SHA}-${BUILD_NUMBER} 958 | if [ -n "${SEMVER}" ]; then 959 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:amd64-${SEMVER} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 960 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:arm64v8-${SEMVER} ${CACHEIMAGE}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} 961 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:riscv64-${SEMVER} ${CACHEIMAGE}:riscv64-${COMMIT_SHA}-${BUILD_NUMBER} 962 | fi 963 | done 964 | for MANIFESTIMAGE in "${IMAGE}" "${GITLABIMAGE}" "${GITHUBIMAGE}" "${QUAYIMAGE}"; do 965 | docker buildx imagetools create -t ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:amd64-latest ${MANIFESTIMAGE}:riscv64-latest ${MANIFESTIMAGE}:arm64v8-latest 966 | docker buildx imagetools create -t ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:riscv64-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG} 967 | 968 | docker buildx imagetools create -t ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:riscv64-${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG} 969 | if [ -n "${SEMVER}" ]; then 970 | docker buildx imagetools create -t ${MANIFESTIMAGE}:${SEMVER} ${MANIFESTIMAGE}:amd64-${SEMVER} ${MANIFESTIMAGE}:riscv64-${SEMVER} ${MANIFESTIMAGE}:arm64v8-${SEMVER} 971 | fi 972 | done 973 | ''' 974 | } 975 | } 976 | } 977 | // If this is a public release tag it in the LS Github 978 | stage('Github-Tag-Push-Release') { 979 | when { 980 | branch "main" 981 | expression { 982 | env.LS_RELEASE != env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 983 | } 984 | environment name: 'CHANGE_ID', value: '' 985 | environment name: 'EXIT_STATUS', value: '' 986 | } 987 | steps { 988 | echo "Pushing New tag for current commit ${META_TAG}" 989 | sh '''curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/git/tags \ 990 | -d '{"tag":"'${META_TAG}'",\ 991 | "object": "'${COMMIT_SHA}'",\ 992 | "message": "Tagging Release '${EXT_RELEASE_CLEAN}'-ls'${LS_TAG_NUMBER}' to main",\ 993 | "type": "commit",\ 994 | "tagger": {"name": "LinuxServer-CI","email": "ci@linuxserver.io","date": "'${GITHUB_DATE}'"}}' ''' 995 | echo "Pushing New release for Tag" 996 | sh '''#! /bin/bash 997 | echo "Updating external repo packages to ${EXT_RELEASE_CLEAN}" > releasebody.json 998 | echo '{"tag_name":"'${META_TAG}'",\ 999 | "target_commitish": "main",\ 1000 | "name": "'${META_TAG}'",\ 1001 | "body": "**CI Report:**\\n\\n'${CI_URL:-N/A}'\\n\\n**LinuxServer Changes:**\\n\\n'${LS_RELEASE_NOTES}'\\n\\n**Remote Changes:**\\n\\n' > start 1002 | printf '","draft": false,"prerelease": false}' >> releasebody.json 1003 | paste -d'\\0' start releasebody.json > releasebody.json.done 1004 | curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/releases -d @releasebody.json.done''' 1005 | } 1006 | } 1007 | // Add protection to the release branch 1008 | stage('Github-Release-Branch-Protection') { 1009 | when { 1010 | branch "main" 1011 | environment name: 'CHANGE_ID', value: '' 1012 | environment name: 'EXIT_STATUS', value: '' 1013 | } 1014 | steps { 1015 | echo "Setting up protection for release branch main" 1016 | sh '''#! /bin/bash 1017 | curl -H "Authorization: token ${GITHUB_TOKEN}" -X PUT https://api.github.com/repos/${LS_USER}/${LS_REPO}/branches/main/protection \ 1018 | -d $(jq -c . << EOF 1019 | { 1020 | "required_status_checks": null, 1021 | "enforce_admins": false, 1022 | "required_pull_request_reviews": { 1023 | "dismiss_stale_reviews": false, 1024 | "require_code_owner_reviews": false, 1025 | "require_last_push_approval": false, 1026 | "required_approving_review_count": 1 1027 | }, 1028 | "restrictions": null, 1029 | "required_linear_history": false, 1030 | "allow_force_pushes": false, 1031 | "allow_deletions": false, 1032 | "block_creations": false, 1033 | "required_conversation_resolution": true, 1034 | "lock_branch": false, 1035 | "allow_fork_syncing": false, 1036 | "required_signatures": false 1037 | } 1038 | EOF 1039 | ) ''' 1040 | } 1041 | } 1042 | // If this is a Pull request send the CI link as a comment on it 1043 | stage('Pull Request Comment') { 1044 | when { 1045 | not {environment name: 'CHANGE_ID', value: ''} 1046 | environment name: 'EXIT_STATUS', value: '' 1047 | } 1048 | steps { 1049 | sh '''#! /bin/bash 1050 | # Function to retrieve JSON data from URL 1051 | get_json() { 1052 | local url="$1" 1053 | local response=$(curl -s "$url") 1054 | if [ $? -ne 0 ]; then 1055 | echo "Failed to retrieve JSON data from $url" 1056 | return 1 1057 | fi 1058 | local json=$(echo "$response" | jq .) 1059 | if [ $? -ne 0 ]; then 1060 | echo "Failed to parse JSON data from $url" 1061 | return 1 1062 | fi 1063 | echo "$json" 1064 | } 1065 | 1066 | build_table() { 1067 | local data="$1" 1068 | 1069 | # Get the keys in the JSON data 1070 | local keys=$(echo "$data" | jq -r 'to_entries | map(.key) | .[]') 1071 | 1072 | # Check if keys are empty 1073 | if [ -z "$keys" ]; then 1074 | echo "JSON report data does not contain any keys or the report does not exist." 1075 | return 1 1076 | fi 1077 | 1078 | # Build table header 1079 | local header="| Tag | Passed |\\n| --- | --- |\\n" 1080 | 1081 | # Loop through the JSON data to build the table rows 1082 | local rows="" 1083 | for build in $keys; do 1084 | local status=$(echo "$data" | jq -r ".[\\"$build\\"].test_success") 1085 | if [ "$status" = "true" ]; then 1086 | status="✅" 1087 | else 1088 | status="❌" 1089 | fi 1090 | local row="| "$build" | "$status" |\\n" 1091 | rows="${rows}${row}" 1092 | done 1093 | 1094 | local table="${header}${rows}" 1095 | local escaped_table=$(echo "$table" | sed 's/\"/\\\\"/g') 1096 | echo "$escaped_table" 1097 | } 1098 | 1099 | if [[ "${CI}" = "true" ]]; then 1100 | # Retrieve JSON data from URL 1101 | data=$(get_json "$CI_JSON_URL") 1102 | # Create table from JSON data 1103 | table=$(build_table "$data") 1104 | echo -e "$table" 1105 | 1106 | curl -X POST -H "Authorization: token $GITHUB_TOKEN" \ 1107 | -H "Accept: application/vnd.github.v3+json" \ 1108 | "https://api.github.com/repos/$LS_USER/$LS_REPO/issues/$PULL_REQUEST/comments" \ 1109 | -d "{\\"body\\": \\"I am a bot, here are the test results for this PR: \\n${CI_URL}\\n${SHELLCHECK_URL}\\n${table}\\"}" 1110 | else 1111 | curl -X POST -H "Authorization: token $GITHUB_TOKEN" \ 1112 | -H "Accept: application/vnd.github.v3+json" \ 1113 | "https://api.github.com/repos/$LS_USER/$LS_REPO/issues/$PULL_REQUEST/comments" \ 1114 | -d "{\\"body\\": \\"I am a bot, here is the pushed image/manifest for this PR: \\n\\n\\`${GITHUBIMAGE}:${META_TAG}\\`\\"}" 1115 | fi 1116 | ''' 1117 | 1118 | } 1119 | } 1120 | } 1121 | /* ###################### 1122 | Send status to Discord 1123 | ###################### */ 1124 | post { 1125 | always { 1126 | sh '''#!/bin/bash 1127 | rm -rf /config/.ssh/id_sign 1128 | rm -rf /config/.ssh/id_sign.pub 1129 | git config --global --unset gpg.format 1130 | git config --global --unset user.signingkey 1131 | git config --global --unset commit.gpgsign 1132 | ''' 1133 | script{ 1134 | env.JOB_DATE = sh( 1135 | script: '''date '+%Y-%m-%dT%H:%M:%S%:z' ''', 1136 | returnStdout: true).trim() 1137 | if (env.EXIT_STATUS == "ABORTED"){ 1138 | sh 'echo "build aborted"' 1139 | }else{ 1140 | if (currentBuild.currentResult == "SUCCESS"){ 1141 | if (env.GITHUBIMAGE =~ /lspipepr/){ 1142 | env.JOB_WEBHOOK_STATUS='Success' 1143 | env.JOB_WEBHOOK_COLOUR=3957028 1144 | env.JOB_WEBHOOK_FOOTER='PR Build' 1145 | }else if (env.GITHUBIMAGE =~ /lsiodev/){ 1146 | env.JOB_WEBHOOK_STATUS='Success' 1147 | env.JOB_WEBHOOK_COLOUR=3957028 1148 | env.JOB_WEBHOOK_FOOTER='Dev Build' 1149 | }else{ 1150 | env.JOB_WEBHOOK_STATUS='Success' 1151 | env.JOB_WEBHOOK_COLOUR=1681177 1152 | env.JOB_WEBHOOK_FOOTER='Live Build' 1153 | } 1154 | }else{ 1155 | if (env.GITHUBIMAGE =~ /lspipepr/){ 1156 | env.JOB_WEBHOOK_STATUS='Failure' 1157 | env.JOB_WEBHOOK_COLOUR=12669523 1158 | env.JOB_WEBHOOK_FOOTER='PR Build' 1159 | }else if (env.GITHUBIMAGE =~ /lsiodev/){ 1160 | env.JOB_WEBHOOK_STATUS='Failure' 1161 | env.JOB_WEBHOOK_COLOUR=12669523 1162 | env.JOB_WEBHOOK_FOOTER='Dev Build' 1163 | }else{ 1164 | env.JOB_WEBHOOK_STATUS='Failure' 1165 | env.JOB_WEBHOOK_COLOUR=16711680 1166 | env.JOB_WEBHOOK_FOOTER='Live Build' 1167 | } 1168 | } 1169 | sh ''' curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/jenkins-avatar.png","embeds": [{"'color'": '${JOB_WEBHOOK_COLOUR}',\ 1170 | "footer": {"text" : "'"${JOB_WEBHOOK_FOOTER}"'"},\ 1171 | "timestamp": "'${JOB_DATE}'",\ 1172 | "description": "**Build:** '${BUILD_NUMBER}'\\n**CI Results:** '${CI_URL}'\\n**ShellCheck Results:** '${SHELLCHECK_URL}'\\n**Status:** '${JOB_WEBHOOK_STATUS}'\\n**Job:** '${RUN_DISPLAY_URL}'\\n**Change:** '${CODE_URL}'\\n**External Release:**: '${RELEASE_LINK}'\\n**DockerHub:** '${DOCKERHUB_LINK}'\\n"}],\ 1173 | "username": "Jenkins"}' ${BUILDS_DISCORD} ''' 1174 | } 1175 | } 1176 | } 1177 | cleanup { 1178 | sh '''#! /bin/bash 1179 | echo "Pruning builder!!" 1180 | docker builder prune -f --builder container || : 1181 | containers=$(docker ps -q) 1182 | if [[ -n "${containers}" ]]; then 1183 | BUILDX_CONTAINER_ID=$(docker ps -qf 'name=buildx_buildkit') 1184 | for container in ${containers}; do 1185 | if [[ "${container}" == "${BUILDX_CONTAINER_ID}" ]]; then 1186 | echo "skipping buildx container in docker stop" 1187 | else 1188 | echo "Stopping container ${container}" 1189 | docker stop ${container} 1190 | fi 1191 | done 1192 | fi 1193 | docker system prune -f --volumes || : 1194 | docker image prune -af || : 1195 | ''' 1196 | cleanWs() 1197 | } 1198 | } 1199 | } 1200 | 1201 | def retry_backoff(int max_attempts, int power_base, Closure c) { 1202 | int n = 0 1203 | while (n < max_attempts) { 1204 | try { 1205 | c() 1206 | return 1207 | } catch (err) { 1208 | if ((n + 1) >= max_attempts) { 1209 | throw err 1210 | } 1211 | sleep(power_base ** n) 1212 | n++ 1213 | } 1214 | } 1215 | return 1216 | } 1217 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> 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 | <one line to give the program's name and a brief idea of what it does.> 635 | Copyright (C) <year> <name of author> 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 <https://www.gnu.org/licenses/>. 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 | <program> Copyright (C) <year> <name of author> 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 | <https://www.gnu.org/licenses/>. 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 | <https://www.gnu.org/licenses/why-not-lgpl.html>. 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |  2 |  3 | [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) 4 | 5 | [![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!") 6 | [![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.") 7 | [![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.") 8 | [![Fleet](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Fleet)](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.") 9 | [![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.") 10 | [![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget") 11 | 12 | The [LinuxServer.io](https://linuxserver.io) team brings you another container release. 13 | 14 | Find us at: 15 | 16 | * [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more! 17 | * [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team. 18 | * [Discourse](https://discourse.linuxserver.io) - post on our community forum. 19 | * [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images. 20 | * [GitHub](https://github.com/linuxserver) - view the source for all of our repositories. 21 | * [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget 22 | 23 | # [linuxserver/socket-proxy](https://github.com/linuxserver/docker-socket-proxy) 24 | 25 | [![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fsocket-proxy?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fsocket-proxy) 26 | [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-socket-proxy) 27 | [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-socket-proxy/releases) 28 | [![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-socket-proxy/packages) 29 | [![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-socket-proxy/container_registry) 30 | [![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/socket-proxy) 31 | [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/socket-proxy) 32 | [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/socket-proxy) 33 | [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-socket-proxy%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-socket-proxy/job/main/) 34 | 35 | The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it. 36 | 37 | ![socket-proxy](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/docker-logo.png) 38 | 39 | ## Supported Architectures 40 | 41 | We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). 42 | 43 | Simply pulling `lscr.io/linuxserver/socket-proxy:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 44 | 45 | The architectures supported by this image are: 46 | 47 | | Architecture | Available | Tag | 48 | | :----: | :----: | ---- | 49 | | x86-64 | ✅ | amd64-\<version tag\> | 50 | | riscv64 | ✅ | riscv64-\<version tag\> | 51 | | arm64 | ✅ | arm64v8-\<version tag\> | 52 | | armhf | ❌ | | 53 | 54 | ## Application Setup 55 | 56 | This container is conceptually based on [https://github.com/Tecnativa/docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy) and as such does not follow our usual container conventions. It *does not* support mods or custom scripts/services, or running as a user other than root (or the docker user in a rootless environment). It is designed to act as a drop-in replacement for the Tecnativa container. 57 | 58 | The container should be run on the same docker network as the service(s) using it. Most containers that would normally connect to a mounted docker.sock can have their endpoint overridden using the `DOCKER_HOST` environment variable if they do not offer the option in their configuration; it should typically be pointed to `tcp://socket-proxy:2375`. 59 | 60 | * Never expose this container's port to a public network. It should be treated the same way you would treat the docker socket or TCP endpoint. 61 | * Revoke access to any API section that you consider your service should not need. 62 | * To see the versions of the API your Docker daemon and client support, use `docker version` and check the `API version`. 63 | * [Read the docs](https://docs.docker.com/engine/api/) for the API version you are using for an explanation of all the available endpoints. 64 | 65 | ## Read-Only Operation 66 | 67 | This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/). 68 | 69 | ## Usage 70 | 71 | To help you get started creating a container from this image you can either use docker compose or the docker cli. 72 | 73 | >[!NOTE] 74 | >Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided. 75 | 76 | ### docker compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) 77 | 78 | ```yaml 79 | --- 80 | services: 81 | socket-proxy: 82 | image: lscr.io/linuxserver/socket-proxy:latest 83 | container_name: socket-proxy 84 | environment: 85 | - ALLOW_START=0 #optional 86 | - ALLOW_STOP=0 #optional 87 | - ALLOW_RESTARTS=0 #optional 88 | - AUTH=0 #optional 89 | - BUILD=0 #optional 90 | - COMMIT=0 #optional 91 | - CONFIGS=0 #optional 92 | - CONTAINERS=0 #optional 93 | - DISABLE_IPV6=0 #optional 94 | - DISTRIBUTION=0 #optional 95 | - EVENTS=1 #optional 96 | - EXEC=0 #optional 97 | - IMAGES=0 #optional 98 | - INFO=0 #optional 99 | - LOG_LEVEL=info #optional 100 | - NETWORKS=0 #optional 101 | - NODES=0 #optional 102 | - PING=1 #optional 103 | - PLUGINS=0 #optional 104 | - POST=0 #optional 105 | - SECRETS=0 #optional 106 | - SERVICES=0 #optional 107 | - SESSION=0 #optional 108 | - SWARM=0 #optional 109 | - SYSTEM=0 #optional 110 | - TASKS=0 #optional 111 | - VERSION=1 #optional 112 | - VOLUMES=0 #optional 113 | volumes: 114 | - /var/run/docker.sock:/var/run/docker.sock:ro 115 | restart: unless-stopped 116 | read_only: true 117 | tmpfs: 118 | - /run 119 | ``` 120 | 121 | ### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) 122 | 123 | ```bash 124 | docker run -d \ 125 | --name=socket-proxy \ 126 | -e ALLOW_START=0 `#optional` \ 127 | -e ALLOW_STOP=0 `#optional` \ 128 | -e ALLOW_RESTARTS=0 `#optional` \ 129 | -e AUTH=0 `#optional` \ 130 | -e BUILD=0 `#optional` \ 131 | -e COMMIT=0 `#optional` \ 132 | -e CONFIGS=0 `#optional` \ 133 | -e CONTAINERS=0 `#optional` \ 134 | -e DISTRIBUTION=0 `#optional` \ 135 | -e DISABLE_IPV6=0 `#optional` \ 136 | -e EVENTS=1 `#optional` \ 137 | -e EXEC=0 `#optional` \ 138 | -e IMAGES=0 `#optional` \ 139 | -e INFO=0 `#optional` \ 140 | -e LOG_LEVEL=info `#optional` \ 141 | -e NETWORKS=0 `#optional` \ 142 | -e NODES=0 `#optional` \ 143 | -e PING=1 `#optional` \ 144 | -e PLUGINS=0 `#optional` \ 145 | -e POST=0 `#optional` \ 146 | -e SECRETS=0 `#optional` \ 147 | -e SERVICES=0 `#optional` \ 148 | -e SESSION=0 `#optional` \ 149 | -e SWARM=0 `#optional` \ 150 | -e SYSTEM=0 `#optional` \ 151 | -e TASKS=0 `#optional` \ 152 | -e VERSION=1 `#optional` \ 153 | -e VOLUMES=0 `#optional` \ 154 | -v /var/run/docker.sock:/var/run/docker.sock:ro \ 155 | --restart unless-stopped \ 156 | --read-only \ 157 | --tmpfs /run \ 158 | lscr.io/linuxserver/socket-proxy:latest 159 | ``` 160 | 161 | ## Parameters 162 | 163 | Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. 164 | 165 | | Parameter | Function | 166 | | :----: | --- | 167 | | `-e ALLOW_START=0` | `/containers/{id}/start` - **This option will work even if `POST=0`** | 168 | | `-e ALLOW_STOP=0` | `/containers/{id}/stop` - **This option will work even if `POST=0`** | 169 | | `-e ALLOW_RESTARTS=0` | `/containers/{id}/stop`, `/containers/{id}/restart`, and `/containers/{id}/kill` - **This option will work even if `POST=0`** | 170 | | `-e AUTH=0` | `/auth` | 171 | | `-e BUILD=0` | `/build` | 172 | | `-e COMMIT=0` | `/commit` | 173 | | `-e CONFIGS=0` | `/configs` | 174 | | `-e CONTAINERS=0` | `/containers` | 175 | | `-e DISTRIBUTION=0` | `/distribution` | 176 | | `-e DISABLE_IPV6=0` | Set to `1` to prevent binding to the IPv6 interface for legacy systems that cannot support IPv6. | 177 | | `-e EVENTS=1` | `/events` | 178 | | `-e EXEC=0` | `/exec` & `/containers/{id}/exec` | 179 | | `-e IMAGES=0` | `/images` | 180 | | `-e INFO=0` | `/info` | 181 | | `-e LOG_LEVEL=info` | Possible values are: debug, info, notice, warning, err, crit, alert and emerg. Defaults to info. | 182 | | `-e NETWORKS=0` | `/networks` | 183 | | `-e NODES=0` | `/nodes` | 184 | | `-e PING=1` | `/_ping` | 185 | | `-e PLUGINS=0` | `/plugins` | 186 | | `-e POST=0` | When set to `0`, only `GET` and `HEAD` operations are allowed, making API access read-only. | 187 | | `-e SECRETS=0` | `/secrets` | 188 | | `-e SERVICES=0` | `/services` | 189 | | `-e SESSION=0` | `/session` | 190 | | `-e SWARM=0` | `/swarm` | 191 | | `-e SYSTEM=0` | `/system` | 192 | | `-e TASKS=0` | `/tasks` | 193 | | `-e VERSION=1` | `/version` | 194 | | `-e VOLUMES=0` | `/volumes` | 195 | | `-v /var/run/docker.sock:ro` | Mount the host docker socket into the container. | 196 | | `--read-only` | Make the container filesystem read-only. | 197 | | `--tmpfs /run` | Mount /run to tmpfs (RAM) to make it writeable. | 198 | 199 | ## Support Info 200 | 201 | * Shell access whilst the container is running: 202 | 203 | ```bash 204 | docker exec -it socket-proxy /bin/sh 205 | ``` 206 | 207 | * To monitor the logs of the container in realtime: 208 | 209 | ```bash 210 | docker logs -f socket-proxy 211 | ``` 212 | 213 | * Container version number: 214 | 215 | ```bash 216 | docker inspect -f '{{ index .Config.Labels "build_version" }}' socket-proxy 217 | ``` 218 | 219 | * Image version number: 220 | 221 | ```bash 222 | docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/socket-proxy:latest 223 | ``` 224 | 225 | ## Updating Info 226 | 227 | Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image. 228 | 229 | Below are the instructions for updating containers: 230 | 231 | ### Via Docker Compose 232 | 233 | * Update images: 234 | * All images: 235 | 236 | ```bash 237 | docker compose pull 238 | ``` 239 | 240 | * Single image: 241 | 242 | ```bash 243 | docker compose pull socket-proxy 244 | ``` 245 | 246 | * Update containers: 247 | * All containers: 248 | 249 | ```bash 250 | docker compose up -d 251 | ``` 252 | 253 | * Single container: 254 | 255 | ```bash 256 | docker compose up -d socket-proxy 257 | ``` 258 | 259 | * You can also remove the old dangling images: 260 | 261 | ```bash 262 | docker image prune 263 | ``` 264 | 265 | ### Via Docker Run 266 | 267 | * Update the image: 268 | 269 | ```bash 270 | docker pull lscr.io/linuxserver/socket-proxy:latest 271 | ``` 272 | 273 | * Stop the running container: 274 | 275 | ```bash 276 | docker stop socket-proxy 277 | ``` 278 | 279 | * Delete the container: 280 | 281 | ```bash 282 | docker rm socket-proxy 283 | ``` 284 | 285 | * You can also remove the old dangling images: 286 | 287 | ```bash 288 | docker image prune 289 | ``` 290 | 291 | ### Image Update Notifications - Diun (Docker Image Update Notifier) 292 | 293 | >[!TIP] 294 | >We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported. 295 | 296 | ## Building locally 297 | 298 | If you want to make local modifications to these images for development purposes or just to customize the logic: 299 | 300 | ```bash 301 | git clone https://github.com/linuxserver/docker-socket-proxy.git 302 | cd docker-socket-proxy 303 | docker build \ 304 | --no-cache \ 305 | --pull \ 306 | -t lscr.io/linuxserver/socket-proxy:latest . 307 | ``` 308 | 309 | The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/docker-qemu-static` 310 | 311 | ```bash 312 | docker run --rm --privileged lscr.io/linuxserver/docker-qemu-static --reset 313 | ``` 314 | 315 | Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`. 316 | 317 | ## Versions 318 | 319 | * **03.06.25:** - Rebase to Alpine 3.22. Add RISCV support. 320 | * **08.04.25:** - Add `LOG_LEVEL` back. 321 | * **06.04.25:** - Switch back to haproxy for better handling of `docker exec` connection hijacking. 322 | * **02.01.25:** - Support custom read timeout values. 323 | * **05.12.24:** - Rebase to Alpine 3.21. 324 | * **26.08.24:** - Change `ALLOW_START`, `ALLOW_STOP`, and `ALLOW_RESTARTS` to work even with `POST=0`. 325 | * **24.05.24:** - Rebase to Alpine 3.20. 326 | * **15.04.24:** - Allow disabling IPv6 support for legacy devices. 327 | * **08.04.24:** - Use nginx due to haproxy's wonky websockets handling. 328 | * **07.04.24:** - Initial Release. 329 | -------------------------------------------------------------------------------- /jenkins-vars.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # jenkins variables 4 | project_name: docker-socket-proxy 5 | external_type: alpine_repo 6 | release_type: stable 7 | release_tag: latest 8 | ls_branch: main 9 | build_riscv64: true 10 | repo_vars: 11 | - BUILD_VERSION_ARG = 'HAPROXY_VERSION' 12 | - LS_USER = 'linuxserver' 13 | - LS_REPO = 'docker-socket-proxy' 14 | - CONTAINER_NAME = 'socket-proxy' 15 | - DOCKERHUB_IMAGE = 'linuxserver/socket-proxy' 16 | - DEV_DOCKERHUB_IMAGE = 'lsiodev/socket-proxy' 17 | - PR_DOCKERHUB_IMAGE = 'lspipepr/socket-proxy' 18 | - DIST_IMAGE = 'alpine' 19 | - DIST_REPO = 'http://dl-cdn.alpinelinux.org/alpine/v3.22/main/' 20 | - DIST_REPO_PACKAGES = 'haproxy' 21 | - MULTIARCH='true' 22 | - CI='true' 23 | - CI_WEB='false' 24 | - CI_PORT='2375' 25 | - CI_SSL='false' 26 | - CI_DELAY='120' 27 | - CI_DOCKERENV='' 28 | - CI_AUTH='' 29 | - CI_WEBPATH='' 30 | -------------------------------------------------------------------------------- /package_versions.txt: -------------------------------------------------------------------------------- 1 | NAME VERSION TYPE 2 | alpine-baselayout 3.7.0-r0 apk 3 | alpine-baselayout-data 3.7.0-r0 apk 4 | alpine-keys 2.5-r0 apk 5 | alpine-release 3.22.0-r0 apk 6 | apk-tools 2.14.9-r2 apk 7 | busybox 1.37.0-r18 apk 8 | busybox-binsh 1.37.0-r18 apk 9 | ca-certificates-bundle 20241121-r2 apk 10 | haproxy 3.0.10-r0 apk 11 | libapk2 2.14.9-r2 apk 12 | libcrypto3 3.5.0-r0 apk 13 | libssl3 3.5.0-r0 apk 14 | lua5.4-libs 5.4.7-r0 apk 15 | musl 1.2.5-r10 apk 16 | musl-utils 1.2.5-r10 apk 17 | pcre2 10.43-r1 apk 18 | scanelf 1.3.8-r1 apk 19 | ssl_client 1.37.0-r18 apk 20 | zlib 1.3.1-r2 apk 21 | -------------------------------------------------------------------------------- /readme-vars.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # project information 4 | project_name: socket-proxy 5 | project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/docker-logo.png" 6 | project_blurb: The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it. 7 | project_categories: "Docker" 8 | full_custom_readme: | 9 | {% raw -%} 10 | [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) 11 | 12 | [![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!") 13 | [![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.") 14 | [![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.") 15 | [![Fleet](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Fleet)](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.") 16 | [![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.") 17 | [![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget") 18 | 19 | The [LinuxServer.io](https://linuxserver.io) team brings you another container release. 20 | 21 | Find us at: 22 | 23 | * [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more! 24 | * [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team. 25 | * [Discourse](https://discourse.linuxserver.io) - post on our community forum. 26 | * [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images. 27 | * [GitHub](https://github.com/linuxserver) - view the source for all of our repositories. 28 | * [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget 29 | 30 | # [linuxserver/socket-proxy](https://github.com/linuxserver/docker-socket-proxy) 31 | 32 | [![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fsocket-proxy?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fsocket-proxy) 33 | [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-socket-proxy) 34 | [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-socket-proxy/releases) 35 | [![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-socket-proxy/packages) 36 | [![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-socket-proxy/container_registry) 37 | [![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/socket-proxy) 38 | [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/socket-proxy) 39 | [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/socket-proxy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/socket-proxy) 40 | [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-socket-proxy%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-socket-proxy/job/main/) 41 | 42 | The Socket Proxy is a security-enhanced proxy which allows you to apply access rules to the Docker socket, limiting the attack surface for containers such as watchtower or Traefik that need to use it. 43 | 44 | ![socket-proxy](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/docker-logo.png) 45 | 46 | ## Supported Architectures 47 | 48 | We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). 49 | 50 | Simply pulling `lscr.io/linuxserver/socket-proxy:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 51 | 52 | The architectures supported by this image are: 53 | 54 | | Architecture | Available | Tag | 55 | | :----: | :----: | ---- | 56 | | x86-64 | ✅ | amd64-\<version tag\> | 57 | | riscv64 | ✅ | riscv64-\<version tag\> | 58 | | arm64 | ✅ | arm64v8-\<version tag\> | 59 | | armhf | ❌ | | 60 | 61 | ## Application Setup 62 | 63 | This container is conceptually based on [https://github.com/Tecnativa/docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy) and as such does not follow our usual container conventions. It *does not* support mods or custom scripts/services, or running as a user other than root (or the docker user in a rootless environment). It is designed to act as a drop-in replacement for the Tecnativa container. 64 | 65 | The container should be run on the same docker network as the service(s) using it. Most containers that would normally connect to a mounted docker.sock can have their endpoint overridden using the `DOCKER_HOST` environment variable if they do not offer the option in their configuration; it should typically be pointed to `tcp://socket-proxy:2375`. 66 | 67 | * Never expose this container's port to a public network. It should be treated the same way you would treat the docker socket or TCP endpoint. 68 | * Revoke access to any API section that you consider your service should not need. 69 | * To see the versions of the API your Docker daemon and client support, use `docker version` and check the `API version`. 70 | * [Read the docs](https://docs.docker.com/engine/api/) for the API version you are using for an explanation of all the available endpoints. 71 | 72 | ## Read-Only Operation 73 | 74 | This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/). 75 | 76 | ## Usage 77 | 78 | To help you get started creating a container from this image you can either use docker compose or the docker cli. 79 | 80 | >[!NOTE] 81 | >Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided. 82 | 83 | ### docker compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) 84 | 85 | ```yaml 86 | --- 87 | services: 88 | socket-proxy: 89 | image: lscr.io/linuxserver/socket-proxy:latest 90 | container_name: socket-proxy 91 | environment: 92 | - ALLOW_START=0 #optional 93 | - ALLOW_STOP=0 #optional 94 | - ALLOW_RESTARTS=0 #optional 95 | - AUTH=0 #optional 96 | - BUILD=0 #optional 97 | - COMMIT=0 #optional 98 | - CONFIGS=0 #optional 99 | - CONTAINERS=0 #optional 100 | - DISABLE_IPV6=0 #optional 101 | - DISTRIBUTION=0 #optional 102 | - EVENTS=1 #optional 103 | - EXEC=0 #optional 104 | - IMAGES=0 #optional 105 | - INFO=0 #optional 106 | - LOG_LEVEL=info #optional 107 | - NETWORKS=0 #optional 108 | - NODES=0 #optional 109 | - PING=1 #optional 110 | - PLUGINS=0 #optional 111 | - POST=0 #optional 112 | - SECRETS=0 #optional 113 | - SERVICES=0 #optional 114 | - SESSION=0 #optional 115 | - SWARM=0 #optional 116 | - SYSTEM=0 #optional 117 | - TASKS=0 #optional 118 | - VERSION=1 #optional 119 | - VOLUMES=0 #optional 120 | volumes: 121 | - /var/run/docker.sock:/var/run/docker.sock:ro 122 | restart: unless-stopped 123 | read_only: true 124 | tmpfs: 125 | - /run 126 | ``` 127 | 128 | ### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) 129 | 130 | ```bash 131 | docker run -d \ 132 | --name=socket-proxy \ 133 | -e ALLOW_START=0 `#optional` \ 134 | -e ALLOW_STOP=0 `#optional` \ 135 | -e ALLOW_RESTARTS=0 `#optional` \ 136 | -e AUTH=0 `#optional` \ 137 | -e BUILD=0 `#optional` \ 138 | -e COMMIT=0 `#optional` \ 139 | -e CONFIGS=0 `#optional` \ 140 | -e CONTAINERS=0 `#optional` \ 141 | -e DISTRIBUTION=0 `#optional` \ 142 | -e DISABLE_IPV6=0 `#optional` \ 143 | -e EVENTS=1 `#optional` \ 144 | -e EXEC=0 `#optional` \ 145 | -e IMAGES=0 `#optional` \ 146 | -e INFO=0 `#optional` \ 147 | -e LOG_LEVEL=info `#optional` \ 148 | -e NETWORKS=0 `#optional` \ 149 | -e NODES=0 `#optional` \ 150 | -e PING=1 `#optional` \ 151 | -e PLUGINS=0 `#optional` \ 152 | -e POST=0 `#optional` \ 153 | -e SECRETS=0 `#optional` \ 154 | -e SERVICES=0 `#optional` \ 155 | -e SESSION=0 `#optional` \ 156 | -e SWARM=0 `#optional` \ 157 | -e SYSTEM=0 `#optional` \ 158 | -e TASKS=0 `#optional` \ 159 | -e VERSION=1 `#optional` \ 160 | -e VOLUMES=0 `#optional` \ 161 | -v /var/run/docker.sock:/var/run/docker.sock:ro \ 162 | --restart unless-stopped \ 163 | --read-only \ 164 | --tmpfs /run \ 165 | lscr.io/linuxserver/socket-proxy:latest 166 | ``` 167 | 168 | ## Parameters 169 | 170 | Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. 171 | 172 | | Parameter | Function | 173 | | :----: | --- | 174 | | `-e ALLOW_START=0` | `/containers/{id}/start` - **This option will work even if `POST=0`** | 175 | | `-e ALLOW_STOP=0` | `/containers/{id}/stop` - **This option will work even if `POST=0`** | 176 | | `-e ALLOW_RESTARTS=0` | `/containers/{id}/stop`, `/containers/{id}/restart`, and `/containers/{id}/kill` - **This option will work even if `POST=0`** | 177 | | `-e AUTH=0` | `/auth` | 178 | | `-e BUILD=0` | `/build` | 179 | | `-e COMMIT=0` | `/commit` | 180 | | `-e CONFIGS=0` | `/configs` | 181 | | `-e CONTAINERS=0` | `/containers` | 182 | | `-e DISTRIBUTION=0` | `/distribution` | 183 | | `-e DISABLE_IPV6=0` | Set to `1` to prevent binding to the IPv6 interface for legacy systems that cannot support IPv6. | 184 | | `-e EVENTS=1` | `/events` | 185 | | `-e EXEC=0` | `/exec` & `/containers/{id}/exec` | 186 | | `-e IMAGES=0` | `/images` | 187 | | `-e INFO=0` | `/info` | 188 | | `-e LOG_LEVEL=info` | Possible values are: debug, info, notice, warning, err, crit, alert and emerg. Defaults to info. | 189 | | `-e NETWORKS=0` | `/networks` | 190 | | `-e NODES=0` | `/nodes` | 191 | | `-e PING=1` | `/_ping` | 192 | | `-e PLUGINS=0` | `/plugins` | 193 | | `-e POST=0` | When set to `0`, only `GET` and `HEAD` operations are allowed, making API access read-only. | 194 | | `-e SECRETS=0` | `/secrets` | 195 | | `-e SERVICES=0` | `/services` | 196 | | `-e SESSION=0` | `/session` | 197 | | `-e SWARM=0` | `/swarm` | 198 | | `-e SYSTEM=0` | `/system` | 199 | | `-e TASKS=0` | `/tasks` | 200 | | `-e VERSION=1` | `/version` | 201 | | `-e VOLUMES=0` | `/volumes` | 202 | | `-v /var/run/docker.sock:ro` | Mount the host docker socket into the container. | 203 | | `--read-only` | Make the container filesystem read-only. | 204 | | `--tmpfs /run` | Mount /run to tmpfs (RAM) to make it writeable. | 205 | 206 | ## Support Info 207 | 208 | * Shell access whilst the container is running: 209 | 210 | ```bash 211 | docker exec -it socket-proxy /bin/sh 212 | ``` 213 | 214 | * To monitor the logs of the container in realtime: 215 | 216 | ```bash 217 | docker logs -f socket-proxy 218 | ``` 219 | 220 | * Container version number: 221 | 222 | ```bash 223 | docker inspect -f '{{ index .Config.Labels "build_version" }}' socket-proxy 224 | ``` 225 | 226 | * Image version number: 227 | 228 | ```bash 229 | docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/socket-proxy:latest 230 | ``` 231 | 232 | ## Updating Info 233 | 234 | Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image. 235 | 236 | Below are the instructions for updating containers: 237 | 238 | ### Via Docker Compose 239 | 240 | * Update images: 241 | * All images: 242 | 243 | ```bash 244 | docker compose pull 245 | ``` 246 | 247 | * Single image: 248 | 249 | ```bash 250 | docker compose pull socket-proxy 251 | ``` 252 | 253 | * Update containers: 254 | * All containers: 255 | 256 | ```bash 257 | docker compose up -d 258 | ``` 259 | 260 | * Single container: 261 | 262 | ```bash 263 | docker compose up -d socket-proxy 264 | ``` 265 | 266 | * You can also remove the old dangling images: 267 | 268 | ```bash 269 | docker image prune 270 | ``` 271 | 272 | ### Via Docker Run 273 | 274 | * Update the image: 275 | 276 | ```bash 277 | docker pull lscr.io/linuxserver/socket-proxy:latest 278 | ``` 279 | 280 | * Stop the running container: 281 | 282 | ```bash 283 | docker stop socket-proxy 284 | ``` 285 | 286 | * Delete the container: 287 | 288 | ```bash 289 | docker rm socket-proxy 290 | ``` 291 | 292 | * You can also remove the old dangling images: 293 | 294 | ```bash 295 | docker image prune 296 | ``` 297 | 298 | ### Image Update Notifications - Diun (Docker Image Update Notifier) 299 | 300 | >[!TIP] 301 | >We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported. 302 | 303 | ## Building locally 304 | 305 | If you want to make local modifications to these images for development purposes or just to customize the logic: 306 | 307 | ```bash 308 | git clone https://github.com/linuxserver/docker-socket-proxy.git 309 | cd docker-socket-proxy 310 | docker build \ 311 | --no-cache \ 312 | --pull \ 313 | -t lscr.io/linuxserver/socket-proxy:latest . 314 | ``` 315 | 316 | The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/docker-qemu-static` 317 | 318 | ```bash 319 | docker run --rm --privileged lscr.io/linuxserver/docker-qemu-static --reset 320 | ``` 321 | 322 | Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`. 323 | 324 | ## Versions 325 | 326 | * **03.06.25:** - Rebase to Alpine 3.22. Add RISCV support. 327 | * **08.04.25:** - Add `LOG_LEVEL` back. 328 | * **06.04.25:** - Switch back to haproxy for better handling of `docker exec` connection hijacking. 329 | * **02.01.25:** - Support custom read timeout values. 330 | * **05.12.24:** - Rebase to Alpine 3.21. 331 | * **26.08.24:** - Change `ALLOW_START`, `ALLOW_STOP`, and `ALLOW_RESTARTS` to work even with `POST=0`. 332 | * **24.05.24:** - Rebase to Alpine 3.20. 333 | * **15.04.24:** - Allow disabling IPv6 support for legacy devices. 334 | * **08.04.24:** - Use nginx due to haproxy's wonky websockets handling. 335 | * **07.04.24:** - Initial Release. 336 | 337 | {%- endraw %} 338 | -------------------------------------------------------------------------------- /root/docker-entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | mkdir -p /run/haproxy 4 | 5 | if [ "${DISABLE_IPV6}" = 1 ]; then 6 | BIND_PROTO=":2375" 7 | else 8 | BIND_PROTO="[::]:2375 v4v6" 9 | fi 10 | 11 | sed "s/@@BIND_PROTO@@/${BIND_PROTO}/g" /templates/haproxy.cfg > /run/haproxy/haproxy.cfg 12 | 13 | echo ' 14 | ─────────────────────────────────────── 15 | 16 | ██╗ ███████╗██╗ ██████╗ 17 | ██║ ██╔════╝██║██╔═══██╗ 18 | ██║ ███████╗██║██║ ██║ 19 | ██║ ╚════██║██║██║ ██║ 20 | ███████╗███████║██║╚██████╔╝ 21 | ╚══════╝╚══════╝╚═╝ ╚═════╝ 22 | 23 | Brought to you by linuxserver.io 24 | ─────────────────────────────────────── 25 | ─────────────────────────────────────── 26 | 27 | To support LSIO projects visit: 28 | https://www.linuxserver.io/donate/ 29 | 30 | ───────────────────────────────────────' 31 | if [ -f /build_version ]; then 32 | cat /build_version 33 | echo ' 34 | ─────────────────────────────────────── 35 | ' 36 | fi 37 | 38 | echo "[ls.io-init] done." 39 | 40 | exec /usr/sbin/haproxy -f /run/haproxy/haproxy.cfg -W -db 41 | -------------------------------------------------------------------------------- /root/templates/haproxy.cfg: -------------------------------------------------------------------------------- 1 | global 2 | log stdout format raw daemon "${LOG_LEVEL}" 3 | pidfile /run/haproxy.pid 4 | maxconn 2000 5 | 6 | defaults 7 | mode http 8 | log global 9 | option httplog 10 | option dontlognull 11 | option http-server-close 12 | option redispatch 13 | retries 3 14 | timeout http-request 10s 15 | timeout queue 1m 16 | timeout connect 10s 17 | timeout client 10m 18 | timeout server 10m 19 | timeout http-keep-alive 10s 20 | timeout check 10s 21 | maxconn 2000 22 | 23 | backend docker 24 | server socket $SOCKET_PATH 25 | 26 | frontend proxy 27 | bind @@BIND_PROTO@@ 28 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/containers/[a-zA-Z0-9_.-]+/((stop)|(restart)|(kill)) } { env(ALLOW_RESTARTS) -m bool } 29 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/containers/[a-zA-Z0-9_.-]+/start } { env(ALLOW_START) -m bool } 30 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/containers/[a-zA-Z0-9_.-]+/stop } { env(ALLOW_STOP) -m bool } 31 | http-request deny unless METH_GET || { env(POST) -m bool } 32 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/auth } { env(AUTH) -m bool } 33 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/build } { env(BUILD) -m bool } 34 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/commit } { env(COMMIT) -m bool } 35 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/configs } { env(CONFIGS) -m bool } 36 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/containers } { env(CONTAINERS) -m bool } 37 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/distribution } { env(DISTRIBUTION) -m bool } 38 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/events } { env(EVENTS) -m bool } 39 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/exec } { env(EXEC) -m bool } 40 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/grpc } { env(GRPC) -m bool } 41 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/images } { env(IMAGES) -m bool } 42 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/info } { env(INFO) -m bool } 43 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/networks } { env(NETWORKS) -m bool } 44 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/nodes } { env(NODES) -m bool } 45 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/_ping } { env(PING) -m bool } 46 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/plugins } { env(PLUGINS) -m bool } 47 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/secrets } { env(SECRETS) -m bool } 48 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/services } { env(SERVICES) -m bool } 49 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/session } { env(SESSION) -m bool } 50 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/swarm } { env(SWARM) -m bool } 51 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/system } { env(SYSTEM) -m bool } 52 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/tasks } { env(TASKS) -m bool } 53 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/version } { env(VERSION) -m bool } 54 | http-request allow if { path,url_dec -m reg -i ^(/v[\d\.]+)?/volumes } { env(VOLUMES) -m bool } 55 | http-request deny 56 | default_backend docker 57 | --------------------------------------------------------------------------------