Skip to content

dan-online/oxidized

Repository files navigation

Forks Stargazers Issues MIT License


Logo

oxidized

self-hosted torrent meta-search application
with a self-building, self-updating database
powered by Rust + PostgreSQL

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. License
  4. Contact
  5. Disclaimer

About The Project

oxidized is a torrent meta-search application designed to simplify and enhance your torrent searching experience. Built with Rust + Rocket, oxidized delivers a reliable and responsive API for seamless integration. Utilizing PostgreSQL for data management, oxidized ensures efficient storage and retrieval of torrent information.

Features

  • Tracker integration
    • Queries the top trackers for the most relevant and up-to-date seeder/leecher information
  • Self-building, self-updating database (Spider)
    • Watches the DHT (Distributed Hash Table) for new torrents and automatically adds them to the database
    • 7680 indexed torrents/hr leads to 180k+ torrents/day
    • Cleans stale torrents (no seeders/leechers for 3 days)
  • Torznab API
    • Allows for integration with popular media management clients such as Sonarr, Radarr, and Lidarr

oxidized aims to provide a straightforward and efficient solution for anyone to index torrents, without unnecessary frills or complexities.

Getting Started

Docker

The easiest way to get started with oxidized is to use the provided Docker image

Here is a sample docker-compose.yml

# create a network
$ docker network create oxidized

# postgres database
$ docker run -d --net oxidized --name postgres -e POSTGRES_PASSWORD=oxidized -e POSTGRES_DB=oxidized postgres:alpine

# oxidized
$ docker run -d --net oxidized -e OXIDIZED_DATABASE_URL=postgres://postgres:oxidized@postgresql/oxidized --name oxidized danonline/oxidized

Configuration

oxidized requires a configuration file to run. By default, it looks for config.toml in the current working directory. You can override the default values using the config.toml or by setting environment variables in the format of: OXIDIZED_{SECTION}_{KEY}.

For example: OXIDIZED_DATABASE_URL

License

Distributed under the MIT License. See LICENSE for more information.

Contact

DanCodes - dan@dancodes.online

Project Link: https://github.com/dan-online/oxidized

Disclaimer

The information and software contained herein are provided solely for educational purposes. I am not responsible for any misuse of this software.

You, the user, are solely responsible for any actions taken or decisions made based on the information or software provided. I am not liable for any direct, indirect, incidental, consequential, or punitive damages arising from the use or misuse of this information or software.