From d872f48a55d79ca8bd740f0bf4a24243e2384c89 Mon Sep 17 00:00:00 2001 From: thespad Date: Tue, 3 Jun 2025 13:33:39 +0100 Subject: [PATCH 01/14] Update permissions on workflow templates --- ansible/roles/github/templates/call_issue_pr_tracker.yml.j2 | 3 +++ ansible/roles/github/templates/call_issues_cron.yml.j2 | 3 +++ ansible/roles/github/templates/external_trigger.yml.j2 | 3 +++ .../github/templates/external_trigger_scheduler.yml.j2 | 3 +++ ansible/roles/github/templates/greetings.yml.j2 | 6 ++++++ .../roles/github/templates/package_trigger_scheduler.yml.j2 | 3 +++ 6 files changed, 21 insertions(+) diff --git a/ansible/roles/github/templates/call_issue_pr_tracker.yml.j2 b/ansible/roles/github/templates/call_issue_pr_tracker.yml.j2 index 2c307843..d07cf121 100644 --- a/ansible/roles/github/templates/call_issue_pr_tracker.yml.j2 +++ b/ansible/roles/github/templates/call_issue_pr_tracker.yml.j2 @@ -8,6 +8,9 @@ on: pull_request_review: types: [submitted,edited,dismissed] +permissions: + contents: read + jobs: manage-project: permissions: diff --git a/ansible/roles/github/templates/call_issues_cron.yml.j2 b/ansible/roles/github/templates/call_issues_cron.yml.j2 index ce11487e..b31c33cb 100644 --- a/ansible/roles/github/templates/call_issues_cron.yml.j2 +++ b/ansible/roles/github/templates/call_issues_cron.yml.j2 @@ -4,6 +4,9 @@ on: - cron: '{{ 60 | random(seed=('docker-' + project_name + '-minute')) }} {{ 24 | random(seed=('docker-' + project_name + '-hour')) }} * * *' workflow_dispatch: +permissions: + contents: read + jobs: stale: permissions: diff --git a/ansible/roles/github/templates/external_trigger.yml.j2 b/ansible/roles/github/templates/external_trigger.yml.j2 index f57e87af..dec72a5c 100644 --- a/ansible/roles/github/templates/external_trigger.yml.j2 +++ b/ansible/roles/github/templates/external_trigger.yml.j2 @@ -10,6 +10,9 @@ name: External Trigger Main on: workflow_dispatch: +permissions: + contents: read + jobs: external-trigger-{{ ls_branch|regex_replace('[^a-zA-Z0-9-]','-') }}: runs-on: ubuntu-latest diff --git a/ansible/roles/github/templates/external_trigger_scheduler.yml.j2 b/ansible/roles/github/templates/external_trigger_scheduler.yml.j2 index 5f327898..661ab5a3 100644 --- a/ansible/roles/github/templates/external_trigger_scheduler.yml.j2 +++ b/ansible/roles/github/templates/external_trigger_scheduler.yml.j2 @@ -5,6 +5,9 @@ on: - cron: '{{ 60 | random(seed=(project_name + '-external-minute')) }} * * * *' workflow_dispatch: +permissions: + contents: read + jobs: external-trigger-scheduler: runs-on: ubuntu-latest diff --git a/ansible/roles/github/templates/greetings.yml.j2 b/ansible/roles/github/templates/greetings.yml.j2 index 548282a6..ee1c1103 100644 --- a/ansible/roles/github/templates/greetings.yml.j2 +++ b/ansible/roles/github/templates/greetings.yml.j2 @@ -2,8 +2,14 @@ name: Greetings on: [pull_request_target, issues] +permissions: + contents: read + jobs: greeting: + permissions: + issues: write + pull-requests: write runs-on: ubuntu-latest steps: - uses: actions/first-interaction@v1 diff --git a/ansible/roles/github/templates/package_trigger_scheduler.yml.j2 b/ansible/roles/github/templates/package_trigger_scheduler.yml.j2 index ceb71c9f..4f70f9ad 100644 --- a/ansible/roles/github/templates/package_trigger_scheduler.yml.j2 +++ b/ansible/roles/github/templates/package_trigger_scheduler.yml.j2 @@ -5,6 +5,9 @@ on: - cron: '{{ 60 | random(seed=(project_name + '-minute')) }} {{ 24 | random(seed=(project_name + '-hour')) }} * * {{ 7 | random(seed=(project_name + '-day')) }}' workflow_dispatch: +permissions: + contents: read + jobs: package-trigger-scheduler: runs-on: ubuntu-latest From c7589363c068b64e552dcfdfef89b0ea5c32a76d Mon Sep 17 00:00:00 2001 From: thespad Date: Tue, 3 Jun 2025 13:34:44 +0100 Subject: [PATCH 02/14] Remove armhf from arch table --- .../templates/README_SNIPPETS/SUPPORTED_ARCHITECTURES.j2 | 1 - 1 file changed, 1 deletion(-) diff --git a/ansible/roles/documentation/templates/README_SNIPPETS/SUPPORTED_ARCHITECTURES.j2 b/ansible/roles/documentation/templates/README_SNIPPETS/SUPPORTED_ARCHITECTURES.j2 index 6adae53a..16e84d8d 100644 --- a/ansible/roles/documentation/templates/README_SNIPPETS/SUPPORTED_ARCHITECTURES.j2 +++ b/ansible/roles/documentation/templates/README_SNIPPETS/SUPPORTED_ARCHITECTURES.j2 @@ -13,4 +13,3 @@ The architectures supported by this image are: | riscv64 | {{ '✅ | riscv64-\' }} | {% endif %} | arm64 | {{ '✅ | arm64v8-\' if 'arm64' in (available_architectures | map(attribute="arch") ) else '❌ |' }} | -| armhf | {{ '✅ | arm32v7-\' if 'armhf' in (available_architectures | map(attribute="arch") ) else '❌ |' }} | From c0f74be1289ff1c4252e3ac7416f1c1c02c02d07 Mon Sep 17 00:00:00 2001 From: aptalca <541623+aptalca@users.noreply.github.com> Date: Tue, 3 Jun 2025 15:10:38 -0400 Subject: [PATCH 03/14] keep sanitized and raw external versions separate in external trigger --- ansible/roles/github/templates/external_trigger.yml.j2 | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ansible/roles/github/templates/external_trigger.yml.j2 b/ansible/roles/github/templates/external_trigger.yml.j2 index f57e87af..fa96d323 100644 --- a/ansible/roles/github/templates/external_trigger.yml.j2 +++ b/ansible/roles/github/templates/external_trigger.yml.j2 @@ -107,7 +107,7 @@ jobs: "username": "Github Actions"}' ${{ '{{' }} secrets.DISCORD_WEBHOOK {{ '}}' }} exit 1 fi - EXT_RELEASE=$(echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g') + EXT_RELEASE_SANITIZED=$(echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g') echo "External version: \`${EXT_RELEASE}\`" >> $GITHUB_STEP_SUMMARY echo "Retrieving last pushed version" >> $GITHUB_STEP_SUMMARY image="{{ better_vars.LS_USER }}/{{ project_name }}" @@ -164,7 +164,7 @@ jobs: exit 1 fi echo "Last pushed version: \`${IMAGE_VERSION}\`" >> $GITHUB_STEP_SUMMARY - if [ "${EXT_RELEASE}" == "${IMAGE_VERSION}" ]; then + if [ "${EXT_RELEASE_SANITIZED}" == "${IMAGE_VERSION}" ]; then echo "Version \`${EXT_RELEASE}\` already pushed, exiting" >> $GITHUB_STEP_SUMMARY exit 0 {% if external_type == "alpine_repo" and better_vars.MULTIARCH == 'true' %} @@ -197,7 +197,7 @@ jobs: "username": "Github Actions"}' ${{ '{{' }} secrets.DISCORD_WEBHOOK {{ '}}' }} else printf "\n## Trigger new build\n\n" >> $GITHUB_STEP_SUMMARY - echo "New version \`${EXT_RELEASE}\` found; old version was \`${IMAGE_VERSION}\`. Triggering new build" >> $GITHUB_STEP_SUMMARY + echo "New sanitized version \`${EXT_RELEASE_SANITIZED}\` found; old version was \`${IMAGE_VERSION}\`. Triggering new build" >> $GITHUB_STEP_SUMMARY if [[ "${artifacts_found}" == "true" ]]; then echo "All artifacts seem to be uploaded." >> $GITHUB_STEP_SUMMARY fi @@ -217,7 +217,7 @@ jobs: --data-urlencode "description=GHA external trigger https://github.com/${{ '{{' }} github.repository {{ '}}' }}/actions/runs/${{ '{{' }} github.run_id {{ '}}' }}" \ --data-urlencode "Submit=Submit" echo "**** Notifying Discord ****" - TRIGGER_REASON="A version change was detected for {{ project_name }} tag {{ release_tag }}. Old version:${IMAGE_VERSION} New version:${EXT_RELEASE}" + TRIGGER_REASON="A version change was detected for {{ project_name }} tag {{ release_tag }}. Old version:${IMAGE_VERSION} New version:${EXT_RELEASE_SANITIZED}" curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, "description": "**Build Triggered** \n**Reason:** '"${TRIGGER_REASON}"' \n**Build URL:** '"${buildurl}display/redirect"' \n"}], "username": "Github Actions"}' ${{ '{{' }} secrets.DISCORD_WEBHOOK {{ '}}' }} From 8610b2342bcfad15d17efa363226561f93300d67 Mon Sep 17 00:00:00 2001 From: aptalca <541623+aptalca@users.noreply.github.com> Date: Tue, 3 Jun 2025 15:16:58 -0400 Subject: [PATCH 04/14] Clarify logs --- ansible/roles/github/templates/external_trigger.yml.j2 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ansible/roles/github/templates/external_trigger.yml.j2 b/ansible/roles/github/templates/external_trigger.yml.j2 index fa96d323..6f94725a 100644 --- a/ansible/roles/github/templates/external_trigger.yml.j2 +++ b/ansible/roles/github/templates/external_trigger.yml.j2 @@ -108,7 +108,7 @@ jobs: exit 1 fi EXT_RELEASE_SANITIZED=$(echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g') - echo "External version: \`${EXT_RELEASE}\`" >> $GITHUB_STEP_SUMMARY + echo "Sanitized external version: \`${EXT_RELEASE_SANITIZED}\`" >> $GITHUB_STEP_SUMMARY echo "Retrieving last pushed version" >> $GITHUB_STEP_SUMMARY image="{{ better_vars.LS_USER }}/{{ project_name }}" tag="{{ release_tag }}" @@ -165,7 +165,7 @@ jobs: fi echo "Last pushed version: \`${IMAGE_VERSION}\`" >> $GITHUB_STEP_SUMMARY if [ "${EXT_RELEASE_SANITIZED}" == "${IMAGE_VERSION}" ]; then - echo "Version \`${EXT_RELEASE}\` already pushed, exiting" >> $GITHUB_STEP_SUMMARY + echo "Sanitized version \`${EXT_RELEASE_SANITIZED}\` already pushed, exiting" >> $GITHUB_STEP_SUMMARY exit 0 {% if external_type == "alpine_repo" and better_vars.MULTIARCH == 'true' %} elif [[ $(curl -sL "{{ better_vars.DIST_REPO }}aarch64/APKINDEX.tar.gz" | tar -xz -C /tmp && awk '/^P:'"{{ better_vars.DIST_REPO_PACKAGES }}"'$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://') != "${EXT_RELEASE}" ]]{% if build_armhf %} || [[ $(curl -sL "{{ better_vars.DIST_REPO }}armv7/APKINDEX.tar.gz" | tar -xz -C /tmp && awk '/^P:'"{{ better_vars.DIST_REPO_PACKAGES }}"'$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://') != "${EXT_RELEASE}" ]]{% endif %}; then From 93e7a7fdb447e045403ec15ebcb6038d9fb9c950 Mon Sep 17 00:00:00 2001 From: quietsy Date: Tue, 3 Jun 2025 23:07:54 +0300 Subject: [PATCH 05/14] Remove fleet --- .../documentation/templates/README_SNIPPETS/GROUP_BADGES.j2 | 1 - .../documentation/templates/README_SNIPPETS/GROUP_INFO.j2 | 1 - ansible/vars/common.yml | 3 --- 3 files changed, 5 deletions(-) diff --git a/ansible/roles/documentation/templates/README_SNIPPETS/GROUP_BADGES.j2 b/ansible/roles/documentation/templates/README_SNIPPETS/GROUP_BADGES.j2 index 178052d4..7eec3f13 100644 --- a/ansible/roles/documentation/templates/README_SNIPPETS/GROUP_BADGES.j2 +++ b/ansible/roles/documentation/templates/README_SNIPPETS/GROUP_BADGES.j2 @@ -1,6 +1,5 @@ [![Blog]({{ lsio_shieldsio_static_blog }})]({{ lsio_blog_url }} "{{ lsio_blog_desc }}") [![Discord]({{ lsio_shieldsio_discord }})]({{ lsio_discord_url }} "{{ lsio_discord_desc }}") [![Discourse]({{ lsio_shieldsio_discourse_topics }})]({{ lsio_discourse_url }} "{{ lsio_discourse_desc }}") -[![Fleet]({{ lsio_shieldsio_static_fleet }})]({{ lsio_fleet_url }} "{{ lsio_fleet_desc }}") [![GitHub]({{ lsio_shieldsio_static_github }})]({{ lsio_github_url }} "{{ lsio_github_desc }}") [![Open Collective]({{ lsio_shieldsio_opencollective_all }})]({{ lsio_opencollective_url }} "{{ lsio_opencollective_desc }}") diff --git a/ansible/roles/documentation/templates/README_SNIPPETS/GROUP_INFO.j2 b/ansible/roles/documentation/templates/README_SNIPPETS/GROUP_INFO.j2 index 8205560e..d93ff375 100644 --- a/ansible/roles/documentation/templates/README_SNIPPETS/GROUP_INFO.j2 +++ b/ansible/roles/documentation/templates/README_SNIPPETS/GROUP_INFO.j2 @@ -15,6 +15,5 @@ Find us at: * [Blog]({{ lsio_blog_url }}) - {{ lsio_blog_desc }} * [Discord]({{ lsio_discord_url }}) - {{ lsio_discord_desc }} * [Discourse]({{ lsio_discourse_url }}) - {{ lsio_discourse_desc }} -* [Fleet]({{ lsio_fleet_url }}) - {{ lsio_fleet_desc }} * [GitHub]({{ lsio_github_url }}) - {{ lsio_github_desc }} * [Open Collective]({{ lsio_opencollective_url }}) - {{ lsio_opencollective_desc }} diff --git a/ansible/vars/common.yml b/ansible/vars/common.yml index 5b70b45f..de75e470 100644 --- a/ansible/vars/common.yml +++ b/ansible/vars/common.yml @@ -14,7 +14,6 @@ lsio_discord_url: "https://linuxserver.io/discord" lsio_discourse_url: "https://discourse.{{ lsio_short_url }}" lsio_docker_hub_url: "https://hub.docker.com/r/{{ lsio_project_name_short }}" lsio_docs_url: "https://docs.{{ lsio_short_url }}" -lsio_fleet_url: "https://fleet.{{ lsio_short_url }}" lsio_github_url: "https://github.com/{{ lsio_project_name_short }}" lsio_gitlab_url: "https://gitlab.com/{{ lsio_project_name }}" lsio_mods_url: "https://mods.{{ lsio_short_url }}/?mod={{ project_name }}" @@ -38,7 +37,6 @@ arch_armhf: "armhf" lsio_blog_desc: "all the things you can do with our containers including How-To guides, opinions and much more!" lsio_discord_desc: "realtime support / chat with the community and the team." lsio_discourse_desc: "post on our community forum." -lsio_fleet_desc: "an online web interface which displays all of our maintained images." lsio_github_desc: "view the source for all of our repositories." lsio_mods_desc: "view available mods for this container." lsio_universal_mods_desc: "view available universal mods." @@ -72,7 +70,6 @@ lsio_shieldsio_jenkins_build: "https://img.shields.io/jenkins/build?{{ lsio_badg lsio_shieldsio_microbadger_layers: "https://img.shields.io/microbadger/layers/{{ lsio_project_name_short }}/{{ project_name }}.svg?{{ lsio_badge_url_parameters }}" lsio_shieldsio_opencollective_all: "https://img.shields.io/opencollective/all/{{ lsio_project_name_short }}.svg?{{ lsio_badge_url_parameters }}&label=Supporters&logo=open%20collective" lsio_shieldsio_static_blog: "https://img.shields.io/static/v1.svg?{{ lsio_badge_url_parameters }}&label={{ lsio_project_name }}&message=Blog" -lsio_shieldsio_static_fleet: "https://img.shields.io/static/v1.svg?{{ lsio_badge_url_parameters }}&label={{ lsio_project_name }}&message=Fleet" lsio_shieldsio_static_github_package: "https://img.shields.io/static/v1.svg?{{ lsio_badge_url_parameters }}&label={{ lsio_project_name }}&message=GitHub%20Package&logo=github" lsio_shieldsio_static_github: "https://img.shields.io/static/v1.svg?{{ lsio_badge_url_parameters }}&label={{ lsio_project_name }}&message=GitHub&logo=github" lsio_shieldsio_static_gitlab_registry: "https://img.shields.io/static/v1.svg?{{ lsio_badge_url_parameters }}&label={{ lsio_project_name }}&message=GitLab%20Registry&logo=gitlab" From 864b2ca6df954ba12354b420017d971e8a1d841a Mon Sep 17 00:00:00 2001 From: aptalca <541623+aptalca@users.noreply.github.com> Date: Tue, 10 Jun 2025 10:41:45 -0400 Subject: [PATCH 06/14] Retrieve syft image tag from jenkins env vars, default to latest --- ansible/roles/repository/templates/Jenkinsfile.j2 | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/ansible/roles/repository/templates/Jenkinsfile.j2 b/ansible/roles/repository/templates/Jenkinsfile.j2 index 535894b8..e7e041ee 100644 --- a/ansible/roles/repository/templates/Jenkinsfile.j2 +++ b/ansible/roles/repository/templates/Jenkinsfile.j2 @@ -80,7 +80,11 @@ pipeline { env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DOCKERHUB_IMAGE + '/tags/' env.PULL_REQUEST = env.CHANGE_ID 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{% if project_deprecation_status != true %} ./.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{% if custom_external_trigger != true %} ./.github/workflows/external_trigger.yml{% endif %}{% endif %}{% if sponsor_links is defined %} ./root/donate.txt{% endif %}{% if project_deprecation_status %} ./root/etc/s6-overlay/s6-rc.d/init-deprecate/run ./root/etc/s6-overlay/s6-rc.d/init-deprecate/up ./root/etc/s6-overlay/s6-rc.d/init-deprecate/type ./root/etc/s6-overlay/s6-rc.d/init-deprecate/dependencies.d/init-config-end ./root/etc/s6-overlay/s6-rc.d/init-services/dependencies.d/init-deprecate ./root/etc/s6-overlay/s6-rc.d/user/contents.d/init-deprecate{% endif %}' + if ( env.SYFT_IMAGE_TAG == null ) { + env.SYFT_IMAGE_TAG = 'latest' + } } + echo "Using syft image tag ${SYFT_IMAGE_TAG}" sh '''#! /bin/bash echo "The default github branch detected as ${GH_DEFAULT_BRANCH}" ''' script{ @@ -1082,7 +1086,7 @@ pipeline { docker run --rm \ -v /var/run/docker.sock:/var/run/docker.sock:ro \ -v ${TEMPDIR}:/tmp \ - ghcr.io/anchore/syft:latest \ + ghcr.io/anchore/syft:${SYFT_IMAGE_TAG} \ ${LOCAL_CONTAINER} -o table=/tmp/package_versions.txt NEW_PACKAGE_TAG=$(md5sum ${TEMPDIR}/package_versions.txt | cut -c1-8 ) echo "Package tag sha from current packages in buit container is ${NEW_PACKAGE_TAG} comparing to old ${PACKAGE_TAG} from github" @@ -1210,6 +1214,7 @@ pipeline { -e WEB_AUTH=\"${CI_AUTH}\" \ -e WEB_PATH=\"${CI_WEBPATH}\" \ -e NODE_NAME=\"${NODE_NAME}\" \ + -e SYFT_IMAGE_TAG=\"${SYFT_IMAGE_TAG}\" \ -t ghcr.io/linuxserver/ci:latest \ python3 test_build.py''' } From bb00a6d6b01058a648a8f23da34715db21274d33 Mon Sep 17 00:00:00 2001 From: aptalca <541623+aptalca@users.noreply.github.com> Date: Tue, 10 Jun 2025 13:16:44 -0400 Subject: [PATCH 07/14] use CI_SYFT_IMAGE_TAG for the ci test, with fall back to SYFT_IMAGE_TAG --- ansible/roles/repository/templates/Jenkinsfile.j2 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ansible/roles/repository/templates/Jenkinsfile.j2 b/ansible/roles/repository/templates/Jenkinsfile.j2 index e7e041ee..6ae98659 100644 --- a/ansible/roles/repository/templates/Jenkinsfile.j2 +++ b/ansible/roles/repository/templates/Jenkinsfile.j2 @@ -1214,7 +1214,7 @@ pipeline { -e WEB_AUTH=\"${CI_AUTH}\" \ -e WEB_PATH=\"${CI_WEBPATH}\" \ -e NODE_NAME=\"${NODE_NAME}\" \ - -e SYFT_IMAGE_TAG=\"${SYFT_IMAGE_TAG}\" \ + -e SYFT_IMAGE_TAG=\"${CI_SYFT_IMAGE_TAG:${SYFT_IMAGE_TAG}}\" \ -t ghcr.io/linuxserver/ci:latest \ python3 test_build.py''' } From 6d87c54f0e14214682932bda37319d6137c197ee Mon Sep 17 00:00:00 2001 From: Ryan Kuba Date: Mon, 16 Jun 2025 00:37:27 +0000 Subject: [PATCH 08/14] add selkies blurb for readmes (#341) * add selkies blurb for readmes * typo --- .../templates/README_SNIPPETS/SELKIES.j2 | 104 ++++++++++++++++++ .../templates/documentation.md.j2 | 4 + .../documentation/templates/readme.md.j2 | 4 + 3 files changed, 112 insertions(+) create mode 100644 ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 diff --git a/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 b/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 new file mode 100644 index 00000000..60a34d71 --- /dev/null +++ b/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 @@ -0,0 +1,104 @@ +**Modern GUI desktop apps have issues with the latest Docker and syscall compatibility, you can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls on hosts with older Kernels or libseccomp** + +### Security + +{{ "Do not put this on the Internet if you do not know what you are doing." | admonition(flavour=markdown, severity="warning") }} + +By default this container has no authentication and the optional environment variables `CUSTOM_USER` and `PASSWORD` to enable basic http auth via the embedded NGINX server should only be used to locally secure the container from unwanted access on a local network. If exposing this to the Internet we recommend putting it behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), and ensuring a secure authentication solution is in place. From the web interface a terminal can be launched and it is configured for passwordless sudo, so anyone with access to it can install and run whatever they want along with probing your local network. + +### Options in all Selkies based GUI containers + +This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies) which means there are additional environment variables and run configurations to enable or disable specific functionality. + +#### Optional environment variables + +| Variable | Description | +| :----: | --- | +| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default {% if external_http_port is defined %}{{ external_http_port }}{% else %}3000{% endif %}. | +| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default {% if external_https_port is defined %}{{ external_https_port }}{% else %}3001{% endif %}. | +| CUSTOM_USER | HTTP Basic auth username, abc is default. | +| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth | +| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` | +| TITLE | The page title displayed on the web browser, default "Selkies". | +| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. | +| DISABLE_IPV6 | If set to true or any value this will disable IPv6 | +| LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8` `ar_AE.UTF-8` | +| NO_DECOR | If set the application will run without window borders in openbox for use as a PWA. | +| NO_FULL | Do not automatically fullscreen applications when using openbox. | + +#### Optional run configurations + +| Variable | Description | +| :----: | --- | +| `--privileged` | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE `-v /home/user/docker-data:/var/lib/docker`. | +| `-v /var/run/docker.sock:/var/run/docker.sock` | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. | + +### Language Support - Internationalization + +The environment variable `LC_ALL` can be used to start this container in a different language than English simply pass for example to launch the Desktop session in French `LC_ALL=fr_FR.UTF-8`. Some supported languages: + +* `-e LC_ALL=zh_CN.UTF-8` - Chinese +* `-e LC_ALL=ja_JP.UTF-8` - Japanese +* `-e LC_ALL=ko_KR.UTF-8` - Korean +* `-e LC_ALL=ar_AE.UTF-8` - Arabic +* `-e LC_ALL=ru_RU.UTF-8` - Russian +* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America) +* `-e LC_ALL=de_DE.UTF-8` - German +* `-e LC_ALL=fr_FR.UTF-8` - French +* `-e LC_ALL=nl_NL.UTF-8` - Netherlands +* `-e LC_ALL=it_IT.UTF-8` - Italian + +{% if show_nvidia is defined %}### Nvidia GPU Support + +**Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers** + +Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags: + +| Variable | Description | +| :----: | --- | +| --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system | +| --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host | + +The compose syntax is slightly different for this as you will need to set nvidia as the default runtime: + +``` +sudo nvidia-ctk runtime configure --runtime=docker --set-as-default +sudo service docker restart +``` + +And to assign the GPU in compose: + +``` +services: + {{ project_name }}: + image: lscr.io/{{ lsio_project_name_short }}/{{ project_name }}:{{ release_tag }} + deploy: + resources: + reservations: + devices: + - driver: nvidia + count: 1 + capabilities: [compute,video,graphics,utility] +``` + +{% endif %}### Application management + +#### PRoot Apps + +If you run system native installations of software IE `sudo apt-get install filezilla` and then upgrade or destroy/re-create the container that software will be removed and the container will be at a clean state. For some users that will be acceptable and they can update their system packages as well using system native commands like `apt-get upgrade`. If you want Docker to handle upgrading the container and retain your applications and settings we have created [proot-apps](https://github.com/linuxserver/proot-apps) which allow portable applications to be installed to persistent storage in the user's `$HOME` directory and they will work in a confined Docker environment out of the box. These applications and their settings will persist upgrades of the base container and can be mounted into different flavors ofSelkiess based containers on the fly. This can be achieved from the command line with: + +``` +proot-apps install filezilla +``` + +PRoot Apps is included in all Selkies based containers, a list of linuxserver.io supported applications is located [HERE](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps). + +#### Native Apps + +It is possible to install extra packages during container start using [universal-package-install](https://github.com/linuxserver/docker-mods/tree/universal-package-install). It might increase starting time significantly. PRoot is preferred. + +```yaml + environment: + - DOCKER_MODS=linuxserver/mods:universal-package-install + - INSTALL_PACKAGES=libfuse2|git|gdb +``` diff --git a/ansible/roles/documentation/templates/documentation.md.j2 b/ansible/roles/documentation/templates/documentation.md.j2 index b0d68661..0bb4a179 100644 --- a/ansible/roles/documentation/templates/documentation.md.j2 +++ b/ansible/roles/documentation/templates/documentation.md.j2 @@ -64,6 +64,10 @@ description: "{{ noter(project_blurb) | trim }}" {% if kasm_blurb is defined %} {% include "README_SNIPPETS/KASM.j2" | trim %} +{% endif %} +{% if selkies_blurb is defined %} +{% include "README_SNIPPETS/SELKIES.j2" | trim %} + {% endif %} {% if readonly_supported is defined and readonly_supported %} {% include "README_SNIPPETS/READONLY.j2" | trim %} diff --git a/ansible/roles/documentation/templates/readme.md.j2 b/ansible/roles/documentation/templates/readme.md.j2 index fe54b74f..35ef54d8 100644 --- a/ansible/roles/documentation/templates/readme.md.j2 +++ b/ansible/roles/documentation/templates/readme.md.j2 @@ -55,6 +55,10 @@ {% if kasm_blurb is defined %} {% include "README_SNIPPETS/KASM.j2" | trim %} +{% endif %} +{% if selkies_blurb is defined %} +{% include "README_SNIPPETS/SELKIES.j2" | trim %} + {% endif %} {% if readonly_supported is defined and readonly_supported %} {% include "README_SNIPPETS/READONLY.j2" | trim %} From 7430366dfa2ae1bfde30a49f7373dcae0a033811 Mon Sep 17 00:00:00 2001 From: thelamer Date: Thu, 26 Jun 2025 10:41:57 -0400 Subject: [PATCH 09/14] append more options to selkies blurb --- .../documentation/templates/README_SNIPPETS/SELKIES.j2 | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 b/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 index 60a34d71..f05f1963 100644 --- a/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 +++ b/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 @@ -25,6 +25,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse | LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8` `ar_AE.UTF-8` | | NO_DECOR | If set the application will run without window borders in openbox for use as a PWA. | | NO_FULL | Do not automatically fullscreen applications when using openbox. | +| DISABLE_ZINK | Do not set zink related environment variables when a video card is detected. | +| WATERMARK_PNG | Full path inside the container to a watermark png IE `/config/image.png` | +| WATERMARK_LOCATION | Where to paint the image over the stream integer options below | + +* 1 - Top Left +* 2 - Top Right +* 3 - Bottom Left +* 4 - Bottom Right +* 5 - Centered +* 6 - Animated #### Optional run configurations From 47f91b53a2e2998db6633a9cdc39e69b3084f4e3 Mon Sep 17 00:00:00 2001 From: thelamer Date: Sat, 28 Jun 2025 09:39:49 -0400 Subject: [PATCH 10/14] add working path for watermark --- .../roles/documentation/templates/README_SNIPPETS/SELKIES.j2 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 b/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 index f05f1963..350fc240 100644 --- a/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 +++ b/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 @@ -26,7 +26,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse | NO_DECOR | If set the application will run without window borders in openbox for use as a PWA. | | NO_FULL | Do not automatically fullscreen applications when using openbox. | | DISABLE_ZINK | Do not set zink related environment variables when a video card is detected. | -| WATERMARK_PNG | Full path inside the container to a watermark png IE `/config/image.png` | +| WATERMARK_PNG | Full path inside the container to a watermark png IE `/usr/share/selkies/www/icon.png` | | WATERMARK_LOCATION | Where to paint the image over the stream integer options below | * 1 - Top Left From fb96c88d69b2e4be25157a1ac42a02acbe5e14d0 Mon Sep 17 00:00:00 2001 From: thelamer Date: Sat, 28 Jun 2025 09:49:51 -0400 Subject: [PATCH 11/14] general blurb cleanup emphasize https and nvidia encoding support --- .../templates/README_SNIPPETS/SELKIES.j2 | 119 +++++++++--------- 1 file changed, 61 insertions(+), 58 deletions(-) diff --git a/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 b/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 index 350fc240..4a3742ac 100644 --- a/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 +++ b/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 @@ -1,82 +1,81 @@ -**Modern GUI desktop apps have issues with the latest Docker and syscall compatibility, you can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls on hosts with older Kernels or libseccomp** +**Modern GUI desktop apps may have compatibility issues with the latest Docker syscall restrictions. You can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls on hosts with older Kernels or libseccomp versions.** ### Security -{{ "Do not put this on the Internet if you do not know what you are doing." | admonition(flavour=markdown, severity="warning") }} +{{ "This container provides privileged access to the host system. Do not expose it to the Internet unless you have secured it properly." | admonition(flavour=markdown, severity="warning") }} -By default this container has no authentication and the optional environment variables `CUSTOM_USER` and `PASSWORD` to enable basic http auth via the embedded NGINX server should only be used to locally secure the container from unwanted access on a local network. If exposing this to the Internet we recommend putting it behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), and ensuring a secure authentication solution is in place. From the web interface a terminal can be launched and it is configured for passwordless sudo, so anyone with access to it can install and run whatever they want along with probing your local network. +**HTTPS is required for full functionality.** Modern browser features such as WebCodecs, used for video and audio, will not function over an insecure HTTP connection. -### Options in all Selkies based GUI containers +By default, this container has no authentication. The optional `CUSTOM_USER` and `PASSWORD` environment variables enable basic HTTP auth, which is suitable only for securing the container on a trusted local network. For internet exposure, we strongly recommend placing the container behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), with a robust authentication mechanism. -This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies) which means there are additional environment variables and run configurations to enable or disable specific functionality. +The web interface includes a terminal with passwordless `sudo` access. Any user with access to the GUI can gain root control within the container, install arbitrary software, and probe your local network. -#### Optional environment variables +### Options in all Selkies-based GUI containers -| Variable | Description | -| :----: | --- | -| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default {% if external_http_port is defined %}{{ external_http_port }}{% else %}3000{% endif %}. | -| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default {% if external_https_port is defined %}{{ external_https_port }}{% else %}3001{% endif %}. | -| CUSTOM_USER | HTTP Basic auth username, abc is default. | -| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth | -| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` | -| TITLE | The page title displayed on the web browser, default "Selkies". | -| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. | -| DISABLE_IPV6 | If set to true or any value this will disable IPv6 | -| LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8` `ar_AE.UTF-8` | -| NO_DECOR | If set the application will run without window borders in openbox for use as a PWA. | -| NO_FULL | Do not automatically fullscreen applications when using openbox. | -| DISABLE_ZINK | Do not set zink related environment variables when a video card is detected. | -| WATERMARK_PNG | Full path inside the container to a watermark png IE `/usr/share/selkies/www/icon.png` | -| WATERMARK_LOCATION | Where to paint the image over the stream integer options below | - -* 1 - Top Left -* 2 - Top Right -* 3 - Bottom Left -* 4 - Bottom Right -* 5 - Centered -* 6 - Animated - -#### Optional run configurations +This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies), which provides the following environment variables and run configurations to customize its functionality. + +#### Optional Environment Variables | Variable | Description | | :----: | --- | -| `--privileged` | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE `-v /home/user/docker-data:/var/lib/docker`. | -| `-v /var/run/docker.sock:/var/run/docker.sock` | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. | +| `CUSTOM_PORT` | Internal HTTP port. Defaults to `{% if external_http_port is defined %}{{ external_http_port }}{% else %}3000{% endif %}`. | +| `CUSTOM_HTTPS_PORT` | Internal HTTPS port. Defaults to `{% if external_https_port is defined %}{{ external_https_port }}{% else %}3001{% endif %}`. | +| `CUSTOM_USER` | Username for HTTP Basic Auth. Defaults to `abc`. | +| `PASSWORD` | Password for HTTP Basic Auth. If unset, authentication is disabled. | +| `SUBFOLDER` | Application subfolder for reverse proxy configurations. Must include leading and trailing slashes, e.g., `/subfolder/`. | +| `TITLE` | Page title displayed in the web browser. Defaults to "Selkies". | +| `START_DOCKER` | If set to `false`, the privileged Docker-in-Docker setup will not start automatically. | +| `DISABLE_IPV6` | Set to `true` to disable IPv6 support in the container. | +| `LC_ALL` | Sets the container's locale, e.g., `fr_FR.UTF-8`. | +| `NO_DECOR` | If set, applications will run without window borders, suitable for PWA usage. | +| `NO_FULL` | If set, applications will not be automatically fullscreened. | +| `DISABLE_ZINK` | If set, Zink-related environment variables will not be configured when a video card is detected. | +| `WATERMARK_PNG` | Full path to a watermark PNG file inside the container, e.g., `/usr/share/selkies/www/icon.png`. | +| `WATERMARK_LOCATION` | Integer specifying the watermark location: `1` (Top Left), `2` (Top Right), `3` (Bottom Left), `4` (Bottom Right), `5` (Centered), `6` (Animated). | + +#### Optional Run Configurations + +| Argument | Description | +| :----: | --- | +| `--privileged` | Starts a Docker-in-Docker (DinD) environment. For better performance, mount the Docker data directory from the host, e.g., `-v /path/to/docker-data:/var/lib/docker`. | +| `-v /var/run/docker.sock:/var/run/docker.sock` | Mounts the host's Docker socket to manage host containers from within this container. | ### Language Support - Internationalization -The environment variable `LC_ALL` can be used to start this container in a different language than English simply pass for example to launch the Desktop session in French `LC_ALL=fr_FR.UTF-8`. Some supported languages: +To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example: -* `-e LC_ALL=zh_CN.UTF-8` - Chinese -* `-e LC_ALL=ja_JP.UTF-8` - Japanese -* `-e LC_ALL=ko_KR.UTF-8` - Korean -* `-e LC_ALL=ar_AE.UTF-8` - Arabic -* `-e LC_ALL=ru_RU.UTF-8` - Russian -* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America) -* `-e LC_ALL=de_DE.UTF-8` - German -* `-e LC_ALL=fr_FR.UTF-8` - French -* `-e LC_ALL=nl_NL.UTF-8` - Netherlands -* `-e LC_ALL=it_IT.UTF-8` - Italian +* `-e LC_ALL=zh_CN.UTF-8` - Chinese +* `-e LC_ALL=ja_JP.UTF-8` - Japanese +* `-e LC_ALL=ko_KR.UTF-8` - Korean +* `-e LC_ALL=ar_AE.UTF-8` - Arabic +* `-e LC_ALL=ru_RU.UTF-8` - Russian +* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America) +* `-e LC_ALL=de_DE.UTF-8` - German +* `-e LC_ALL=fr_FR.UTF-8` - French +* `-e LC_ALL=nl_NL.UTF-8` - Netherlands +* `-e LC_ALL=it_IT.UTF-8` - Italian {% if show_nvidia is defined %}### Nvidia GPU Support -**Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers** +**Note: Nvidia support is not available for Alpine-based images.** -Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags: +Nvidia GPU support is available by leveraging Zink for OpenGL. When a compatible Nvidia GPU is passed through, it will also be **automatically utilized for hardware-accelerated video stream encoding** (using the `x264enc` full-frame profile), significantly reducing CPU load. -| Variable | Description | +Enable Nvidia support with the following runtime flags: + +| Flag | Description | | :----: | --- | -| --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system | -| --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host | +| `--gpus all` | Passes all available host GPUs to the container. This can be filtered to specific GPUs. | +| `--runtime nvidia` | Specifies the Nvidia runtime, which provides the necessary drivers and tools from the host. | -The compose syntax is slightly different for this as you will need to set nvidia as the default runtime: +For Docker Compose, you must first configure the Nvidia runtime as the default on the host: ``` sudo nvidia-ctk runtime configure --runtime=docker --set-as-default -sudo service docker restart +sudo systemctl restart docker ``` -And to assign the GPU in compose: +Then, assign the GPU to the service in your `compose.yaml`: ``` services: @@ -91,21 +90,25 @@ services: capabilities: [compute,video,graphics,utility] ``` -{% endif %}### Application management +{% endif %}### Application Management + +There are two methods for installing applications inside the container: PRoot Apps (recommended for persistence) and Native Apps. + +#### PRoot Apps (Persistent) -#### PRoot Apps +Natively installed packages (e.g., via `apt-get install`) will not persist if the container is recreated. To retain applications and their settings across container updates, we recommend using [proot-apps](https://github.com/linuxserver/proot-apps). These are portable applications installed to the user's persistent `$HOME` directory. -If you run system native installations of software IE `sudo apt-get install filezilla` and then upgrade or destroy/re-create the container that software will be removed and the container will be at a clean state. For some users that will be acceptable and they can update their system packages as well using system native commands like `apt-get upgrade`. If you want Docker to handle upgrading the container and retain your applications and settings we have created [proot-apps](https://github.com/linuxserver/proot-apps) which allow portable applications to be installed to persistent storage in the user's `$HOME` directory and they will work in a confined Docker environment out of the box. These applications and their settings will persist upgrades of the base container and can be mounted into different flavors ofSelkiess based containers on the fly. This can be achieved from the command line with: +To install an application, use the command line inside the container: ``` proot-apps install filezilla ``` -PRoot Apps is included in all Selkies based containers, a list of linuxserver.io supported applications is located [HERE](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps). +A list of supported applications is available [here](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps). -#### Native Apps +#### Native Apps (Non-Persistent) -It is possible to install extra packages during container start using [universal-package-install](https://github.com/linuxserver/docker-mods/tree/universal-package-install). It might increase starting time significantly. PRoot is preferred. +You can install packages from the system's native repository using the [universal-package-install](https://github.com/linuxserver/docker-mods/tree/universal-package-install) mod. This method will increase the container's start time and is not persistent. Add the following to your `compose.yaml`: ```yaml environment: From 0b21d6852565ae9be47b43b4545e0f474ec09481 Mon Sep 17 00:00:00 2001 From: Roxedus Date: Tue, 1 Jul 2025 13:24:00 +0000 Subject: [PATCH 12/14] Add selkies note to requires --- .../roles/documentation/templates/unraid.xml.j2 | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/ansible/roles/documentation/templates/unraid.xml.j2 b/ansible/roles/documentation/templates/unraid.xml.j2 index fcd90143..19032f97 100644 --- a/ansible/roles/documentation/templates/unraid.xml.j2 +++ b/ansible/roles/documentation/templates/unraid.xml.j2 @@ -91,13 +91,19 @@ {# Set the WebUI link based on the link the CI runs against #} {{ "false" if unraid_template_sync is sameas false else "https://raw.githubusercontent.com/linuxserver/templates/main/unraid/" + project_name | lower + ".xml" }} https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver-ls-logo.png -{% if (unraid_requirement is defined and unraid_requirement != "") or (external_application_snippet_enabled) %} +{% if (unraid_requirement is defined and unraid_requirement != "") or (external_application_snippet_enabled) or (selkies_blurb is defined) %} - {{ unraid_requirement }} - {% if external_application_snippet_enabled %} +{% if unraid_requirement is defined %} + {{ unraid_requirement | indent(4) | trim }} +{% endif %} +{% if external_application_snippet_enabled %} This container requires an external application to be run separately. - {{ external_application_unraid_block }} - {% endif %} + {{ external_application_unraid_block | indent(4) | trim }} +{% endif %} +{% if selkies_blurb is defined %} + This image is unprotected by default __**do not**__ expose it to the internet. + Please read {{ project_github_repo_url }}#security for more information. +{% endif %} {% endif %} {# Create changelog #} From 5c8ef5a7a3565ce212b1b87ad87530883726b9da Mon Sep 17 00:00:00 2001 From: Ryan Kuba Date: Fri, 22 Aug 2025 13:46:07 +0000 Subject: [PATCH 13/14] add custom ws port to selkies blurb (#348) --- ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 | 1 + 1 file changed, 1 insertion(+) diff --git a/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 b/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 index 1436bd37..7cb22d4c 100644 --- a/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 +++ b/ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2 @@ -20,6 +20,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse | :----: | --- | | `CUSTOM_PORT` | Internal HTTP port. Defaults to `{% if external_http_port is defined %}{{ external_http_port }}{% else %}3000{% endif %}`. | | `CUSTOM_HTTPS_PORT` | Internal HTTPS port. Defaults to `{% if external_https_port is defined %}{{ external_https_port }}{% else %}3001{% endif %}`. | +| `CUSTOM_WS_PORT` | Internal port the container listens on for websockets if it needs to be swapped from the default 8082. | | `CUSTOM_USER` | Username for HTTP Basic Auth. Defaults to `abc`. | | `PASSWORD` | Password for HTTP Basic Auth. If unset, authentication is disabled. | | `SUBFOLDER` | Application subfolder for reverse proxy configurations. Must include leading and trailing slashes, e.g., `/subfolder/`. | From 4fbb6e722007438071e1b9065e01f2eabc7fe0f6 Mon Sep 17 00:00:00 2001 From: aptalca <541623+aptalca@users.noreply.github.com> Date: Fri, 22 Aug 2025 09:46:19 -0400 Subject: [PATCH 14/14] check for riscv64 artifacts (#347) * check for riscv64 artifacts * update if condition riscv64 builds depend on MULTIARCH=true so no need to also check for it here * remove armv7 check --- ansible/roles/github/templates/external_trigger.yml.j2 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ansible/roles/github/templates/external_trigger.yml.j2 b/ansible/roles/github/templates/external_trigger.yml.j2 index c5d0b95b..45a726ca 100644 --- a/ansible/roles/github/templates/external_trigger.yml.j2 +++ b/ansible/roles/github/templates/external_trigger.yml.j2 @@ -171,7 +171,7 @@ jobs: echo "Sanitized version \`${EXT_RELEASE_SANITIZED}\` already pushed, exiting" >> $GITHUB_STEP_SUMMARY exit 0 {% if external_type == "alpine_repo" and better_vars.MULTIARCH == 'true' %} - elif [[ $(curl -sL "{{ better_vars.DIST_REPO }}aarch64/APKINDEX.tar.gz" | tar -xz -C /tmp && awk '/^P:'"{{ better_vars.DIST_REPO_PACKAGES }}"'$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://') != "${EXT_RELEASE}" ]]{% if build_armhf %} || [[ $(curl -sL "{{ better_vars.DIST_REPO }}armv7/APKINDEX.tar.gz" | tar -xz -C /tmp && awk '/^P:'"{{ better_vars.DIST_REPO_PACKAGES }}"'$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://') != "${EXT_RELEASE}" ]]{% endif %}; then + elif [[ $(curl -sL "{{ better_vars.DIST_REPO }}aarch64/APKINDEX.tar.gz" | tar -xz -C /tmp && awk '/^P:'"{{ better_vars.DIST_REPO_PACKAGES }}"'$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://') != "${EXT_RELEASE}" ]]{% if build_riscv64 %} || [[ $(curl -sL "{{ better_vars.DIST_REPO }}riscv64/APKINDEX.tar.gz" | tar -xz -C /tmp && awk '/^P:'"{{ better_vars.DIST_REPO_PACKAGES }}"'$/,/V:/' /tmp/APKINDEX | sed -n 2p | sed 's/^V://') != "${EXT_RELEASE}" ]]{% endif %}; then echo "New version \`${EXT_RELEASE}\` found; but not all arch repos updated yet; exiting" >> $GITHUB_STEP_SUMMARY FAILURE_REASON="New version ${EXT_RELEASE} for {{ project_name }} tag {{ release_tag }} is detected, however not all arch repos are updated yet. Will try again later." curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903,