├── .dockerignore
├── .env.example
├── .github
└── workflows
│ ├── check-docker-image.yml
│ ├── main.yml
│ ├── publish-docker-image.yml
│ └── update-dockerhub-readme.yml
├── .gitignore
├── Dockerfile
├── LICENSE
├── README.md
├── compose.yaml
├── main.py
└── requirements.txt
/.dockerignore:
--------------------------------------------------------------------------------
1 | # Ignore everything by default
2 | *
3 |
4 | # Allow only specific files
5 | !main.py
6 | !requirements.txt
7 |
--------------------------------------------------------------------------------
/.env.example:
--------------------------------------------------------------------------------
1 | # Radarr configuration (leave URL empty to disable Radarr-functionality, comma seperated for multutiple servers)
2 | RADARR_URL=http://localhost:7878,http://otherhost:7878
3 | RADARR_API_KEY=aaaabbbbcccc111122223333,xxxxyyyyzzzz777788889999
4 |
5 | # Sonarr configuration (leave URL empty to disable Sonarr-functionality, comma seperated for multutiple servers)
6 | SONARR_URL=http://localhost:8989,http://otherhost:8989
7 | SONARR_API_KEY=aaaabbbbcccc111122223333,xxxxyyyyzzzz777788889999
8 |
9 | # Lidarr configuration (leave URL empty to disable Lidarr-functionality, comma seperated for multutiple servers)
10 | LIDARR_URL=http://localhost:8686,http://otherhost:8686
11 | LIDARR_API_KEY=aaaabbbbcccc111122223333,xxxxyyyyzzzz777788889999
12 |
13 | # Readarr configuration (leave URL empty to disable Readarr-functionality, comma seperated for multutiple servers)
14 | READARR_URL=http://localhost:8787,http://otherhost:8787
15 | READARR_API_KEY=aaaabbbbcccc111122223333,xxxxyyyyzzzz777788889999
16 |
17 | # Script configuration
18 | STALLED_TIMEOUT=3600 # How long a download should be stalled before handling it (in seconds)
19 | STALLED_ACTION=BLOCKLIST_AND_SEARCH # Options: REMOVE or BLOCKLIST or BLOCKLIST_AND_SEARCH
20 | VERBOSE=false # Enable verbose/debug logging
21 | RUN_INTERVAL=300 # How often should the script be run (in seconds)
22 | COUNT_DOWNLOADING_METADATA_AS_STALLED=false # If it should count downloads with the "Downloading Metadata" as stalled
--------------------------------------------------------------------------------
/.github/workflows/check-docker-image.yml:
--------------------------------------------------------------------------------
1 | name: Check docker build
2 |
3 | on:
4 | push:
5 | branches:
6 | - dev
7 | - main
8 | paths:
9 | - 'main.py'
10 | - 'requirements.txt'
11 | pull_request:
12 | branches:
13 | - dev
14 | - main
15 | paths:
16 | - 'main.py'
17 | - 'requirements.txt'
18 |
19 | jobs:
20 |
21 | build:
22 |
23 | runs-on: ubuntu-latest
24 |
25 | steps:
26 | - uses: actions/checkout@v4
27 | - name: Build the Docker image
28 | run: docker build . --file Dockerfile --tag tommythebeast/arrstalledhandler:$(date +%s)
29 |
--------------------------------------------------------------------------------
/.github/workflows/main.yml:
--------------------------------------------------------------------------------
1 | on:
2 | push:
3 | branches:
4 | - main
5 |
6 | jobs:
7 | contrib-readme-job:
8 | runs-on: ubuntu-latest
9 | name: A job to automate contrib in readme
10 | permissions:
11 | contents: write
12 | pull-requests: write
13 | steps:
14 | - name: Contribute List
15 | uses: akhilmhdh/contributors-readme-action@v2.3.10
16 | env:
17 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
18 |
--------------------------------------------------------------------------------
/.github/workflows/publish-docker-image.yml:
--------------------------------------------------------------------------------
1 | name: Publish Docker image
2 |
3 | on:
4 | release:
5 | types: [published]
6 |
7 | jobs:
8 | push_to_registry:
9 | name: Push Docker image to Docker Hub
10 | runs-on: ubuntu-latest
11 | permissions:
12 | packages: write
13 | contents: read
14 | attestations: write
15 | id-token: write
16 | env:
17 | REGISTRY: ${{ vars.DOCKER_REGISTRY }}
18 | IMAGE_NAME: ${{ vars.DOCKER_IMAGE }}
19 | steps:
20 | - name: Check out the repo
21 | uses: actions/checkout@v4
22 |
23 | - name: Log in to Docker Hub
24 | uses: docker/login-action@v2
25 | with:
26 | username: ${{ secrets.DOCKER_USERNAME }}
27 | password: ${{ secrets.DOCKER_PASSWORD }}
28 |
29 | - name: Extract metadata (tags, labels) for Docker
30 | id: meta
31 | uses: docker/metadata-action@v4
32 | with:
33 | images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
34 |
35 | - name: Build and push Docker image
36 | id: push
37 | uses: docker/build-push-action@v4
38 | with:
39 | context: .
40 | file: ./Dockerfile
41 | push: true
42 | tags: ${{ steps.meta.outputs.tags }}
43 | labels: ${{ steps.meta.outputs.labels }}
44 |
45 | - name: Generate artifact attestation
46 | uses: actions/attest-build-provenance@v1
47 | with:
48 | subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
49 | subject-digest: ${{ steps.push.outputs.digest }}
50 | push-to-registry: true
51 |
--------------------------------------------------------------------------------
/.github/workflows/update-dockerhub-readme.yml:
--------------------------------------------------------------------------------
1 | name: Update Docker Hub Description
2 |
3 | on:
4 | push:
5 | branches:
6 | - main # Adjust if your default branch is not "main"
7 | paths:
8 | - README.md # Trigger only when README.md is updated
9 |
10 | jobs:
11 | update-dockerhub-description:
12 | runs-on: ubuntu-latest
13 |
14 | steps:
15 | - name: Checkout repository
16 | uses: actions/checkout@v4
17 |
18 | - name: Update Docker Hub Description
19 | uses: peter-evans/dockerhub-description@v4
20 | with:
21 | username: ${{ secrets.DOCKER_USERNAME }}
22 | password: ${{ secrets.DOCKER_PASSWORD }}
23 | repository: ${{ vars.DOCKER_IMAGE }}
24 | readme-filepath: ./README.md # Ensure README.md is in the root of your repository
25 | enable-url-completion: true # Optional: Completes relative URLs to absolute ones
26 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Database
10 | *.db
11 | data/
12 |
13 | # Distribution / packaging
14 | .Python
15 | env/
16 | venv/
17 | ENV/
18 | build/
19 | develop-eggs/
20 | dist/
21 | downloads/
22 | eggs/
23 | .eggs/
24 | lib/
25 | lib64/
26 | parts/
27 | sdist/
28 | var/
29 | *.egg-info/
30 | .installed.cfg
31 | *.egg
32 | *.wheel
33 |
34 | # PyInstaller
35 | # Usually these are written by a python script from a template
36 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
37 | *.manifest
38 | *.spec
39 |
40 | # Installer logs
41 | pip-log.txt
42 | pip-delete-this-directory.txt
43 |
44 | # Unit test / coverage reports
45 | htmlcov/
46 | .tox/
47 | .nox/
48 | .coverage
49 | .coverage.*
50 | .cache
51 | nosetests.xml
52 | coverage.xml
53 | *.cover
54 | *.py,cover
55 | .hypothesis/
56 |
57 | # Jupyter Notebook
58 | .ipynb_checkpoints
59 |
60 | # pyenv
61 | .python-version
62 |
63 | # PEP 582; used by e.g. https://github.com/David-OConnor/pyflow
64 | __pypackages__/
65 |
66 | # Celery
67 | celerybeat-schedule
68 | celerybeat.pid
69 |
70 | # SageMath
71 | *.sage.py
72 |
73 | # Environments
74 | .env
75 | .env.*
76 | !.env.example
77 | .venv
78 | .venv.*
79 |
80 | # mkdocs documentation
81 | /site
82 |
83 | # mypy
84 | .mypy_cache/
85 | .dmypy.json
86 | dmypy.json
87 |
88 | # Pyre
89 | .pyre/
90 |
91 | # pytype static type analyzer
92 | .pytype/
93 |
94 | # Cython debug symbols
95 | cython_debug/
96 |
97 | # Local development settings
98 | *.local
99 |
100 | # PyCharm
101 | .idea/
102 | *.iml
103 | *.ipr
104 | *.iws
105 |
106 | # VSCode
107 | .vscode/
108 |
109 | # Spyder project settings
110 | .spyderproject
111 | .spyderworkspace
112 |
113 | # MacOS
114 | .DS_Store
115 | .AppleDouble
116 | .LSOverride
117 |
118 | # Windows
119 | Thumbs.db
120 | ehthumbs.db
121 | Desktop.ini
122 | $RECYCLE.BIN/
123 |
124 | # Visual Studio
125 | .vs/
126 |
127 | # Backup files
128 | *~
129 | *.swp
130 | *.swo
131 | *.bak
132 | *.tmp
133 |
134 | # Logs
135 | *.log
136 | *.out
137 |
138 | # Ignore private keys
139 | *.pem
140 | *.key
141 |
142 | # Docker
143 | docker-compose.override.yml
144 |
145 | # Flask
146 | instance/
147 | .webassets-cache
148 |
149 | # Django
150 | *.log
151 | *.pot
152 | *.pyc
153 | *.mo
154 | db.sqlite3
155 | db.sqlite3-journal
156 | media/
157 | staticfiles/
158 |
159 | # AWS Credentials
160 | *.aws
161 |
162 | # Terraform
163 | *.tfstate
164 | *.tfstate.*
165 | .crash
166 | *.tfvars
167 | .override
168 | *.terraform*
169 |
170 | # FastAPI
171 | __pypackages__/
172 |
173 | # pytest
174 | .pytest_cache/
175 |
176 | # Localizations
177 | *.mo
178 | *.pot
179 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | # Use an official Python runtime as the base image
2 | FROM python:3.13-slim
3 |
4 | # Set the working directory
5 | WORKDIR /app
6 |
7 | # Copy the script and dependencies
8 | COPY . /app
9 |
10 | # Install Python dependencies
11 | RUN pip install -r requirements.txt
12 |
13 | # Make the script executable
14 | RUN chmod +x main.py
15 |
16 | # Disable output buffering in Python
17 | ENV PYTHONUNBUFFERED=1
18 |
19 | # Specify the entrypoint
20 | ENTRYPOINT ["python", "main.py"]
21 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # ArrStalledHandler
2 |
3 | ArrStalledHandler is a Python-based script designed to handle stalled downloads in [Radarr](https://radarr.video/), [Sonarr](https://sonarr.tv/), [Lidarr](https://lidarr.audio/) and [Readarr](https://readarr.com/) by taking actions such as removing, blocklisting, or blocklisting and re-searching for the affected items. It supports configuration through a `.env` file, logging for visibility, and is deployable via Docker for ease of use.
4 |
5 | This repository is licensed under the **[GNU General Public License v3.0 (GPLv3)](LICENSE)**.
6 |
7 | Created by **[Tommy Vange Rød](https://github.com/tommyvange)**. You can see the full list of credits [here](#credits).
8 |
9 | This project is available on [GitHub](https://github.com/tommyvange/ArrStalledHandler), [Docker Hub](https://hub.docker.com/r/tommythebeast/arrstalledhandler) and the [Unraid Community App store](#unraid-deployment).
10 |
11 | [](https://github.com/tommyvange/ArrStalledHandler/actions/workflows/publish-docker-image.yml)
12 | [](https://github.com/tommyvange/ArrStalledHandler/actions/workflows/check-docker-image.yml)
13 |
14 | ----------
15 |
16 | ## Features
17 |
18 | - **Automatic Handling of Stalled Downloads**:
19 | - Detect stalled downloads based on error messages from Radarr/Sonarr/Lidarr/Readarr queues.
20 | - Detect download stuck on "Downloading Metadata" in qBittorrent and treat them as stalled.
21 | - Perform configurable actions such as:
22 | - Remove the stalled download.
23 | - Blocklist the stalled download.
24 | - Blocklist and re-trigger a search for the movie or episodes.
25 | - **Database Tracking**:
26 | - Tracks stalled downloads in a SQLite database to ensure actions are only taken after a specified timeout period.
27 | - **Logging**:
28 | - Verbose and informative logging controlled via configuration.
29 | - **Docker Support**:
30 | - Easily deployable with Docker and customizable run intervals.
31 |
32 | ----------
33 |
34 |
35 | ## Configuration
36 |
37 | The script is fully configurable using environment variables specified in a `.env` file. Below is a description of each configuration option:
38 |
39 | ### `.env` Variables
40 |
41 | | Variable | Description | Default Value |
42 | |-----------------------------------------|-------------------------------------------------------------------------------------------------|------------------------|
43 | | `RADARR_URL` | The base URL for Radarr's API. Example: `http://localhost:7878,http://otherhost:7878`. | None (required) |
44 | | `RADARR_API_KEY` | The API key for Radarr (found in Radarr settings). | None (required) |
45 | | `SONARR_URL` | The base URL for Sonarr's API. Example: `http://localhost:8989,http://otherhost:8989`. | None (required) |
46 | | `SONARR_API_KEY` | The API key for Sonarr (found in Sonarr settings). | None (required) |
47 | | `LIDARR_URL` | The base URL for Lidarr's API. Example: `http://localhost:8686,http://otherhost:8686`. | None (required) |
48 | | `LIDARR_API_KEY` | The API key for Lidarr (found in Radarr settings). | None (required) |
49 | | `READARR_URL` | The base URL for Readarr's API. Example: `http://localhost:8787,http://otherhost:8787`. | None (required) |
50 | | `READARR_API_KEY` | The API key for Readarr (found in Sonarr settings). | None (required) |
51 | | `STALLED_TIMEOUT` | Time (in seconds) a download must remain stalled before actions are taken. | `3600` (1 hour) |
52 | | `STALLED_ACTION` | Action to perform on stalled downloads: `REMOVE`, `BLOCKLIST`, or `BLOCKLIST_AND_SEARCH`. | `BLOCKLIST_AND_SEARCH` |
53 | | `VERBOSE` | Enable verbose logging for debugging (`true` or `false`). | `false` |
54 | | `RUN_INTERVAL` | Time (in seconds) between script executions when running in Docker. | `300` (5 minutes) |
55 | | `COUNT_DOWNLOADING_METADATA_AS_STALLED` | Weather the script should count downloads with the status of "Downloading Metadata" as stalled. | `false` |
56 |
57 | To disable Radarr or Sonarr; leave the URL empty in the environment. If the service does not have a URL, then it is skipped. Multple services are allowed by using comma seperated values.
58 |
59 | ----------
60 |
61 | ## How It Works
62 |
63 | ### Script Workflow
64 |
65 | 1. **Initialization**:
66 |
67 | - The script initializes a SQLite database (`stalled_downloads.db`) to track stalled downloads.
68 | - It fetches the current queue from Radarr and Sonarr APIs.
69 | 2. **Detect Stalled Downloads**:
70 |
71 | - The script identifies stalled downloads based on the error message: `"The download is stalled with no connections"`.
72 | - [Optional] The script treats downloads with the error message `"qBittorrent is downloading metadata"` as stalled.
73 | 3. **Timeout Check**:
74 |
75 | - Downloads are only handled if they have been stalled longer than the configured `STALLED_TIMEOUT`.
76 | 4. **Perform Configured Action**:
77 |
78 | - Based on the `STALLED_ACTION` setting:
79 | - **REMOVE**: Removes the stalled download.
80 | - **BLOCKLIST**: Removes and blocklists the stalled download.
81 | - **BLOCKLIST_AND_SEARCH**: Removes, blocklists, and re-triggers a search for the movie or episodes.
82 | 5. **Logging**:
83 |
84 | - Logs detailed information about each action for visibility.
85 | 6. **Repeat**:
86 |
87 | - When running in Docker, the script waits for the `RUN_INTERVAL` duration and repeats the process.
88 |
89 | ----------
90 |
91 | ## Deployment
92 | ### Unraid Deployment
93 | 
94 | 1. Install the Community Apps extension as documented in [this guide](https://forums.unraid.net/topic/38582-plug-in-community-applications/).
95 | 2. Go to the **Apps**-section in your Unraid web-ui.
96 | 3. Search for **ArrStalledHandler**.
97 | 4. Click **Install** on the application.
98 | 5. Fill out the variables according to the [Configuration](#configuration).
99 | 6. Click **Apply**.
100 |
101 | Now the container should automatically start up and start handling your stalled downloads.
102 |
103 | ### Docker Deployment ([Docker Hub](https://hub.docker.com/r/tommythebeast/arrstalledhandler))
104 |
105 | **Docker compose**
106 |
107 | More info at [Docker Docs](https://docs.docker.com/compose/intro/compose-application-model/).
108 | ``` yaml
109 | services:
110 | arr-stalled-handler:
111 | image: tommythebeast/arrstalledhandler:latest
112 | container_name: ArrStalledHandler
113 | restart: unless-stopped
114 | environment:
115 | RADARR_URL: "http://localhost:7878,http://otherhost:7878"
116 | RADARR_API_KEY: "your_radarr_api_key,your_2nd_radarr_api_key"
117 | SONARR_URL: "http://localhost:8989,http://otherhost:8989"
118 | SONARR_API_KEY: "your_sonarr_api_key,your_2nd_sonarr_api_key"
119 | LIDARR_URL: "http://localhost:8686,http://otherhost:8686"
120 | LIDARR_API_KEY: "your_lidarr_api_key,your_2nd_lidarr_api_key"
121 | READARR_URL: "http://localhost:8787,http://otherhost:8787"
122 | READARR_API_KEY: "your_readarr_api_key,our_2nd_readarr_api_key"
123 | STALLED_TIMEOUT: "3600"
124 | STALLED_ACTION: "BLOCKLIST_AND_SEARCH"
125 | VERBOSE: "false"
126 | RUN_INTERVAL: "300"
127 | COUNT_DOWNLOADING_METADATA_AS_STALLED: "false"
128 | ```
129 |
130 | **Docker CLI**
131 |
132 | More info at [Docker Docs](https://docs.docker.com/engine/containers/run/).
133 |
134 | *Multi-line:*
135 | ``` bash
136 | docker run -d \
137 | --name=ArrStalledHandler \
138 | -e RADARR_URL=http://localhost:7878,http://otherhost:7878 \
139 | -e RADARR_API_KEY=your_radarr_api_key,your_2nd_radarr_api_key \
140 | -e SONARR_URL=http://localhost:8989,http://otherhost:8989 \
141 | -e SONARR_API_KEY=your_sonarr_api_key,your_2nd_sonarr_api_key \
142 | -e LIDARR_URL=http://localhost:8686,http://otherhost:8686 \
143 | -e LIDARR_API_KEY=your_lidarr_api_key,your_2nd_lidarr_api_key \
144 | -e READARR_URL=http://localhost:8787,http://otherhost:8787 \
145 | -e READARR_API_KEY=your_readarr_api_key,our_2nd_readarr_api_key \
146 | -e STALLED_TIMEOUT=3600 \
147 | -e STALLED_ACTION=BLOCKLIST_AND_SEARCH \
148 | -e VERBOSE=false \
149 | -e RUN_INTERVAL=300 \
150 | -e COUNT_DOWNLOADING_METADATA_AS_STALLED=false \
151 | --restart unless-stopped \
152 | tommythebeast/arrstalledhandler:latest
153 | ```
154 |
155 | *One line:*
156 | ``` bash
157 | docker run -d --name=ArrStalledHandler -e RADARR_URL=http://localhost:7878,http://otherhost:7878 -e RADARR_API_KEY=your_radarr_api_key,your_2nd_radarr_api_key -e SONARR_URL=http://localhost:8989,http://otherhost:8989 -e SONARR_API_KEY=your_sonarr_api_key,your_2nd_sonarr_api_key -e LIDARR_URL=http://localhost:8686,http://otherhost:8686 -e LIDARR_API_KEY=your_lidarr_api_key,your_2nd_lidarr_api_key -e READARR_URL=http://localhost:8787,http://otherhost:8787 -e READARR_API_KEY=your_readarr_api_key,our_2nd_readarr_api_key -e STALLED_TIMEOUT=3600 -e STALLED_ACTION=BLOCKLIST_AND_SEARCH -e VERBOSE=false -e RUN_INTERVAL=300 -e COUNT_DOWNLOADING_METADATA_AS_STALLED=false --restart unless-stopped tommythebeast/arrstalledhandler:latest
158 | ```
159 |
160 | ### Docker Deployment (Manual)
161 |
162 | 1. **Clone the Repository**:
163 |
164 | ``` bash
165 | git clone https://github.com/your-username/ArrStalledHandler.git
166 | cd ArrStalledHandler
167 | ```
168 |
169 | 2. **Configure Environment**:
170 |
171 | Create a `.env` file and populate it with the required variables:
172 |
173 | ``` env
174 | RADARR_URL=http://localhost:7878,http://otherhost:7878
175 | RADARR_API_KEY=aaaabbbbcccc111122223333,xxxxyyyyzzzz777788889999
176 | SONARR_URL=http://localhost:8989,http://otherhost:8989
177 | SONARR_API_KEY=aaaabbbbcccc111122223333,xxxxyyyyzzzz777788889999
178 | LIDARR_URL=http://localhost:8686,http://otherhost:8686
179 | LIDARR_API_KEY=aaaabbbbcccc111122223333,xxxxyyyyzzzz777788889999
180 | READARR_URL=http://localhost:8787,http://otherhost:8787
181 | READARR_API_KEY=aaaabbbbcccc111122223333,xxxxyyyyzzzz777788889999
182 | STALLED_TIMEOUT=3600
183 | STALLED_ACTION=BLOCKLIST_AND_SEARCH
184 | VERBOSE=false
185 | RUN_INTERVAL=300
186 | COUNT_DOWNLOADING_METADATA_AS_STALLED=false
187 | ```
188 |
189 | 3. **Build the Docker Image**:
190 |
191 | ``` bash
192 | docker-compose build .
193 | ```
194 |
195 | 4. **Run the Docker Container**:
196 |
197 | ``` bash
198 | docker-compose up -d
199 | ```
200 |
201 | ### Local Installation
202 |
203 | *Requires Python 3.13*
204 |
205 | 1. **Clone the Repository**:
206 |
207 | ``` bash
208 | git clone https://github.com/your-username/ArrStalledHandler.git
209 | cd ArrStalledHandler
210 | ```
211 |
212 | 2. **Install Dependencies**:
213 | ``` bash
214 | pip install -r requirements.txt
215 | ```
216 |
217 | 3. **Configure Environment**:
218 |
219 | Create a `.env` file and populate it with the required variables:
220 |
221 | ``` env
222 | RADARR_URL=http://localhost:7878,http://otherhost:7878
223 | RADARR_API_KEY=aaaabbbbcccc111122223333,xxxxyyyyzzzz777788889999
224 | SONARR_URL=http://localhost:8989,http://otherhost:8989
225 | SONARR_API_KEY=aaaabbbbcccc111122223333,xxxxyyyyzzzz777788889999
226 | LIDARR_URL=http://localhost:8686,http://otherhost:8686
227 | LIDARR_API_KEY=aaaabbbbcccc111122223333,xxxxyyyyzzzz777788889999
228 | READARR_URL=http://localhost:8787,http://otherhost:8787
229 | READARR_API_KEY=aaaabbbbcccc111122223333,xxxxyyyyzzzz777788889999
230 | STALLED_TIMEOUT=3600
231 | STALLED_ACTION=BLOCKLIST_AND_SEARCH
232 | VERBOSE=false
233 | RUN_INTERVAL=300
234 | COUNT_DOWNLOADING_METADATA_AS_STALLED=false
235 | ```
236 |
237 | 4. **Run the Script**:
238 |
239 | ``` bash
240 | python main.py
241 | ```
242 |
243 | ----------
244 |
245 | ## Logging
246 |
247 | - Logs are written to the console and are controlled by the `VERBOSE` environment variable.
248 | - If `VERBOSE` is set to `true`, debug-level logs are enabled.
249 |
250 | Example log output:
251 |
252 | ``` text
253 | INFO: Checking stalled downloads in Radarr...
254 | INFO: Handling Download ID 1462067687 in Radarr (elapsed time: 400 seconds).
255 | INFO: Triggering search for Movie ID 770 in Radarr using Command API...
256 | INFO: Script execution completed. Sleeping for 300 seconds...
257 | ```
258 |
259 |
260 | ----------
261 |
262 | ## Troubleshooting
263 |
264 | 1. **Script Not Executing Actions**:
265 | - Check if `STALLED_TIMEOUT` is too high.
266 | - Verify the stalled downloads are correctly detected via Radarr/Sonarr queues.
267 |
268 | ----------
269 |
270 | ## Credits
271 |
272 | ### Author
273 |
274 |
275 |
288 |
289 |
290 | You can find more of my work on my [GitHub profile](https://github.com/tommyvange) or connect with me on [LinkedIn](https://www.linkedin.com/in/tommyvange/).
291 |
292 | ### Contributors
293 | Huge thanks to everyone who dedicates their valuable time to improving, perfecting, and supporting this project!
294 |
295 |
296 |