starred/Cleanuparr-Cleanuparr
1
0
Fork 0
mirror of https://github.com/Cleanuparr/Cleanuparr.git synced 2026-02-04 03:16:52 -06:00
Code Issues 38 Packages Projects Releases 10 Wiki Activity

[DOCUMENT] The format of blacklist, blacklist_permissive and whitelist #96

New Issue
Closed
opened 2025-10-09 16:58:02 -05:00 by giteasync · 12 comments
giteasync commented 2025-10-09 16:58:02 -05:00
Owner
Copy Link

Originally created by @janusn on GitHub.

Before submitting a bug report, I have:

  • Reviewed the documentation.
  • Ensured I am using ghcr.io/flmorg/cleanuperr docker repository.
  • Ensured I am using the latest version.
  • Enabled verbose logging.

What is the behavior?

I must start by thanks a ton for your effort. I raised a feature request on the forums of sonarr for these features. I don't even know whether it is considered.

I am here to report a confusion on the document:
The document said the value of SONARR/RADARR/LIDARR__BLOCK__PATH must be JSON compatible and the example are /blocklist.json and https://example.com/blocklist.json

However, the actual content of an example file blacklist is not a json file at all. I am confused.

  1. What is the intended / actual content of the file should be?
  2. What are the keys for the json file if the answer of question 1 is json?
  3. Can you please update the document to elaborate on this?

Thank you very much.

Which operating system do you use?

Linux

What type of deployment do you use?

Docker container

Relevant log output

Not Applicable

Anything else?

No response

Originally created by @janusn on GitHub. ### Before submitting a bug report, I have: - [x] Reviewed the documentation. - [x] Ensured I am using ghcr.io/flmorg/cleanuperr docker repository. - [x] Ensured I am using the latest version. - [x] Enabled verbose logging. ### What is the behavior? I must start by thanks a ton for your effort. I raised a feature request on the [forums of sonarr](https://forums.sonarr.tv/t/customizable-fail-downloads-extensions-and-integration-with-prowlarr-or-applicable-to-all-indexers/39073/12) for these features. I don't even know whether it is considered. I am here to report a confusion on the document: The [document](https://flmorg.github.io/cleanuperr/docs/configuration/arrs/sonarr/?SONARR__BLOCK__PATH) said the value of `SONARR/RADARR/LIDARR__BLOCK__PATH` must be JSON compatible and the example are `/blocklist.json` and `https://example.com/blocklist.json` However, the actual content of an example file [blacklist](https://raw.githubusercontent.com/flmorg/cleanuperr/refs/heads/main/blacklist) is not a json file at all. I am confused. 1. What is the intended / actual content of the file should be? 2. What are the keys for the json file if the answer of question 1 is json? 3. Can you please update the document to elaborate on this? Thank you very much. ### Which operating system do you use? Linux ### What type of deployment do you use? Docker container ### Relevant log output ```shell Not Applicable ``` ### Anything else? _No response_
giteasync added the
bug
 label 2025-10-09 16:58:02 -05:00
giteasync commented 2025-10-09 16:58:04 -05:00
Author
Owner
Copy Link

@Valtora commented on GitHub:

I've included escaping backslashes on Windows 11 and am using the recommended blocklist.txt file but the logs are still showing that the blocklist is not found.

[2025-06-06 23:00:20.368 ERR] [ContentBlocker] failed to load blocklists

[2025-06-06 23:00:20.369 ERR] [ContentBlocker] ContentBlocker failed

System.ArgumentException: blocklist not found | C:\Users\MSAdmin\Documents\cleanuperr\cleanuperr\blocklist.txt

Am I doing something wrong?

@Valtora commented on GitHub: I've included escaping backslashes on Windows 11 and am using the recommended blocklist.txt file but the logs are still showing that the blocklist is not found. [2025-06-06 23:00:20.368 ERR] [ContentBlocker] failed to load blocklists [2025-06-06 23:00:20.369 ERR] [ContentBlocker] ContentBlocker failed System.ArgumentException: blocklist not found | C:\\Users\\MSAdmin\\Documents\\cleanuperr\\cleanuperr\\blocklist.txt Am I doing something wrong?
giteasync commented 2025-10-09 16:58:04 -05:00
Author
Owner
Copy Link

