diff --git a/Dockerfile b/Dockerfile index 3fba352..6a8c7dd 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,7 @@ # syntax=docker/dockerfile:1 +FROM ghcr.io/linuxserver/unrar:latest as unrar + FROM ghcr.io/linuxserver/baseimage-alpine:3.18 # set version label @@ -11,7 +13,6 @@ LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DA LABEL maintainer="thespad" # environment settings -ARG UNRAR_VERSION=6.2.10 ENV HOME="/config" \ XDG_CONFIG_HOME="/config" \ XDG_DATA_HOME="/config" @@ -28,17 +29,6 @@ RUN \ p7zip \ python3 \ qt6-qtbase-sqlite && \ - echo "**** install unrar from source ****" && \ - mkdir /tmp/unrar && \ - curl -o \ - /tmp/unrar.tar.gz -L \ - "https://www.rarlab.com/rar/unrarsrc-${UNRAR_VERSION}.tar.gz" && \ - tar xf \ - /tmp/unrar.tar.gz -C \ - /tmp/unrar --strip-components=1 && \ - cd /tmp/unrar && \ - make && \ - install -v -m755 unrar /usr/bin && \ echo "**** install qbittorrent ****" && \ if [ -z ${QBITTORRENT_VERSION+x} ]; then \ QBITTORRENT_VERSION=$(curl -sL "https://api.github.com/repos/userdocs/qbittorrent-nox-static/releases" | \ @@ -68,6 +58,9 @@ RUN \ # add local files COPY root/ / +# add unrar +COPY --from=unrar /usr/bin/unrar-alpine /usr/bin/unrar + # ports and volumes EXPOSE 8080 6881 6881/udp diff --git a/Dockerfile.aarch64 b/Dockerfile.aarch64 index a414386..bd127b0 100644 --- a/Dockerfile.aarch64 +++ b/Dockerfile.aarch64 @@ -1,5 +1,7 @@ # syntax=docker/dockerfile:1 +FROM ghcr.io/linuxserver/unrar:arm64v8-latest as unrar + FROM ghcr.io/linuxserver/baseimage-alpine:arm64v8-3.18 # set version label @@ -11,7 +13,6 @@ LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DA LABEL maintainer="thespad" # environment settings -ARG UNRAR_VERSION=6.2.10 ENV HOME="/config" \ XDG_CONFIG_HOME="/config" \ XDG_DATA_HOME="/config" @@ -28,17 +29,6 @@ RUN \ p7zip \ python3 \ qt6-qtbase-sqlite && \ - echo "**** install unrar from source ****" && \ - mkdir /tmp/unrar && \ - curl -o \ - /tmp/unrar.tar.gz -L \ - "https://www.rarlab.com/rar/unrarsrc-${UNRAR_VERSION}.tar.gz" && \ - tar xf \ - /tmp/unrar.tar.gz -C \ - /tmp/unrar --strip-components=1 && \ - cd /tmp/unrar && \ - make && \ - install -v -m755 unrar /usr/bin && \ echo "**** install qbittorrent ****" && \ if [ -z ${QBITTORRENT_VERSION+x} ]; then \ QBITTORRENT_VERSION=$(curl -sL "https://api.github.com/repos/userdocs/qbittorrent-nox-static/releases" | \ @@ -68,6 +58,9 @@ RUN \ # add local files COPY root/ / +# add unrar +COPY --from=unrar /usr/bin/unrar-alpine /usr/bin/unrar + # ports and volumes EXPOSE 8080 6881 6881/udp diff --git a/Jenkinsfile b/Jenkinsfile index 7423465..728a2d9 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -16,7 +16,6 @@ pipeline { GITHUB_TOKEN=credentials('498b4638-2d02-4ce5-832d-8a57d01d97ab') GITLAB_TOKEN=credentials('b6f0f1dd-6952-4cf6-95d1-9c06380283f0') GITLAB_NAMESPACE=credentials('gitlab-namespace-id') - SCARF_TOKEN=credentials('scarf_api_key') CONTAINER_NAME = 'qbittorrent' BUILD_VERSION_ARG = 'QBITTORRENT_VERSION' LS_USER = 'linuxserver' @@ -330,12 +329,12 @@ pipeline { else echo "false" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} fi - mkdir -p ${TEMPDIR}/gitbook - git clone https://github.com/linuxserver/docker-documentation.git ${TEMPDIR}/gitbook/docker-documentation - if [[ ("${BRANCH_NAME}" == "master") || ("${BRANCH_NAME}" == "main") ]] && [[ (! -f ${TEMPDIR}/gitbook/docker-documentation/images/docker-${CONTAINER_NAME}.md) || ("$(md5sum ${TEMPDIR}/gitbook/docker-documentation/images/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')") ]]; then - cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md ${TEMPDIR}/gitbook/docker-documentation/images/ - cd ${TEMPDIR}/gitbook/docker-documentation/ - git add images/docker-${CONTAINER_NAME}.md + mkdir -p ${TEMPDIR}/docs + git clone https://github.com/linuxserver/docker-documentation.git ${TEMPDIR}/docs/docker-documentation + if [[ ("${BRANCH_NAME}" == "master") || ("${BRANCH_NAME}" == "main") ]] && [[ (! -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 + cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md ${TEMPDIR}/docs/docker-documentation/docs/images/ + cd ${TEMPDIR}/docs/docker-documentation + git add docs/images/docker-${CONTAINER_NAME}.md git commit -m 'Bot Updating Documentation' git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git --all fi @@ -426,35 +425,6 @@ pipeline { "visibility":"public"}' ''' } } - /* ####################### - Scarf.sh package registry - ####################### */ - // Add package to Scarf.sh and set permissions - stage("Scarf.sh package registry"){ - when { - branch "libtorrentv1" - environment name: 'EXIT_STATUS', value: '' - } - steps{ - sh '''#! /bin/bash - PACKAGE_UUID=$(curl -X GET -H "Authorization: Bearer ${SCARF_TOKEN}" https://scarf.sh/api/v1/organizations/linuxserver-ci/packages | jq -r '.[] | select(.name=="linuxserver/qbittorrent") | .uuid' || :) - if [ -z "${PACKAGE_UUID}" ]; then - echo "Adding package to Scarf.sh" - curl -sX POST https://scarf.sh/api/v1/organizations/linuxserver-ci/packages \ - -H "Authorization: Bearer ${SCARF_TOKEN}" \ - -H "Content-Type: application/json" \ - -d '{"name":"linuxserver/qbittorrent",\ - "shortDescription":"example description",\ - "libraryType":"docker",\ - "website":"https://github.com/linuxserver/docker-qbittorrent",\ - "backendUrl":"https://ghcr.io/linuxserver/qbittorrent",\ - "publicUrl":"https://lscr.io/linuxserver/qbittorrent"}' || : - else - echo "Package already exists on Scarf.sh" - fi - ''' - } - } /* ############### Build Container ############### */ @@ -850,6 +820,41 @@ pipeline { curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/releases -d @releasebody.json.done''' } } + // Add protection to the release branch + stage('Github-Release-Branch-Protection') { + when { + branch "libtorrentv1" + environment name: 'CHANGE_ID', value: '' + environment name: 'EXIT_STATUS', value: '' + } + steps { + echo "Setting up protection for release branch libtorrentv1" + sh '''#! /bin/bash + curl -H "Authorization: token ${GITHUB_TOKEN}" -X PUT https://api.github.com/repos/${LS_USER}/${LS_REPO}/branches/libtorrentv1/protection \ + -d $(jq -c . << EOF + { + "required_status_checks": null, + "enforce_admins": false, + "required_pull_request_reviews": { + "dismiss_stale_reviews": false, + "require_code_owner_reviews": false, + "require_last_push_approval": false, + "required_approving_review_count": 1 + }, + "restrictions": null, + "required_linear_history": false, + "allow_force_pushes": false, + "allow_deletions": false, + "block_creations": false, + "required_conversation_resolution": true, + "lock_branch": false, + "allow_fork_syncing": false, + "required_signatures": false + } +EOF + ) ''' + } + } // Use helper container to sync the current README on master to the dockerhub endpoint stage('Sync-README') { when { diff --git a/README.md b/README.md index 359f21b..fba424f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ - - - + + [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) [![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!") @@ -66,6 +65,7 @@ This image provides various versions that are available via tags. Please read th | :----: | :----: |--- | | latest | ✅ | Stable qbittorrent releases | | libtorrentv1 | ✅ | Static qbittorrent builds using libtorrent v1 | + ## Application Setup The webui is at `:8080` and the default username/password is `admin/adminadmin`. @@ -94,7 +94,7 @@ If you are running a very old (3.x) kernel you may run into [this issue](https:/ ## Usage -Here are some example snippets to help you get started creating a container. +To help you get started creating a container from this image you can either use docker-compose or the docker cli. ### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) @@ -136,12 +136,11 @@ docker run -d \ -v /path/to/downloads:/downloads \ --restart unless-stopped \ lscr.io/linuxserver/qbittorrent:libtorrentv1 - ``` ## Parameters -Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. +Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. | Parameter | Function | | :----: | --- | @@ -162,10 +161,10 @@ You can set any environment variable from a file by using a special prepend `FIL As an example: ```bash --e FILE__PASSWORD=/run/secrets/mysecretpassword +-e FILE__MYVAR=/run/secrets/mysecretvariable ``` -Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file. +Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file. ## Umask for running applications @@ -174,15 +173,20 @@ Keep in mind umask is not chmod it subtracts from permissions based on it's valu ## User / Group Identifiers -When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. +When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. -In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: +In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below: ```bash - $ id username - uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) +id your_user +``` + +Example output: + +```text +uid=1000(your_user) gid=1000(your_user) groups=1000(your_user) ``` ## Docker Mods @@ -193,12 +197,29 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Support Info -* Shell access whilst the container is running: `docker exec -it qbittorrent /bin/bash` -* To monitor the logs of the container in realtime: `docker logs -f qbittorrent` -* container version number - * `docker inspect -f '{{ index .Config.Labels "build_version" }}' qbittorrent` -* image version number - * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/qbittorrent:libtorrentv1` +* Shell access whilst the container is running: + + ```bash + docker exec -it qbittorrent /bin/bash + ``` + +* To monitor the logs of the container in realtime: + + ```bash + docker logs -f qbittorrent + ``` + +* Container version number: + + ```bash + docker inspect -f '{{ index .Config.Labels "build_version" }}' qbittorrent + ``` + +* Image version number: + + ```bash + docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/qbittorrent:libtorrentv1 + ``` ## Updating Info @@ -208,38 +229,83 @@ Below are the instructions for updating containers: ### Via Docker Compose -* Update all images: `docker-compose pull` - * or update a single image: `docker-compose pull qbittorrent` -* Let compose update all containers as necessary: `docker-compose up -d` - * or update a single container: `docker-compose up -d qbittorrent` -* You can also remove the old dangling images: `docker image prune` +* Update images: + * All images: + + ```bash + docker-compose pull + ``` + + * Single image: + + ```bash + docker-compose pull qbittorrent + ``` + +* Update containers: + * All containers: + + ```bash + docker-compose up -d + ``` + + * Single container: + + ```bash + docker-compose up -d qbittorrent + ``` + +* You can also remove the old dangling images: + + ```bash + docker image prune + ``` ### Via Docker Run -* Update the image: `docker pull lscr.io/linuxserver/qbittorrent:libtorrentv1` -* Stop the running container: `docker stop qbittorrent` -* Delete the container: `docker rm qbittorrent` +* Update the image: + + ```bash + docker pull lscr.io/linuxserver/qbittorrent:libtorrentv1 + ``` + +* Stop the running container: + + ```bash + docker stop qbittorrent + ``` + +* Delete the container: + + ```bash + docker rm qbittorrent + ``` + * Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved) -* You can also remove the old dangling images: `docker image prune` +* You can also remove the old dangling images: + + ```bash + docker image prune + ``` ### Via Watchtower auto-updater (only use if you don't remember the original parameters) * Pull the latest image at its tag and replace it with the same env variables in one run: - ```bash - docker run --rm \ - -v /var/run/docker.sock:/var/run/docker.sock \ - containrrr/watchtower \ - --run-once qbittorrent - ``` + ```bash + docker run --rm \ + -v /var/run/docker.sock:/var/run/docker.sock \ + containrrr/watchtower \ + --run-once qbittorrent + ``` * You can also remove the old dangling images: `docker image prune` -**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose). +**warning**: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose). ### Image Update Notifications - Diun (Docker Image Update Notifier) -* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported. +**tip**: We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported. ## Building locally @@ -264,6 +330,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64 ## Versions +* **07.10.23:** - Install unrar from [linuxserver repo](https://github.com/linuxserver/docker-unrar). * **10.08.23:** - Bump unrar to 6.2.10. * **17.06.23:** - Rebase to Alpine 3.18, deprecate armhf as per [https://www.linuxserver.io/armhf](https://www.linuxserver.io/armhf). * **10.06.23:** - Bump unrar to 6.2.8. diff --git a/readme-vars.yml b/readme-vars.yml index 1335060..84450eb 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -68,7 +68,8 @@ app_setup_block: | # changelog changelogs: - - {date: "10.08.23:", desc: "Bump unrar to 6.2.10."} + - { date: "07.10.23:", desc: "Install unrar from [linuxserver repo](https://github.com/linuxserver/docker-unrar)."} + - { date: "10.08.23:", desc: "Bump unrar to 6.2.10."} - { date: "17.06.23:", desc: "Rebase to Alpine 3.18, deprecate armhf as per [https://www.linuxserver.io/armhf](https://www.linuxserver.io/armhf)." } - { date: "10.06.23:", desc: "Bump unrar to 6.2.8." } - { date: "25.02.23:", desc: "Add qt6-qtbase-sqlite to support SQLite database for resume files."}