redactedhook

README

RedactedHook

RedactedHook is a webhook companion service for autobrr designed to check the names of uploaders, your ratio, and record labels associated with torrents on Redacted and Orpheus. It provides a simple and efficient way to validate if uploaders are blacklisted or whitelisted, to stop racing in case your ratio falls below a certain point, and to verify if a torrent's record label matches against a specified list.

Table of Contents

• Features
• Getting Started
  • Warning
  • Installation
    • Docker
    • Docker Compose
    • Using precompiled binaries
    • Building from source
• Usage
  • Config
  • Authorization
  • Payload

Features

• Verify if an uploader's name is on a provided whitelist or blacklist.
• Check for record labels. Useful for grabbing torrents from a specific record label.
• Check if a user's ratio meets a specified minimum value.
• Check the torrentSize (Useful for not hitting the API from both autobrr and redactedhook)
• Easy to integrate with other applications via webhook.
• Rate-limited to comply with tracker API request policies.
  • With a 5-minute data cache to reduce frequent API calls for the same data.

It was made with autobrr in mind.

Getting Started

Warning

[!IMPORTANT]

Remember that autobrr also checks the RED/OPS API if you have min/max sizes set. This will result in you hitting the API 2x. So for your own good, only set size checks in RedactedHook.

Installation

Docker

docker pull ghcr.io/s0up4200/redactedhook:latest

Docker Compose

version: "3.8"
services:
  redactedhook:
    container_name: redactedhook
    image: ghcr.io/s0up4200/redactedhook:latest
    user: 1000:1000
    environment:
      - SERVER_ADDRESS=0.0.0.0 # binds to 127.0.0.1 by default
      - SERVER_PORT=42135 # defaults to 42135
      - TZ=UTC
    ports:
      - "42135:42135"
    volumes:
      - /redactedhook:/redactedhook:rw
    restart: unless-stopped

Using precompiled binaries

Download the appropriate binary for your platform from the releases page.

Building from source

1. Clone the repository:

   git clone https://github.com/s0up4200/RedactedHook.git
   

2. Navigate to the project directory:

   cd RedactedHook
   

3. Build the project:

   go build
   

   or

   make build
   

4. Run the compiled binary:

   ./bin/RedactedHook --config /path/to/config.toml # config flag not necessary if file is next to binary
   

Usage

To use RedactedHook, send POST requests to the following endpoint:

Endpoint: http://127.0.0.1:42135/hook
Header: X-API-Token: YOUR_API_TOKEN
Method: POST
Expected HTTP Status: 200

You can check ratio, uploader (whitelist and blacklist), minsize, maxsize, and record labels in a single request, or separately.

Config

Most of requestData can be set in config.toml to reduce the payload from autobrr.

Config can be created with: redactedhook create-config

[authorization]
api_token = "" # generate with "redactedhook generate-apitoken"
# the api_token needs to be set as a header for the webhook to work
# eg. Header=X-API-Token asd987gsd98g7324kjh142kjh

[indexer_keys]
#red_apikey = "" # generate in user settings, needs torrent and user privileges
#ops_apikey = "" # generate in user settings, needs torrent and user privileges

[userid]
#red_user_id = 0 # from /user.php?id=xxx
#ops_user_id = 0 # from /user.php?id=xxx

[ratio]
#minratio = 0.6 # reject releases if you are below this ratio

[sizecheck]
#minsize = "100MB" # minimum size for checking, e.g., "10MB"
#maxsize = "500MB" # maximum size for checking, e.g., "1GB"

[uploaders]
#uploaders = "greatest-uploader" # comma separated list of uploaders to allow
#mode = "whitelist" # whitelist or blacklist

[record_labels]
#record_labels = "" # comma separated list of record labels to filter for

[logs]
loglevel = "trace"               # trace, debug, info
logtofile = false                # Set to true to enable logging to a file
logfilepath = "redactedhook.log" # Path to the log file
maxsize = 10                     # Max file size in MB
maxbackups = 3                   # Max number of old log files to keep
maxage = 28                      # Max age in days to keep a log file
compress = false                 # Whether to compress old log files

Authorization

API Token can be generated like this: redactedhook generate-apitoken

Set it in the config, and use it as a header like:

CURL if you want to test:

curl -X POST \
     -H "X-API-Token: 098qw0e98ass" \
     -H "Content-Type: application/json" \
     -d '{"torrent_id": 12345, "indexer": "ops", "uploaders": "the_worst_uploader,thebestuploader", "mode": "blacklist"}' \
     http://127.0.0.1:42135/hook

Payload

The minimum required data to send with the webhook:

{
    "torrent_id": {{.TorrentID}},
    "indexer": "{{ .Indexer | js }}"
}

Everything else can be set in the config.toml, but you can set them in the webhook as well, if you want to filter by different things in different filters.

indexer - "{{ .Indexer | js }}" this is the indexer that pushed the release within autobrr.

torrent_id - {{.TorrentID}} this is the TorrentID of the pushed release within autobrr.

red_user_id is the number in the URL when you visit your profile.

ops_user_id is the number in the URL when you visit your profile.

red_apikey is your Redacted API key. Needs user and torrents privileges.

ops_apikey is your Orpheus API key. Needs user and torrents privileges.

record_labels is a comma-separated list of record labels to check against.

minsize is the minimum allowed size you want to grab. Eg. 100MB

maxsize is the max allowed size you want to grab. Eg. 500MB

uploaders is a comma-separated list of uploaders to check against.

mode is either blacklist or whitelist. If blacklist is used, the torrent will be stopped if the uploader is found in the list. If whitelist is used, the torrent will be stopped if the uploader is not found in the list.