summaryrefslogtreecommitdiff
path: root/man4/opentracker.conf.4
diff options
context:
space:
mode:
authorDirk Engling <erdgeist@erdgeist.org>2024-04-18 17:52:18 +0200
committerDirk Engling <erdgeist@erdgeist.org>2024-04-18 17:52:18 +0200
commit398c5fe1b60f95bd9bcc9eff6dee363a734a804f (patch)
tree909647728232ee6b138cd1362d6a1a0baa46ab1e /man4/opentracker.conf.4
parentb01f1a0723c3c3a9e33a1b97bf9b3c4db5db7880 (diff)
Add man page for the config file
Diffstat (limited to 'man4/opentracker.conf.4')
-rw-r--r--man4/opentracker.conf.485
1 files changed, 85 insertions, 0 deletions
diff --git a/man4/opentracker.conf.4 b/man4/opentracker.conf.4
new file mode 100644
index 0000000..986941f
--- /dev/null
+++ b/man4/opentracker.conf.4
@@ -0,0 +1,85 @@
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
10The
11.Nm
12configuration file specifies various options for configuring the behavior of the
13.Nm
14program.
15.Pp
16Lines starting with '#' are comments and are ignored. Options are specified as 'keyword value' pairs.
17.Pp
18The following options are available:
19
20.Bl -tag -width ".It access.proxy" -compact
21.It listen.tcp_udp Ar address
22Specifies the address opentracker will listen on for both TCP and UDP connections. If not specified, opentracker listens on 0.0.0.0:6969 by default.
23
24.It listen.tcp Ar address
25Specifies the address opentracker will listen on for TCP connections.
26
27.It listen.udp Ar address
28Specifies the address opentracker will listen on for UDP connections.
29
30.It access.whitelist Ar path/to/whitelist
31Specifies 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.
32
33.It access.blacklist Ar path/to/blacklist
34Specifies 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.
35
36.It access.fifo_add Ar path/to/adder.fifo
37Specifies 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.
38
39.It access.fifo_delete Ar path/to/deleter.fifo
40Specifies 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.
41
42.It access.stats Ar ip_address
43Specifies the IP address allowed to fetch stats from opentracker.
44
45.It access.stats_path Ar path
46Specifies the path to the stats location. You can configure opentracker to appear anywhere on your tracker.
47
48.It access.proxy Ar ip_address_or_network
49Specifies the IP address or network of the reverse proxies. Opentracker will take the X-Forwarded-For address instead of the source IP address.
50
51.It livesync.cluster.listen Ar ip_address:port
52Specifies the IP address and port opentracker will listen on for incoming live sync packets to keep a cluster of opentrackers synchronized.
53
54.It livesync.cluster.node_ip Ar ip_address
55Specifies the trusted IP address for sync between trackers running in a cluster.
56
57.It batchsync.cluster.admin_ip Ar ip_address
58Specifies the admin IP address for old-style (HTTP-based) asynchronous tracker syncing.
59
60.It tracker.rootdir Ar path
61Specifies the directory opentracker will chroot/chdir to. All black/white list files must be located in this directory.
62
63.It tracker.user Ar username
64Specifies the user opentracker will setuid to.
65
66.It tracker.redirect_url Ar URL
67Specifies the URL opentracker will redirect to in response to a "GET / HTTP" request.
68
69.Sh EXAMPLES
70To specify the address opentracker will listen on for both TCP and UDP connections:
71.Dl listen.tcp_udp 0.0.0.0:6969
72.Pp
73To specify the address opentracker will listen on for TCP connections:
74.Dl listen.tcp 0.0.0.0
75.Pp
76To specify the address opentracker will listen on for UDP connections:
77.Dl listen.udp 0.0.0.0:6969
78
79.Sh SEE ALSO
80.Xr opentracker 1
81
82.Sh AUTHOR
83.An Dirk Engling
84.Aq erdgeist@erdgeist.org
85