Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: linuxserver/docker-jackett
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: master
Choose a base ref
...
head repository: linuxserver/docker-jackett
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: development
Choose a head ref
Can’t automatically merge. Don’t worry, you can still create the pull request.
Loading
Showing with 1,660 additions and 1,071 deletions.
  1. +20 −0 .editorconfig
  2. +123 −0 .github/CONTRIBUTING.md
  3. +2 −0 .github/FUNDING.yml
  4. +0 −21 .github/ISSUE_TEMPLATE.md
  5. +13 −0 .github/ISSUE_TEMPLATE/config.yml
  6. +14 −0 .github/ISSUE_TEMPLATE/issue.bug.yml
  7. +14 −0 .github/ISSUE_TEMPLATE/issue.feature.yml
  8. +37 −4 .github/PULL_REQUEST_TEMPLATE.md
  9. +13 −0 .github/workflows/greetings.yml
  10. +10 −0 .github/workflows/permissions.yml
  11. +1 −0 .gitignore
  12. +27 −37 Dockerfile
  13. +26 −39 Dockerfile.aarch64
  14. +0 −58 Dockerfile.armhf
  15. +0 −643 Jenkinsfile
  16. +674 −0 LICENSE
  17. +223 −95 README.md
  18. +5 −5 jenkins-vars.yml
  19. +374 −130 package_versions.txt
  20. +36 −29 readme-vars.yml
  21. +0 −6 root/etc/cont-init.d/30-config
  22. 0 root/etc/s6-overlay/s6-rc.d/init-config-end/dependencies.d/init-jackett-config
  23. 0 root/etc/s6-overlay/s6-rc.d/init-deprecate/dependencies.d/init-config-end
  24. +19 −0 root/etc/s6-overlay/s6-rc.d/init-deprecate/run
  25. +1 −0 root/etc/s6-overlay/s6-rc.d/init-deprecate/type
  26. +1 −0 root/etc/s6-overlay/s6-rc.d/init-deprecate/up
  27. 0 root/etc/s6-overlay/s6-rc.d/init-jackett-config/dependencies.d/init-config
  28. +11 −0 root/etc/s6-overlay/s6-rc.d/init-jackett-config/run
  29. +1 −0 root/etc/s6-overlay/s6-rc.d/init-jackett-config/type
  30. +1 −0 root/etc/s6-overlay/s6-rc.d/init-jackett-config/up
  31. 0 root/etc/s6-overlay/s6-rc.d/init-services/dependencies.d/init-deprecate
  32. 0 root/etc/s6-overlay/s6-rc.d/svc-jackett/dependencies.d/init-services
  33. +1 −0 root/etc/s6-overlay/s6-rc.d/svc-jackett/notification-fd
  34. +12 −0 root/etc/s6-overlay/s6-rc.d/svc-jackett/run
  35. +1 −0 root/etc/s6-overlay/s6-rc.d/svc-jackett/type
  36. 0 root/etc/s6-overlay/s6-rc.d/user/contents.d/init-deprecate
  37. 0 root/etc/s6-overlay/s6-rc.d/user/contents.d/init-jackett-config
  38. 0 root/etc/s6-overlay/s6-rc.d/user/contents.d/svc-jackett
  39. +0 −4 root/etc/services.d/jackett/run
20 changes: 20 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# This file is globally distributed to all container image projects from
# https://github.com/linuxserver/docker-jenkins-builder/blob/master/.editorconfig

# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true
# trim_trailing_whitespace may cause unintended issues and should not be globally set true
trim_trailing_whitespace = false

[{Dockerfile*,**.yml}]
indent_style = space
indent_size = 2