@janusn commented on GitHub:

I see. Escaping backslashes.

@janusn commented on GitHub: I see. Escaping backslashes.
giteasync commented 2025-10-09 16:58:04 -05:00
Author
Owner
Copy Link

@Flaminel commented on GitHub:

I mean someone using Windows put something like this at some point and the path is not json compatible:

LIDARR__BLOCK__PATH=C:\cleanuperr\blocklist.txt

For it to be valid, the \ character should be escaped like this:

LIDARR__BLOCK__PATH=C:\\cleanuperr\\blocklist.txt

The accepted values for patterns inside the blocklist file are documented here:
https://flmorg.github.io/cleanuperr/docs/configuration/arrs/sonarr?SONARR__BLOCK__PATH

*example
example*
*example*
example
regex:<ANY_REGEX>
@Flaminel commented on GitHub: I mean someone using Windows put something like this at some point and the path is not json compatible: ``` LIDARR__BLOCK__PATH=C:\cleanuperr\blocklist.txt ``` For it to be valid, the `\` character should be escaped like this: ``` LIDARR__BLOCK__PATH=C:\\cleanuperr\\blocklist.txt ``` The accepted values for patterns inside the blocklist file are documented here: https://flmorg.github.io/cleanuperr/docs/configuration/arrs/sonarr?SONARR__BLOCK__PATH ``` *example example* *example* example regex:<ANY_REGEX> ```
giteasync commented 2025-10-09 16:58:04 -05:00
Author
Owner
Copy Link

@Flaminel commented on GitHub:

There's a bit of a confusion here about what needs to be JSON compatible. The value of the variable must be JSON compatible, so basically the path itself (e.g. /path/to/file) must be that way. The actual file should look like the one you linked, with a pattern on every line.

@Flaminel commented on GitHub: There's a bit of a confusion here about what needs to be JSON compatible. The value of the variable must be JSON compatible, so basically the path itself (e.g. `/path/to/file`) must be that way. The actual file should look like the one you [linked](https://raw.githubusercontent.com/flmorg/cleanuperr/refs/heads/main/blacklist), with a pattern on every line.
giteasync commented 2025-10-09 16:58:04 -05:00
Author
Owner
Copy Link

@janusn commented on GitHub:

I see. You mean the mean the values can be interpreted as strings in json.

I wonder what does not qualify then. Using characters other than ‘*’ and wildcard?

@janusn commented on GitHub: I see. You mean the mean the values can be interpreted as strings in json. I wonder what does not qualify then. Using characters other than ‘*’ and wildcard?
giteasync commented 2025-10-09 16:58:05 -05:00
Author
Owner
Copy Link

@Flaminel commented on GitHub:

@Valtora Is this the exact path to the blocklist though? Seems like you have cleanuperr twice in there, but is it intentional?
C:\Users\MSAdmin\Documents\cleanuperr\cleanuperr\blocklist.txt

@Flaminel commented on GitHub: @Valtora Is this the exact path to the blocklist though? Seems like you have `cleanuperr` twice in there, but is it intentional? `C:\Users\MSAdmin\Documents\cleanuperr\cleanuperr\blocklist.txt`
giteasync commented 2025-10-09 16:58:05 -05:00
Author
Owner
Copy Link

@Flaminel commented on GitHub:

@Valtora I'm a bit confused. You are on Windows but using Docker or is it the exe file?

@Flaminel commented on GitHub: @Valtora I'm a bit confused. You are on Windows but using Docker or is it the exe file?
giteasync commented 2025-10-09 16:58:05 -05:00
Author
Owner
Copy Link

@Flaminel commented on GitHub:

@Valtora Unfortunately that's not how Docker works. The container does not have access to your host's file system, which makes sense why it can't find the file. You need to mount the file inside the container to be able to use it.
You probably need to add the following to your yaml file:

    volumes:
      - //c/Users/MSAdmin/Documents/cleanuperr/cleanuperr/blocklist.txt:/blacklist.txt
...
    environment:
      - - SONARR__BLOCK__PATH=/blacklist.txt

Don't take my word on how the exact path should look like on Windows, but I think that's it.

Reference to Docker volumes docs:
https://docs.docker.com/engine/storage/volumes/

@Flaminel commented on GitHub: @Valtora Unfortunately that's not how Docker works. The container does not have access to your host's file system, which makes sense why it can't find the file. You need to mount the file inside the container to be able to use it. You probably need to add the following to your yaml file: ``` volumes: - //c/Users/MSAdmin/Documents/cleanuperr/cleanuperr/blocklist.txt:/blacklist.txt ... environment: - - SONARR__BLOCK__PATH=/blacklist.txt ``` Don't take my word on how the exact path should look like on Windows, but I think that's it. Reference to Docker volumes docs: https://docs.docker.com/engine/storage/volumes/
giteasync commented 2025-10-09 16:58:05 -05:00
Author
Owner
Copy Link

