Skip to content
This repository was archived by the owner on Jun 22, 2023. It is now read-only.

Commit 5c4202a

Browse files
mickvandijkemickvandijke
committed
chore: done various style and text improvements
1 parent 675d837 commit 5c4202a

File tree

11 files changed

+122
-126
lines changed

11 files changed

+122
-126
lines changed

‎README.md‎

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,7 @@
11
# Torrust Documentation
2+
This is the documentation site for all Torrust projects.
23

3-
## Introduction
4-
Torrust is an open source project that brings you all the tools you need to host your own (private) BitTorrent tracker and online torrent index.
5-
6-
### Project structure
7-
Torrust is split up into two separate applications.
8-
9-
- [__Torrust Tracker__](https://github.com/torrust/torrust-tracker): A lightweight but incredibly powerful and feature-rich (private) BitTorrent Tracker.
10-
- [__Torrust Index__](https://github.com/torrust/torrust): A torrent indexing website that depends on the Torrust tracker.
11-
12-
# Installation
13-
14-
## Torrust index + tracker
15-
Please follow our [guide](https://torrust.github.io/torrust-documentation/installation/).
16-
17-
## Torrust Documentation Site
4+
## Installation
185
### Prerequisites (installed)
196

207
- [Python](https://www.python.org/)
@@ -30,7 +17,7 @@ Clone repo:
3017
git clone https://github.com/torrust/torrust-documentation.git
3118
```
3219

33-
# Usage
20+
## Usage
3421

3522
### Run Development
3623

‎docs/index.md‎

Lines changed: 25 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,27 @@
1-
# Introduction
2-
*Torrust* is an open source project that brings you all the tools you need to host your own (private) BitTorrent tracker and online torrent index.
1+
# Introduction to Torrust
2+
3+
<center>
4+
<img width="150" src="assets/images/logo.png">
5+
</center>
6+
7+
Torrust is an open source project that aims to provide you with the tools you need to host your own torrent indexes with ease.
8+
9+
The Torrust name is a combination of **Tor**rent and __Rust__.
10+
11+
> <cite> "Rust is a modern systems programming language focusing on safety, speed, and concurrency." </cite>
12+
>
13+
> <cite> Introduction </cite> - Rust By Example, https://doc.rust-lang.org/rust-by-example/.
14+
15+
This is why we believe that Rust is the perfect tool for our project.
316

417
## Project structure
5-
Torrust is split up into two separate applications.
6-
7-
- [__Torrust Tracker__](https://github.com/torrust/torrust-tracker): A high-performance and feature-rich (private) BitTorrent tracker.
8-
- [__Torrust Index__](https://github.com/torrust/torrust): A torrent indexing website that depends on the Torrust tracker.
9-
10-
## Features
11-
- [X] Self-hosted high-performance BitTorrent tracker.
12-
- [X] Support for public, private and whitelisted tracker modes.
13-
- [X] API for whitelisting torrents and issuing tracker keys.
14-
- [X] Email / Password authentication (optional email verification).
15-
- [X] Torrent Uploading / Downloading (including magnet links).
16-
- [X] Torrent moderation.
17-
- [X] Customizable torrent categories.
18-
- [X] No external services needed.
19-
- [X] Completely written in Rust!
20-
21-
## Screenshots
22-
![Web UI Sign Up page](https://raw.githubusercontent.com/torrust/torrust/main/img/signup.png)
23-
![Web UI Popular page](https://raw.githubusercontent.com/torrust/torrust/main/img/torrents.png)
24-
![Web UI Torrent page](https://raw.githubusercontent.com/torrust/torrust/main/img/torrent.png)
25-
![Web UI Upload page](https://raw.githubusercontent.com/torrust/torrust/main/img/upload.png)
26-
![Web UI Settings page](https://raw.githubusercontent.com/torrust/torrust/main/img/settings.png)
27-
28-
## Live Demo
29-
- Index: [https://torrust.dutchbits.nl](https://torrust.dutchbits.nl)
30-
- Tracker: [http://tracker.dutchbits.nl](http://tracker.dutchbits.nl)
31-
32-
## Install
33-
- Torrust Tracker: [__Install__](https://torrust.com/torrust-tracker/install)
34-
- Torrust Index: [__Install__](https://torrust.com/torrust-index/install) (requires running a Torrust Tracker)
35-
- Docker (Tracker + Index): [https://github.com/torrust/torrust-docker](https://github.com/torrust/torrust-docker)
36-
37-
## Contributing
38-
Please report any bugs you find to our issue tracker. Ideas and feature requests are welcome as well!
39-
Any pull request targeting existing issues would be very much appreciated.
18+
19+
### torrust-tracker
20+
__Repository__: [https://github.com/torrust/torrust-tracker](https://github.com/torrust/torrust-tracker) <br>
21+
__Description__: A modern and feature-rich (private) BitTorrent tracker. <br>
22+
23+
### torrust-index
24+
__Repository__: [https://github.com/torrust/torrust-index](https://github.com/torrust/torrust-index) <br>
25+
__Description__: torrust-index is a feature-rich torrent indexing website for the torrust-tracker.
26+
27+

‎docs/stylesheets/extra.css‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,25 @@
1212
--md-footer-bg-color: #181818;
1313

1414
/* Text color */
15-
--md-default-fg-color: #CECAC3;
15+
--md-default-fg-color: #BDC1C6;
1616

1717
/* Header color */
18-
--md-default-fg-color--light: #FFFFFF;
18+
--md-default-fg-color--light: #DDDDDD;
1919

2020
/* Icon color */
21-
--md-default-fg-color--lighter: #CECAC3;
21+
--md-default-fg-color--lighter: #DDDDDD;
2222

2323
/* Link color */
2424
--md-typeset-a-color: #F36F3A;
2525

2626
/* Link hover color */
2727
--md-accent-fg-color: #FEC368;
28+
29+
/* Code block background color */
30+
--md-code-bg-color: #000000;
31+
32+
/* Code block text color */
33+
--md-code-fg-color: #DDDDDD;
2834
}
2935

3036
.md-header {

‎docs/torrust-index/api.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# REST API
2-
> This page is heavy WIP and missing a lot of endpoints from the newest Torrust Index.
2+
> This page is heavy WIP and missing a lot of endpoints from the newest torrust-index.
33
## Authorization
44
Some routes can only be accessed by logged in users.
55
For these routes you have to send the token obtained in [/user/login](user_api.md#login) in the `Authorization` header as a bearer token.

‎docs/torrust-index/config.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Torrust's configuration is a simple TOML file. If no TOML file is found, it will
99
## Configuration
1010

1111
### Tracker
12-
- `REQUIRED` `url`: public UDP url of the Torrust Tracker instance.
13-
- `REQUIRED` `api_url`: URL of the Torrust Tracker API, usually `http://localhost:1212`.
14-
- `REQUIRED` `token`: token configured in the Torrust Tracker configuration.
12+
- `REQUIRED` `url`: public UDP url of the torrust-tracker instance.
13+
- `REQUIRED` `api_url`: URL of the torrust-tracker API, usually `http://localhost:1212`.
14+
- `REQUIRED` `token`: token configured in the torrust-tracker configuration.
1515
- `REQUIRED` `token_valid_seconds`: Lifetime of a tracker key.
1616

1717
### NET

‎docs/torrust-index/install.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Installing the Torrust Index
2-
> The Torrust Index requires a running Torrust Tracker.
1+
# Installing the torrust-index
2+
> The torrust-index requires a running torrust-tracker.
33
## Global Prerequisites
44
- [Git](https://git-scm.com) - Version Control.
55
- [cURL](https://curl.se/) - Command line tool and library for transferring data with URLs.
@@ -62,7 +62,7 @@ nano config.toml
6262

6363
- `url`: Set to a connection string for the tracker. Eg: `udp://TRACKER_IP:6969`.
6464
- `api_url`: Set to tracker api URL. Default: `http://localhost:1212`.
65-
- `token`: Set this to an access token from the Torrust Tracker config.toml.
65+
- `token`: Set this to an access token from the torrust-tracker config.toml.
6666

6767
`[net]`
6868

‎docs/torrust-tracker/api.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Torrust Tracker REST API
1+
# torrust-tracker REST API
22
__Notice:__
33
This API should not be exposed directly to the internet, it is intended for internal use only.
44

‎docs/torrust-tracker/config.md‎

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Configuring Torrust Tracker
2-
Torrust Tracker's configuration is a simple TOML file. If no TOML file is found, it will run a default configuration.
1+
# Configuring torrust-tracker
2+
torrust-tracker's configuration is stored in a TOML file called: `config.toml`. The config file can be generated by running the torrust-tracker for the first time.
33

44
## Tracker Modes
5-
Torrust Tracker currently supports 4 different tracking modes.
5+
torrust-tracker currently supports 4 different tracking modes.
66

77
### Public
88
`mode: public`
@@ -32,21 +32,21 @@ AND the tracker will only track whitelisted torrents.
3232
## Configuration
3333

3434
### Root Level
35-
| Root | REQUIRED | | Values | Default |
36-
|-----------------------------------|----------|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|-----------|
37-
| log_level | OPTIONAL | Log level. | `off`, `info` or `trace` | `info` |
38-
| mode | REQUIRED | Tracker Mode. | `public`, `listed`, `private` or `private_listed` | `public` |
39-
| db_driver | REQUIRED | Database Driver. | `MySQL` or `Sqlite3` | `Sqlite3` |
40-
| db_path | REQUIRED | Database Path. | `MySQL CONNECTION URL` (mysql://USERNAME:PASSWORD@HOST:3306/DATABASE) or `Sqlite3 DATABASE PATH` | `data.db` |
41-
| announce_interval | REQUIRED | Interval that peers will announce in. | Interval in seconds. | 120 |
42-
| min_announce_interval | REQUIRED | Minimal interval that peers will announce in. | Interval in seconds. | 120 |
43-
| max_peer_timeout | REQUIRED | Maximum seconds peers can be inactive before being removed. | Seconds. | 900 |
44-
| on_reverse_proxy | REQUIRED | If true, tracker will use X-Forwarded-For header as peer IP. | `true` or `false` | `false` |
45-
| external_ip | OPTIONAL | Needs to be set if announcing to this tracker from local network. | IP like: `100.69.420.117` | EMPTY |
46-
| tracker_usage_statistics | REQUIRED | Keep track of tracker usage statistics. | `true` or `false` | `true` |
47-
| persistent_torrent_completed_stat | REQUIRED | Keep track of the completed stat in torrents, even after reboot. | `true` or `false` | `false` |
48-
| inactive_peer_cleanup_interval | REQUIRED | Inactive peers get removed from each torrent every interval. | Interval in seconds or 0 to disable. | 600 |
49-
| remove_peerless_torrents | REQUIRED | Remove torrents without peers during the inactive_peer_cleanup_interval. | `true` or `false` | `true` |
35+
| Root | Requirement | | Values | Default |
36+
|-----------------------------------|-------------|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|-----------|
37+
| log_level | OPTIONAL | Log level. | `off`, `info` or `trace` | `info` |
38+
| mode | REQUIRED | Tracker Mode (See above). | `public`, `listed`, `private` or `private_listed` | `public` |
39+
| db_driver | REQUIRED | Database Driver. | `MySQL` or `Sqlite3` | `Sqlite3` |
40+
| db_path | REQUIRED | Database Path. | `MySQL CONNECTION URL` (mysql://USERNAME:PASSWORD@HOST:3306/DATABASE) or `Sqlite3 DATABASE PATH` | `data.db` |
41+
| announce_interval | REQUIRED | Interval that peers will announce in. | Interval in seconds. | 120 |
42+
| min_announce_interval | REQUIRED | Minimal interval that peers will announce in. | Interval in seconds. | 120 |
43+
| max_peer_timeout | REQUIRED | Maximum seconds peers can be inactive before being removed. | Seconds. | 900 |
44+
| on_reverse_proxy | REQUIRED | If true, tracker will use X-Forwarded-For header as peer IP. | `true` or `false` | `false` |
45+
| external_ip | OPTIONAL | Needs to be set if announcing to this tracker from local network. | IP like: `100.69.420.117` | EMPTY |
46+
| tracker_usage_statistics | REQUIRED | Keep track of tracker usage statistics. | `true` or `false` | `true` |
47+
| persistent_torrent_completed_stat | REQUIRED | Keep track of the completed stat in torrents, even after reboot. | `true` or `false` | `false` |
48+
| inactive_peer_cleanup_interval | REQUIRED | Inactive peers get removed from each torrent every interval. | Interval in seconds or 0 to disable. | 600 |
49+
| remove_peerless_torrents | REQUIRED | Remove torrents without peers during the inactive_peer_cleanup_interval. | `true` or `false` | `true` |
5050

5151
### UDP Tracker
5252
| [[udp_trackers]] (can add multiple) | OPTIONAL | | Values | Default |
@@ -90,16 +90,27 @@ inactive_peer_cleanup_interval = 600
9090
remove_peerless_torrents = true
9191

9292
[[udp_trackers]]
93-
enabled = false
93+
enabled = true
9494
bind_address = "0.0.0.0:6969"
9595

96+
[[udp_trackers]]
97+
enabled = true
98+
bind_address = ":::6969"
99+
96100
[[http_trackers]]
97101
enabled = true
98102
bind_address = "0.0.0.0:6969"
99103
ssl_enabled = false
100104
ssl_cert_path = ""
101105
ssl_key_path = ""
102106

107+
[[http_trackers]]
108+
enabled = true
109+
bind_address = ":::6969"
110+
ssl_enabled = false
111+
ssl_cert_path = ""
112+
ssl_key_path = ""
113+
103114
[http_api]
104115
enabled = true
105116
bind_address = "127.0.0.1:1212"

‎docs/torrust-tracker/install.md‎

Lines changed: 7 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Installing the Torrust Tracker
1+
# Installing the torrust-tracker
22
## Global Prerequisites
33
- [Git](https://git-scm.com) - Version Control.
44
- [cURL](https://curl.se/) - Command line tool and library for transferring data with URLs.
@@ -12,7 +12,7 @@
1212
* SQLite3:
1313
* for Debian/Ubuntu: ```sudo apt-get install libsqlite3-dev```
1414

15-
## Install
15+
## Installation
1616
1\. Create the torrust install directory (if you haven't already) and clone the repo:
1717
```bash
1818
mkdir /opt/torrust
@@ -32,7 +32,7 @@ cargo build --release
3232
./target/release/torrust-tracker
3333
```
3434

35-
4\. Edit the newly created `config.toml` file (see: [Config Documentation](https://torrust.com/torrust-tracker/config/)):
35+
4\. Edit the newly created `config.toml` file (See: [Configuration](https://torrust.com/torrust-tracker/config/)):
3636
```bash
3737
nano config.toml
3838
```
@@ -78,7 +78,7 @@ admin = "MyAccessToken"
7878
sudo ufw allow 6969
7979
```
8080

81-
### (optional) Use SSL
81+
### Setup SSL (optional)
8282
> If you are using a reverse proxy like NGINX, you can skip this step and use NGINX for the SSL instead.
8383
8484
1\. Edit your `nano.config` file and change the following settings:
@@ -92,7 +92,7 @@ ssl_key_path = "YOUR_CERT_KEY_PATH"
9292
...
9393
```
9494

95-
## Install with NGINX
95+
## Installation with NGINX
9696
Follow steps 1-4 from install above.
9797

9898
5\. Change the following settings in `config.toml`:
@@ -164,33 +164,6 @@ ln -s /etc/nginx/sites-available/tracker.torrust.com /etc/nginx/sites-enabled/
164164
sudo systemctl reload nginx
165165
```
166166

167-
## Usage
168-
1\. While in the `torrust-tracker` folder, you can run the torrust-tracker like this:
169-
```bash
170-
./target/release/torrust-tracker
171-
```
172-
173-
## Usage with Tmux
174-
1\. Open a new Tmux session:
175-
```bash
176-
tmux new -s torrust-tracker
177-
```
178-
179-
2\. While in Tmux session, run the torrust-tracker:
180-
```bash
181-
cd /opt/torrust/torrust-tracker
182-
./target/release/torrust-tracker
183-
```
184-
185-
3\. Detach from Tmux session:
186-
```
187-
CTRL+B
188-
D
189-
```
167+
<br>
190168

191-
## Announce URL
192-
| | Default | NGINX |
193-
|-------------|----------------------------------|--------------------------------------|
194-
| UDP | udp://TRACKER_IP:PORT/announce | X |
195-
| HTTP | http://TRACKER_IP:PORT/announce | http://tracker.YOUR_DOMAIN/announce |
196-
| HTTPS (SSL) | https://TRACKER_IP:PORT/announce | https://tracker.YOUR_DOMAIN/announce |
169+
__[How to run torrust-tracker](https://torrust.com/torrust-tracker/usage/)__

‎docs/torrust-tracker/usage.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Using the torrust-tracker
2+
## Usage
3+
1\. While in the `torrust-tracker` folder, you can run the torrust-tracker like this:
4+
```bash
5+
./target/release/torrust-tracker
6+
```
7+
8+
## Usage with Tmux
9+
1\. Open a new Tmux session:
10+
```bash
11+
tmux new -s torrust-tracker
12+
```
13+
14+
2\. While in Tmux session, run the torrust-tracker:
15+
```bash
16+
cd /opt/torrust/torrust-tracker
17+
./target/release/torrust-tracker
18+
```
19+
20+
3\. Detach from Tmux session:
21+
```
22+
CTRL+B
23+
D
24+
```
25+
26+
## Announce URL
27+
| | Default | NGINX |
28+
|-------------|----------------------------------|--------------------------------------|
29+
| UDP | udp://TRACKER_IP:PORT/announce | X |
30+
| HTTP | http://TRACKER_IP:PORT/announce | http://tracker.YOUR_DOMAIN/announce |
31+
| HTTPS (SSL) | https://TRACKER_IP:PORT/announce | https://tracker.YOUR_DOMAIN/announce |

0 commit comments

Comments
 (0)