|
1 |
| -# Torrust |
2 |
| - |
3 |
| - |
| 1 | +This repo is a fork of [torrust](https://github.com/torrust/torrust-index) with some minor custom work. |
| 2 | +This is **production** code. |
| 3 | +If you've any questions about this fork specifically, join us [on discord](https://rpdl.net/discord) and let us know. |
4 | 4 |
|
5 |
| -### Project Description |
| 5 | +--- |
6 | 6 |
|
7 |
| -Torrust is a suite of client-server software for hosting online torrent indexes. |
8 |
| -**Torrust only works with the torrust tracker, it does not work with other trackers currently.** |
9 |
| - |
10 |
| -### Features |
11 |
| -* [X] User authentication |
12 |
| -* [X] E-mail verification |
13 |
| -* [X] Torrent sharing |
14 |
| -* [X] Torrent searching & filtering |
15 |
| -* [X] Private tracker compatible |
16 |
| -* [X] Content & user moderation tools |
17 |
| -* [X] Website customization |
18 |
| - |
19 |
| -### Installation |
20 |
| -Read the [installation documentation](https://torrust.github.io/torrust-documentation/installation/) for setting up the torrent index backend/frontend + [Torrust tracker](https://github.com/torrust/torrust-tracker). |
21 |
| - |
22 |
| -### Screenshots |
23 |
| - |
24 |
| - |
25 |
| - |
26 |
| - |
27 |
| - |
28 |
| - |
29 |
| -### Need |
30 |
| - |
31 |
| -The reason behind this project was that Nautilus Cyberneering GmbH needed a solution that makes it easy for anyone with a computer and internet connection to share their files with the rest of the world. |
32 |
| - |
33 |
| -### Approach |
34 |
| - |
35 |
| -We will develop a BitTorrent tracker with a private and public tracker option and a web application for uploading and downloading torrents that are being tracked by the BitTorrent tracker. |
36 |
| - |
37 |
| -### Benefit |
38 |
| - |
39 |
| -Anyone will be able to host a (private) BitTorrent tracker and online torrent index with ease. And now they can share their digital content on their own torrent index :). |
40 |
| - |
41 |
| -### Project Structure |
42 |
| - |
43 |
| -- [__Backend__](https://github.com/torrust/torrust/tree/main/backend): A REST API written in Rust with the Actix web framework that acts as a backend for the web application. |
44 |
| -- [__Frontend__](https://github.com/torrust/torrust/tree/main/frontend): A Vue application that acts as a frontend for the web application. |
45 |
| -- [__Torrust Tracker__](https://github.com/torrust/torrust-tracker): A UDP and HTTP based torrent tracker built with Rust. |
46 |
| -- [__Torrust Documentation__](https://github.com/torrust/torrust-documentation): A website made with MkDocs that hosts all the Torrust documentation. |
47 |
| - |
48 |
| -### Project Roadmap |
49 |
| - |
50 |
| -*Coming soon.* |
51 |
| - |
52 |
| -### Credits |
53 |
| -This project was developed by [Dutch Bits](https://dutchbits.nl) for [Nautilus Cyberneering GmbH](https://nautilus-cyberneering.de/). |
54 |
| - |
55 |
| -### Contact |
56 |
| -Message `Warm Beer#3352` on Discord or email `mick@dutchbits.nl`. |
| 7 | +Torrust is developed by [Dutch Bits](https://dutchbits.nl) for [Nautilus Cyberneering GmbH](https://nautilus-cyberneering.de/). [Torrust.com](https://torrust.com) |
0 commit comments