Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tdjsnelling/sqtracker

A modern private BitTorrent tracker platform
https://github.com/tdjsnelling/sqtracker

bittorrent docker express mongodb nextjs nodejs private-tracker torrent tracker traefik

Last synced: about 2 months ago
JSON representation

A modern private BitTorrent tracker platform

Awesome Lists containing this project

README 

        
# ■ sqtracker



![Latest stable release](https://badgen.net/github/release/tdjsnelling/sqtracker/stable)

[![License GPLv3](https://badgen.net/badge/license/GPLv3/blue)](./LICENSE)

[![Client Docker image](https://badgen.net/badge/icon/sqtracker-client/blue?icon=docker&label)](https://github.com/tdjsnelling/sqtracker/pkgs/container/sqtracker-client)

[![API Docker image](https://badgen.net/badge/icon/sqtracker-api/blue?icon=docker&label)](https://github.com/tdjsnelling/sqtracker/pkgs/container/sqtracker-api)

[![Discord](https://badgen.net/discord/members/BEGXEk29Up)](https://discord.gg/BEGXEk29Up)



sqtracker is a modern private BitTorrent tracker platform.



It implements all of the features required to run a private (or public) tracker and does not focus on any one specific type of content. It is suitable for running a tracker site of any kind.



Please join the [Discord server](https://discord.gg/BEGXEk29Up) for support and general chat.



## Features



* Accounts

  * Registration modes (open / closed / invite only)

  * Sending of invites

  * Account management (2FA, password resets etc.)

  * Bonus points system (purchase invites, upload etc.)

  * Option to browse torrents without logging in (for search engine discovery)

* Torrent management

  * Uploading torrents with rich metadata (title, description, source, mediainfo, category, tags etc.)

  * Searching torrents or browsing by category or tags

  * Freeleech options (specific torrents, site-wide)

  * Torrent grouping (e.g. different formats of same movie)

  * Bookmarks

* Upload / download tracking

  * Track how much content each user has uploaded / downloaded

  * Track ratios

  * Track hit'n'runs

  * Limit downloading per user based on ratio, HnRs, or both

  * Award bonus points based on upload

* User interaction

  * Commenting on torrents and announcements

  * Up / down voting torrents

  * Requests system

* Moderation

  * Staff / admin privileges

  * Reporting torrents to be reviewed by staff

  * Detailed stats available to admins

  * Wiki system

  * Announcements / news posts

  * Ban / unban users

* Tracker appearance

  * Configurable theme / CSS

  

## Roadmap



The roadmap is still being expanded.



* Forum support & direct messages

* Better profiles (avatar, bio etc.)

* Premoderation option

* Anti-cheat

  

## Configuration



All configuration is provided via a single JavaScript file named `config.js`. This file must export an object containing 2 keys: `envs` and `secrets`.



An example configuration can be found in `config.example.js`. This file contains examples and explanations for each config value.



If your configuration is not valid, sqtracker will fail to start.



### The initial admin user



On first start up, sqtracker will create a user named `admin` with the password `admin`. A confirmation email will be sent to the admin email address you specified in your config file. Once logged in for the first time, you should change the admin password immediately. This admin user can be used to send other admin invites (normal accounts cannot send admin invites). This user cannot be deleted/banned.



## Deploying



### Components



An sqtracker deployment is made up of 4 separate components. These are:



#### 1. The sqtracker API service



The sqtracker API service handles all actions taken by users (authentication, uploads, searching etc.), implements the BitTorrent tracker specification to handle announces and scrapes, and provides the RSS feed. 



#### 2. The sqtracker client service



The sqtracker client service provides the modern, responsive web interface that users interact with.



#### 3. A MongoDB database



[MongoDB](https://www.mongodb.com/) is a popular and powerful document-oriented database. Version 5.2 or higher is required.



#### 4. A HTTP proxy server



The HTTP proxy allows the client, API, and BitTorrent tracker to all be accessible via a single endpoint.



Traefik is recommended and is configured by default. An Nginx config file is also provided for those that prefer it and the `docker-compose.yml` file contains an Nginx block that can be enabled. 



### Deploying with Docker compose



The sqtracker platform is designed to be deployed via Docker. Once a configuration file is created, deploying is as simple as running `docker compose up -d` at the root of the project.



To get HTTPS working, you will need to change a few values:



* In `docker-compose.yml`: `--certificatesresolvers.tlsresolver.acme.email=` needs to have a valid email address.

* In `traefik.yml`: 2 instances of `` Host(`example.com`) `` need to contain your domain name.



If you change the name of any services in `docker-compose.yml`, you will also need to update the relevant host names in your `config.js` and `traefik.yml` files.



sqtracker is reasonably light-weight, but you should still invest in a VPS with decent resources if you want to run a fast and performant tracker.



### Deploying with a PaaS platform



Alternatively, you can deploy each service individually on a PaaS cloud platform such as [Northflank](https://northflank.com).



You will need to deploy each of the 4 components listed above. The Docker images for the client and API services are published in this repository.



## Adding a translation



New translations are always appreciated!



To add a new translation in your own language, create a new JSON file with your 2 character locale code in `client/locales`. For example, `client/locales/en.json`. In the `client/locales/index.js` file, you should then import your JSON file and add it to the exported object along with the existing locales.



The best place to start is to copy the `en.json` file and work through it, translating each English string.



There is also an [inlang project](https://fink.inlang.com/github.com/tdjsnelling/sqtracker) to aid with translation.



### Existing translations



| Language           | Contributed by                                       |

|--------------------|------------------------------------------------------|

| English            |                                                      |

| Russian            | [@smlinux](https://github.com/smlinux)               |

| Esperanto          | [@smlinux](https://github.com/smlinux)               |

| German             | [@EchterAlsFake](https://github.com/EchterAlsFake)   |

| Simplified Chinese | [@0EAC](https://github.com/0EAC)                     |

| French             | [@Klaiment](https://github.com/Klaiment)             |

| Spanish            | [@CerealKillerjs](https://github.com/CerealKillerjs) |

| Italian            | [@NotLugozzi](https://github.com/NotLugozzi)         |



## Screenshots



Splash screen

splash



Home

home



Torrent

torrent



Upload

upload



Categories

categories



Profile

profile



Account

account



Announcement

announcement



Request

request



Report

report



## Contributing



Pull requests are welcome! If you fork sqtracker and think you have made some improvements, please open a pull request so other users deploying sqtracker from this repository can also get the benefits.



Please see the [CONTRIBUTING](./CONTRIBUTING.md) document for guidance on code style etc.



## Donations



A lot of hard work goes into building and maintaining sqtracker. If you're feeling kind, my PayPal link is in the GitHub "Sponsor this project" section. If you would prefer a different method, please reach out to me on Discord.



## License



GNU GPLv3