torrentd

module
v0.3.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 29, 2020 License: GPL-3.0

README

sp0x codecov Go Report Card

Torrentd

This project aims to make torrent searching easier.
You can use it as a torrent indexer to connect servers like Sonarr, Radarr or others.
It gathers additional information about each torrent and enriches its data.
You can also use it to track torrent sites, if you want to mirror a tracker, or a record on torrents.

Torrent Tracker definitions

You can define your torrent trackers in these directories:

  • ~/.torrentd/definitions
  • /definitions

This project also carries it's embedded definitions with which it was built.
The definition that's loaded is the latest one.

Storage

You'll also need to store your results somehow. Depending on the way you run this project there are a few ways you could do that.
The supported databases are:

  • SQLite
  • BoltDB
  • Firebase

Configuration

The configuration is stored in: ~/.torrentd/torrentd.yml
Here's a brief overview of what you can configure:

# The key for accessing the API.
api_key: hsreth45hgertdf
# Places where index definitions are stored.
definition:
  dirs:
  - ./definitions
  - ~/.torrentd/definitions
# The port on which the API runs.
port: 5000
# Whether to print more logs.
verbose: false

# Index config:
indexers:
    # We'll configure the zamunda index
    zamunda:
      username: myusername
      password: g43ewef
      #To use the the login creds in the index definition you just need to use them as a template in the login block.
      #Like this:
      #login:
      #  path: takelogin.php
      #  method: post
      #  inputs:
      #    username: "{{ .Config.username }}"
      #    password: "{{ .Config.password }}" 

Caching

By default, the server caches the following data:

  • Connectivity checks (LRU with Timeout)
  • Search results (LRU with Timeout)

Directories

Path Synopsis
mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
cache/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
source/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
http/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
rss

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL