diff options
Diffstat (limited to 'man4/opentracker.conf.4')
-rw-r--r-- | man4/opentracker.conf.4 | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/man4/opentracker.conf.4 b/man4/opentracker.conf.4 new file mode 100644 index 0000000..b4f5f51 --- /dev/null +++ b/man4/opentracker.conf.4 | |||
@@ -0,0 +1,86 @@ | |||
1 | .Dd 2024-04-18 | ||
2 | .Dt opentracker.conf 5 | ||
3 | .Os Unix | ||
4 | .Sh NAME | ||
5 | .Nm opentracker.conf | ||
6 | .Nd configuration file for opentracker | ||
7 | .Sh SYNOPSIS | ||
8 | .Nm | ||
9 | .Sh DESCRIPTION | ||
10 | The | ||
11 | .Nm | ||
12 | configuration file specifies various options for configuring the behavior of the opentracker program. | ||
13 | .Pp | ||
14 | Lines starting with '#' are comments and are ignored. Options are specified as 'keyword value' pairs. | ||
15 | .Pp | ||
16 | The following options are available: | ||
17 | |||
18 | .Bl -tag -width ".It access.proxy" -compact | ||
19 | .It listen.tcp_udp Ar address | ||
20 | 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. | ||
21 | |||
22 | .It listen.tcp Ar address | ||
23 | Specifies the address opentracker will listen on for TCP connections. Can be added more than once. | ||
24 | |||
25 | .It listen.udp Ar address | ||
26 | Specifies the address opentracker will listen on for UDP connections. Can be added more than once. | ||
27 | |||
28 | .It listen.udp.workers Ar threads | ||
29 | Specifies how many threads will be spawned to handle UDP connections. Defaults to 4. | ||
30 | |||
31 | .It access.whitelist Ar path/to/whitelist | ||
32 | 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. | ||
33 | |||
34 | .It access.blacklist Ar path/to/blacklist | ||
35 | 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. | ||
36 | |||
37 | .It access.fifo_add Ar path/to/adder.fifo | ||
38 | 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. | ||
39 | |||
40 | .It access.fifo_delete Ar path/to/deleter.fifo | ||
41 | 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. | ||
42 | |||
43 | .It access.stats Ar ip_address_or_network | ||
44 | Specifies the IP address or network in CIDR notation allowed to fetch stats from opentracker. | ||
45 | |||
46 | .It access.stats_path Ar path | ||
47 | Specifies the path to the stats location. You can configure opentracker to appear anywhere on your tracker. Defaults to /stats. | ||
48 | |||
49 | .It access.proxy Ar ip_address_or_network | ||
50 | 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. | ||
51 | |||
52 | .It livesync.cluster.listen Ar ip_address:port | ||
53 | Specifies the IP address and port opentracker will listen on for incoming live sync packets to keep a cluster of opentrackers synchronized. | ||
54 | |||
55 | .It livesync.cluster.node_ip Ar ip_address | ||
56 | Specifies one trusted IP address for sync between trackers running in a cluster. Can be added more than once. | ||
57 | |||
58 | .It batchsync.cluster.admin_ip Ar ip_address | ||
59 | Specifies the admin IP address for old-style (HTTP-based) asynchronous tracker syncing. | ||
60 | |||
61 | .It tracker.rootdir Ar path | ||
62 | Specifies the directory opentracker will chroot/chdir to. All black/white list files must be located in this directory. | ||
63 | |||
64 | .It tracker.user Ar username | ||
65 | Specifies the user opentracker will setuid to after binding to potentially privileged ports. | ||
66 | |||
67 | .It tracker.redirect_url Ar URL | ||
68 | Specifies the URL opentracker will redirect to in response to a "GET / HTTP" request. | ||
69 | |||
70 | .Sh EXAMPLES | ||
71 | To specify the address opentracker will listen on for both TCP and UDP connections: | ||
72 | .Dl listen.tcp_udp 0.0.0.0:6969 | ||
73 | .Pp | ||
74 | To specify the address opentracker will listen on for TCP connections: | ||
75 | .Dl listen.tcp 0.0.0.0 | ||
76 | .Pp | ||
77 | To specify the address opentracker will listen on for UDP connections: | ||
78 | .Dl listen.udp 0.0.0.0:6969 | ||
79 | |||
80 | .Sh SEE ALSO | ||
81 | .Xr opentracker 1 | ||
82 | |||
83 | .Sh AUTHOR | ||
84 | .An Dirk Engling | ||
85 | .Aq Mt erdgeist@erdgeist.org | ||
86 | |||