mirror of git://erdgeist.org/opentracker
Compare commits
No commits in common. '492da4a57e3ceac30709a9f932a3552eef2d2898' and 'b56e648b5e96f33db6d1cab9b43d613579837b04' have entirely different histories.
492da4a57e
...
b56e648b5e
9 changed files with 19 additions and 415 deletions
@ -1,142 +0,0 @@ |
|||||||
.Dd 15/4/2024 |
|
||||||
.Dt opentracker 1 |
|
||||||
.Os Unix |
|
||||||
.Sh opentracker |
|
||||||
.Nm opentracker |
|
||||||
.Nd a free and open bittorrent tracker |
|
||||||
.Sh SYNOPSIS |
|
||||||
.Nm |
|
||||||
.Op Fl f Ar config |
|
||||||
.Op Fl i Ar ip-select |
|
||||||
.Op Fl p Ar port-bind-tcp |
|
||||||
.Op Fl P Ar port-bind-udp |
|
||||||
.Op Fl A Ar blessed-ip |
|
||||||
.Op Fl r Ar redirect-url |
|
||||||
.Op Fl d Ar chdir |
|
||||||
.Op Fl u Ar user |
|
||||||
.Op Fl w| Fl b accesslist |
|
||||||
.Sh DESCRIPTION |
|
||||||
.Nm |
|
||||||
is a bittorrent tracker that implements announce and scrape actions over the |
|
||||||
UDP and the plain http protocol, aiming for minimal resource usage. |
|
||||||
.Pp |
|
||||||
|
|
||||||
When invoked with parameters, it binds to TCP and UDP port 6969 on all |
|
||||||
interfaces. The recommended way to configure opentracker is by providing a |
|
||||||
config file using the |
|
||||||
.Op Fl f Ar config |
|
||||||
option. See |
|
||||||
.Xr opentracker.conf 4 |
|
||||||
for details. |
|
||||||
.Pp |
|
||||||
|
|
||||||
.Sh OPTIONS |
|
||||||
The following options are available: |
|
||||||
|
|
||||||
.Bl -tag -width -indent=8 |
|
||||||
.It Fl f Ar config |
|
||||||
Parse a config file with a list of options. Consecutive command options |
|
||||||
will override options from the config file. See |
|
||||||
.Xr opentracker.conf 4 |
|
||||||
for details. |
|
||||||
|
|
||||||
.It Fl i Ar ip-select |
|
||||||
Select an ip address that will be used with the next |
|
||||||
.Op Fl p |
|
||||||
or |
|
||||||
.Op Fl P |
|
||||||
command to actually bind to this address. Setting this option without any bind |
|
||||||
options in the config file or |
|
||||||
.Op Fl p |
|
||||||
or |
|
||||||
.Op Fl P |
|
||||||
commands will limit opentracker to only bind to this address. |
|
||||||
.It Fl p Ar port-bind-tcp |
|
||||||
Bind to the TCP port on the last preceding ip address set with the |
|
||||||
.Op Fl i ip-select |
|
||||||
option or to all available addresses if none has been set. Can be given multiple |
|
||||||
times. |
|
||||||
.It Fl P Ar port-bind-udp |
|
||||||
Bind to the UDP port on the last preceding ip address set with the |
|
||||||
.Op Fl i ip-select |
|
||||||
option or to all available addresses if none has been set. Can be given multiple |
|
||||||
times. |
|
||||||
.It Fl A Ar blessed-ip |
|
||||||
Set an ip address in IPv4 or IPv6 or a net in CIDR notation to bless the network |
|
||||||
for access to restricted resources. |
|
||||||
.It Fl r Ar redirect-url |
|
||||||
Set the URL that |
|
||||||
.Nm |
|
||||||
will redirect users to when the / address is requested via HTTP. |
|
||||||
.It Fl d Ar chdir |
|
||||||
Sets the directory |
|
||||||
.Nm |
|
||||||
will |
|
||||||
.Xr chroot 2 |
|
||||||
to if ran as root or |
|
||||||
.Xr chdir 2 |
|
||||||
to if ran as unprivileged user. Note that any accesslist files need to be |
|
||||||
relative to and within that directory. |
|
||||||
.It Fl u Ar user |
|
||||||
User to run |
|
||||||
.Nm |
|
||||||
under after all operations that need privileges have finished. |
|
||||||
.It Fl w Ar accesslist | Fl b Ar accesslist |
|
||||||
If |
|
||||||
.Nm |
|
||||||
has been compiled with the |
|
||||||
.B WANT_ACCESSLIST_BLACK |
|
||||||
or |
|
||||||
.Br WANT_ACCESSLIST_WHITE |
|
||||||
options, this option sets the location of the accesslist. |
|
||||||
.El |
|
||||||
|
|
||||||
.Sh EXAMPLES |
|
||||||
|
|
||||||
Start |
|
||||||
.Nm |
|
||||||
bound on UDP and TCP ports 6969 on IPv6 localhost. |
|
||||||
|
|
||||||
.Dl # ./opentracker -i ::1 -p 6969 -P 6969 |
|
||||||
|
|
||||||
.Pp |
|
||||||
Start |
|
||||||
.Nm |
|
||||||
bound on UDP port 6868 and TCP port 6868 on IPv4 localhost and allow |
|
||||||
privileged access from the network 192.168/16 while redirecting |
|
||||||
HTTP clients accessing the root directory, which is not covered by the |
|
||||||
bittorrent tracker protocol, to https://my-trackersite.com/. |
|
||||||
|
|
||||||
.Dl # ./opentracker -i 192.168.0.4 -p 6868 -P 6969 -A 192.168/16 -r https://my-trackersite.com/ |
|
||||||
|
|
||||||
The announce URLs are http://192.168.0.4:6868/announce and |
|
||||||
udp://192.168.0.4:6868/announce respectively. |
|
||||||
|
|
||||||
.Sh FILES |
|
||||||
.Bl -tag -width indent |
|
||||||
.It Pa opentracker.conf |
|
||||||
The |
|
||||||
.Nm |
|
||||||
config file. |
|
||||||
.El |
|
||||||
.Sh SEE ALSO |
|
||||||
.Xr opentracker.conf 4 |
|
||||||
.Pp |
|
||||||
opentracker documentation |
|
||||||
.Lk https://erdgeist.org/arts/software/opentracker |
|
||||||
.Pp |
|
||||||
Bittorrent tracker protocol |
|
||||||
.Lk http://www.bittorrent.org/beps/bep_0015.html |
|
||||||
.Sh |
|
||||||
.Sh AUTHOR |
|
||||||
.An Dirk Engling |
|
||||||
.Aq Mt erdgeist@erdgeist.org . |
|
||||||
.Sh LICENSE |
|
||||||
This software is released under the Beerware License: |
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
|
||||||
and associated documentation files (the "Software"), to deal in the Software with the following |
|
||||||
terms and conditions: |
|
||||||
|
|
||||||
If you meet the author(s) someday, and you think this software is worth it, you can buy them |
|
||||||
a beer in return. |
|
@ -1,86 +0,0 @@ |
|||||||
.Dd 2024-04-18 |
|
||||||
.Dt opentracker.conf 5 |
|
||||||
.Os Unix |
|
||||||
.Sh NAME |
|
||||||
.Nm opentracker.conf |
|
||||||
.Nd configuration file for opentracker |
|
||||||
.Sh SYNOPSIS |
|
||||||
.Nm |
|
||||||
.Sh DESCRIPTION |
|
||||||
The |
|
||||||
.Nm |
|
||||||
configuration file specifies various options for configuring the behavior of the opentracker program. |
|
||||||
.Pp |
|
||||||
Lines starting with '#' are comments and are ignored. Options are specified as 'keyword value' pairs. |
|
||||||
.Pp |
|
||||||
The following options are available: |
|
||||||
|
|
||||||
.Bl -tag -width ".It access.proxy" -compact |
|
||||||
.It listen.tcp_udp Ar address |
|
||||||
Specifies an address opentracker will listen on for both TCP and UDP connections. If none are specified, opentracker listens on 0.0.0.0:6969 by default. Can be added more than once. |
|
||||||
|
|
||||||
.It listen.tcp Ar address |
|
||||||
Specifies the address opentracker will listen on for TCP connections. Can be added more than once. |
|
||||||
|
|
||||||
.It listen.udp Ar address |
|
||||||
Specifies the address opentracker will listen on for UDP connections. Can be added more than once. |
|
||||||
|
|
||||||
.It listen.udp.workers Ar threads |
|
||||||
Specifies how many threads will be spawned to handle UDP connections. Defaults to 4. |
|
||||||
|
|
||||||
.It access.whitelist Ar path/to/whitelist |
|
||||||
Specifies the path to the whitelist file containing all torrent hashes that opentracker will serve. Use this option if opentracker runs in a non-open mode. |
|
||||||
|
|
||||||
.It access.blacklist Ar path/to/blacklist |
|
||||||
Specifies the path to the blacklist file containing all torrent hashes that opentracker will not serve. Use this option if opentracker was compiled to allow blacklisting. |
|
||||||
|
|
||||||
.It access.fifo_add Ar path/to/adder.fifo |
|
||||||
Specifies the path to the FIFO (named pipe) used for dynamic changesets to accesslists. Info hashes written to this FIFO will be added to the main accesslist file. |
|
||||||
|
|
||||||
.It access.fifo_delete Ar path/to/deleter.fifo |
|
||||||
Specifies the path to the FIFO (named pipe) used for dynamic changesets to accesslists. Info hashes written to this FIFO will be removed from the main accesslist file. |
|
||||||
|
|
||||||
.It access.stats Ar ip_address_or_network |
|
||||||
Specifies the IP address or network in CIDR notation allowed to fetch stats from opentracker. |
|
||||||
|
|
||||||
.It access.stats_path Ar path |
|
||||||
Specifies the path to the stats location. You can configure opentracker to appear anywhere on your tracker. Defaults to /stats. |
|
||||||
|
|
||||||
.It access.proxy Ar ip_address_or_network |
|
||||||
Specifies the IP address or network of the reverse proxies. Opentracker will take the X-Forwarded-For address instead of the source IP address. Can be added more than once. |
|
||||||
|
|
||||||
.It livesync.cluster.listen Ar ip_address:port |
|
||||||
Specifies the IP address and port opentracker will listen on for incoming live sync packets to keep a cluster of opentrackers synchronized. |
|
||||||
|
|
||||||
.It livesync.cluster.node_ip Ar ip_address |
|
||||||
Specifies one trusted IP address for sync between trackers running in a cluster. Can be added more than once. |
|
||||||
|
|
||||||
.It batchsync.cluster.admin_ip Ar ip_address |
|
||||||
Specifies the admin IP address for old-style (HTTP-based) asynchronous tracker syncing. |
|
||||||
|
|
||||||
.It tracker.rootdir Ar path |
|
||||||
Specifies the directory opentracker will chroot/chdir to. All black/white list files must be located in this directory. |
|
||||||
|
|
||||||
.It tracker.user Ar username |
|
||||||
Specifies the user opentracker will setuid to after binding to potentially privileged ports. |
|
||||||
|
|
||||||
.It tracker.redirect_url Ar URL |
|
||||||
Specifies the URL opentracker will redirect to in response to a "GET / HTTP" request. |
|
||||||
|
|
||||||
.Sh EXAMPLES |
|
||||||
To specify the address opentracker will listen on for both TCP and UDP connections: |
|
||||||
.Dl listen.tcp_udp 0.0.0.0:6969 |
|
||||||
.Pp |
|
||||||
To specify the address opentracker will listen on for TCP connections: |
|
||||||
.Dl listen.tcp 0.0.0.0 |
|
||||||
.Pp |
|
||||||
To specify the address opentracker will listen on for UDP connections: |
|
||||||
.Dl listen.udp 0.0.0.0:6969 |
|
||||||
|
|
||||||
.Sh SEE ALSO |
|
||||||
.Xr opentracker 1 |
|
||||||
|
|
||||||
.Sh AUTHOR |
|
||||||
.An Dirk Engling |
|
||||||
.Aq Mt erdgeist@erdgeist.org |
|
||||||
|
|
Loading…
Reference in new issue