[{**.sh,root/etc/s6-overlay/s6-rc.d/**,root/etc/cont-init.d/**,root/etc/services.d/**}]
indent_style = space
indent_size = 4
123 changes: 123 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# Contributing to jackett

## Gotchas

* 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.
* Read, and fill the Pull Request template
* 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
* If the PR is addressing an existing issue include, closes #\<issue number>, in the body of the PR commit message
* 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://discord.gg/YWrKVTn)

## Common files

| File | Use case |
| :----: | --- |
| `Dockerfile` | Dockerfile used to build amd64 images |
| `Dockerfile.aarch64` | Dockerfile used to build 64bit ARM architectures |
| `Dockerfile.armhf` | Dockerfile used to build 32bit ARM architectures |
| `Jenkinsfile` | This file is a product of our builder and should not be edited directly. This is used to build the image |
| `jenkins-vars.yml` | This file is used to generate the `Jenkinsfile` mentioned above, it only affects the build-process |
| `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 |
| `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 |
| `readme-vars.yml` | This file is used to generate the `README.md` |

## Readme

If you would like to change our readme, please __**do not**__ directly edit the readme, as it is auto-generated on each commit.
Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-jackett/edit/development/readme-vars.yml).

These variables are used in a template for our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) as part of an ansible play.
Most of these variables are also carried over to [docs.linuxserver.io](https://docs.linuxserver.io/images/docker-jackett)

### Fixing typos or clarify the text in the readme

There are variables for multiple parts of the readme, the most common ones are:

| Variable | Description |
| :----: | --- |
| `project_blurb` | This is the short excerpt shown above the project logo. |
| `app_setup_block` | This is the text that shows up under "Application Setup" if enabled |

### Parameters

The compose and run examples are also generated from these variables.

We have a [reference file](https://github.com/linuxserver/docker-jenkins-builder/blob/master/vars/_container-vars-blank) in our Jenkins Builder.

These are prefixed with `param_` for required parameters, or `opt_param` for optional parameters, except for `cap_add`.
Remember to enable param, if currently disabled. This differs between parameters, and can be seen in the reference file.

Devices, environment variables, ports and volumes expects its variables in a certain way.

### Devices

```yml
param_devices:
- { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" }
opt_param_devices:
- { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" }
```
### Environment variables
```yml
param_env_vars:
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
opt_param_env_vars:
- { env_var: "VERSION", env_value: "latest", desc: "Supported values are LATEST, PLEXPASS or a specific version number." }
```
### Ports
```yml
param_ports:
- { external_port: "80", internal_port: "80", port_desc: "Application WebUI" }
opt_param_ports:
- { external_port: "80", internal_port: "80", port_desc: "Application WebUI" }
```
### Volumes
```yml
param_volumes:
- { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "Configuration files." }
opt_param_volumes:
- { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "Configuration files." }
```
### Testing template changes
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.

## Dockerfiles

We use multiple Dockerfiles in our repos, this is because sometimes some CPU architectures needs different packages to work.
If you are proposing additional packages to be added, ensure that you added the packages to all the Dockerfiles in alphabetical order.

### Testing your changes

```bash
git clone https://github.com/linuxserver/docker-jackett.git
cd docker-jackett
docker build \
--no-cache \
--pull \
-t linuxserver/jackett:latest .
```

The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`

```bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset
```

Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.

## Update the changelog

If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-jackett/tree/development/root), add an entry to the changelog

```yml
changelogs:
- { date: "DD.MM.YY:", desc: "Added some love to templates" }
```
2 changes: 2 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github: linuxserver
open_collective: linuxserver
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
blank_issues_enabled: false
contact_links:
- name: Discord chat support
url: https://discord.gg/YWrKVTn
about: Realtime support / chat with the community and the team.

- name: Discourse discussion forum
url: https://discourse.linuxserver.io
about: Post on our community forum.

- name: Documentation
url: https://docs.linuxserver.io/images/docker-jackett
about: Documentation - information about all of our containers.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Based on the issue template
name: Bug report
description: Create a report to help us improve
title: "[BUG] <title>"
labels: [Bug]
body:
- type: markdown
attributes:
value: |
# This image is deprecated. We will not offer support for this image and it will not be updated.

Jackett has a bot publishing nightly stable releases
Please switch to latest tag for stable

14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Based on the issue template
name: Feature request
description: Suggest an idea for this project
title: "[FEAT] <title>"
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
# This image is deprecated. We will not offer support for this image and it will not be updated.

Jackett has a bot publishing nightly stable releases
Please switch to latest tag for stable

41 changes: 37 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,48 @@
# This image is deprecated. We will not offer support for this image and it will not be updated.

Jackett has a bot publishing nightly stable releases
Please switch to latest tag for stable

<!--- Provide a general summary of your changes in the Title above -->

[linuxserverurl]: https://linuxserver.io
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]


<!--- Before submitting a pull request please check the following -->

<!--- That you have made a branch in your fork, we'd rather not merge from your master -->
<!--- 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 -->
<!--- Ask yourself if this modification is something the whole userbase will benefit from, if this is a specific change for corner case functionality or plugins please look at making a Docker Mod or local script https://blog.linuxserver.io/2019/09/14/customizing-our-containers/ -->
<!--- That if the PR is addressing an existing issue include, closes #<issue number> , in the body of the PR commit message -->
<!--- You have included links to any files / patches etc your PR may be using in the body of the PR commit message -->
<!--- -->
<!--- We maintain a changelog of major revisions to the container at the end of readme-vars.yml in the root of this repository, please add your changes there if appropriate -->


<!--- Coding guidelines: -->
<!--- 1. Installed packages in the Dockerfiles should be in alphabetical order -->
<!--- 2. Changes to Dockerfile should be replicated in Dockerfile.armhf and Dockerfile.aarch64 if applicable -->
<!--- 3. Indentation style (tabs vs 4 spaces vs 1 space) should match the rest of the document -->
<!--- 4. Readme is auto generated from readme-vars.yml, make your changes there -->

------------------------------

- [ ] I have read the [contributing](https://github.com/linuxserver/docker-jackett/blob/development/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications

------------------------------

<!--- We welcome all PR’s though this doesn’t guarantee it will be accepted. -->

## Description:
<!--- Describe your changes in detail -->

## Benefits of this PR and context:
<!--- Please explain why we should accept this PR. If this fixes an outstanding bug, please reference the issue # -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Thanks, team linuxserver.io

## Source / References:
<!--- Please include any forum posts/github links relevant to the PR -->
13 changes: 13 additions & 0 deletions .github/workflows/greetings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Greetings

on: [pull_request_target, issues]

jobs:
greeting:
runs-on: ubuntu-latest
steps:
- uses: actions/first-interaction@v1
with:
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.'
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-jackett/blob/development/.github/PULL_REQUEST_TEMPLATE.md)!'
repo-token: ${{ secrets.GITHUB_TOKEN }}
10 changes: 10 additions & 0 deletions .github/workflows/permissions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Permission check
on:
pull_request_target:
paths:
- '**/run'
- '**/finish'
- '**/check'
jobs:
permission_check:
uses: linuxserver/github-workflows/.github/workflows/init-svc-executable-permissions.yml@v1
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -41,3 +41,4 @@ $RECYCLE.BIN/
Network Trash Folder
Temporary Items
.apdisk
.jenkins-external
64 changes: 27 additions & 37 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,55 +1,45 @@
FROM lsiobase/ubuntu:bionic
# syntax=docker/dockerfile:1

FROM ghcr.io/linuxserver/baseimage-alpine:3.18

# set version label
ARG BUILD_DATE
ARG VERSION
ARG JACKETT_RELEASE
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
LABEL maintainer="sparklyballs"

# arch settings, uncomment as neccesary
ARG JACKETT_ARCH="LinuxAMDx64"
# ARG JACKETT_ARCH="LinuxARM32"
# ARG JACKETT_ARCH="LinuxARM64"
LABEL maintainer="thelamer"

# environment settings
ARG DEBIAN_FRONTEND="noninteractive"
ENV XDG_DATA_HOME="/config" \
XDG_CONFIG_HOME="/config"

RUN \
echo "**** install packages ****" && \
apt-get update && \
apt-get install -y \
jq \
libicu60 \
libssl1.0 \
wget && \
echo "**** install jackett ****" && \
mkdir -p \
/app/Jackett && \
if [ -z ${JACKETT_RELEASE+x} ]; then \
JACKETT_RELEASE=$(curl -sX GET "https://api.github.com/repos/Jackett/Jackett/releases/latest" \
| jq -r .tag_name); \
fi && \
curl -o \
/tmp/jacket.tar.gz -L \
"https://github.com/Jackett/Jackett/releases/download/${JACKETT_RELEASE}/Jackett.Binaries.${JACKETT_ARCH}.tar.gz" && \
tar xf \
/tmp/jacket.tar.gz -C \
/app/Jackett --strip-components=1 && \
echo "**** fix for host id mapping error ****" && \
chown -R root:root /app/Jackett && \
echo "**** cleanup ****" && \
apt-get clean && \
rm -rf \
/tmp/* \
/var/lib/apt/lists/* \
/var/tmp/*
echo "**** install packages ****" && \
apk --no-cache add \
icu-data-full \
icu-libs && \
echo "**** install jackett ****" && \
mkdir -p \
/app/Jackett && \
if [ -z ${JACKETT_RELEASE+x} ]; then \
JACKETT_RELEASE=$(curl -sX GET "https://api.github.com/repos/Jackett/Jackett/releases" \
| jq -r '.[0] | .tag_name'); \
fi && \
curl -o \
/tmp/jacket.tar.gz -L \
"https://github.com/Jackett/Jackett/releases/download/${JACKETT_RELEASE}/Jackett.Binaries.LinuxMuslAMDx64.tar.gz" && \
tar xf \
/tmp/jacket.tar.gz -C \
/app/Jackett --strip-components=1 && \
echo "**** fix for host id mapping error ****" && \
chown -R root:root /app/Jackett && \
echo "**** cleanup ****" && \
rm -rf \
/tmp/*

# add local files
COPY root/ /

# ports and volumes
VOLUME /config /downloads
VOLUME /config
EXPOSE 9117
Loading