@Valtora commented on GitHub:

@Flaminel - Apologies, I'm on Windows 11 using the Docker desktop app and using docker compose up (pointed at a .yaml file) to start the container. I'm assuming this is supported, though not ideal perhaps?

I have attached a redacted .yaml (in txt format as .yaml is not supported for upload) file for you to view in case the mistake is there.

I'm using qBittorrent, Sonarr, and Radarr only.

cleanuperr-redacted.txt

@Valtora commented on GitHub: @Flaminel - Apologies, I'm on Windows 11 using the Docker desktop app and using docker compose up (pointed at a .yaml file) to start the container. I'm assuming this is supported, though not ideal perhaps? I have attached a redacted .yaml (in txt format as .yaml is not supported for upload) file for you to view in case the mistake is there. I'm using qBittorrent, Sonarr, and Radarr only. [cleanuperr-redacted.txt](https://github.com/user-attachments/files/20634978/cleanuperr-redacted.txt)
giteasync commented 2025-10-09 16:58:05 -05:00
Author
Owner
Copy Link

@Valtora commented on GitHub:

@Flaminel - Yes, this is intentional for now but I can change it if you think that is the problem.

EDIT: Just tried it again without the nested cleanuperr dir and it still couldn't find the blocklist. This was the new directory in the .yaml file:

C:\\Users\\MSAdmin\\Documents\\blocklist.txt

For clarity, I'm not writing with quote marks, just as-is above.

@Valtora commented on GitHub: @Flaminel - Yes, this is intentional for now but I can change it if you think that is the problem. EDIT: Just tried it again without the nested cleanuperr dir and it still couldn't find the blocklist. This was the new directory in the .yaml file: C:\\\Users\\\MSAdmin\\\Documents\\\blocklist.txt For clarity, I'm not writing with quote marks, just as-is above.
giteasync commented 2025-10-09 16:58:06 -05:00
Author
Owner
Copy Link

@Valtora commented on GitHub:

@Flaminel - Thank you, that makes sense. Apologies for using up your time on this and not realising improper use in the first place. I'm new to Docker so I appreciate the pointer!

@Valtora commented on GitHub: @Flaminel - Thank you, that makes sense. Apologies for using up your time on this and not realising improper use in the first place. I'm new to Docker so I appreciate the pointer!
giteasync commented 2025-10-09 16:58:06 -05:00
Author
Owner
Copy Link

@Flaminel commented on GitHub:

@Valtora Don't worry about it, I'm happy to help!

I'm going to close this issue. Feel free to open a new one if needed or join the Discord server to get help faster. I'll assist as much as I can.

@Flaminel commented on GitHub: @Valtora Don't worry about it, I'm happy to help! I'm going to close this issue. Feel free to open a new one if needed or join the Discord server to get help faster. I'll assist as much as I can.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
enhancement
enhancement
planned
pull-request
Mirrored from GitHub Pull Request
question
No Label
bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
giteasync
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/Cleanuparr-Cleanuparr#96
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?