You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-7Lines changed: 2 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,19 +35,15 @@ It implements all of the features required to run a private (or public) tracker
35
35
36
36
### Components
37
37
38
-
An sqtracker deployment is made up of 5 separate components. These are:
39
-
40
-
#### A BitTorrent tracker
41
-
42
-
sqtracker does not implement the BitTorrent tracker spec itself. Instead, it works alongside a tracker server such as [opentracker](https://erdgeist.org/arts/software/opentracker/). In theory, other generic BitTorrent tracker software should work, but opentracker is recommended for the time being.
38
+
An sqtracker deployment is made up of 4 separate components. These are:
43
39
44
40
#### A MongoDB database
45
41
46
42
[MongoDB](https://www.mongodb.com/) is a popular and powerful document-oriented database. Version 5.2 or higher is required.
47
43
48
44
#### The sqtracker API service
49
45
50
-
The sqtracker API service handles all actions taken by users (authentication, uploads, searching etc.), provides the RSS feed, and proxies announce requests to the tracker server.
46
+
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.
51
47
52
48
#### The sqtracker client service
53
49
@@ -88,7 +84,6 @@ If your configuration is not valid, sqtracker will fail to start.
88
84
| SQ_TORRENT_CATEGORIES | envs |`["Movies", "TV"]`| An array of categories available on your tracker site |
89
85
| SQ_BASE_URL | envs |https://demo.sqtracker.dev| The URL of your tracker site |
90
86
| SQ_API_URL | envs |https://demo.sqtracker.dev/api| The URL of your API. Under the recommended setup, it should be `${SQ_BASE_URL}/api`|
91
-
| SQ_TRACKER_URL | envs |http://sq_opentracker:6969| The URL of your tracker server. Under the recommended setup, it should be `http://sq_opentracker:6969`|
92
87
| SQ_MONGO_URL | envs | mongodb://sq_mongodb/sq | The URL of your MongoDB server. Under the recommended setup, it should be `mongodb://sq_mongodb/sq`|
93
88
| SQ_MAIL_FROM_ADDRESS | envs |mail@sqtracker.dev| The address that mail will be sent from |
94
89
| SQ_SMTP_HOST | envs | smtp.example.com | The hostname of your SMTP server |
0 commit comments