summaryrefslogtreecommitdiff
path: root/opentracker.conf.sample
diff options
context:
space:
mode:
Diffstat (limited to 'opentracker.conf.sample')
-rw-r--r--opentracker.conf.sample50
1 files changed, 26 insertions, 24 deletions
diff --git a/opentracker.conf.sample b/opentracker.conf.sample
index 7ce7256..b20563c 100644
--- a/opentracker.conf.sample
+++ b/opentracker.conf.sample
@@ -1,29 +1,28 @@
1# opentracker config file 1# opentracker config file
2# 2#
3 3
4# I) ip addresses for tcp connections, either bind to INADDR_ANY port 6969 4# I) Address opentracker will listen on, using both, tcp AND udp family
5# (when no shell option is present) 5# (note, that port 6969 is implicite if ommitted).
6# 6#
7# listen.tcp 0.0.0.0 7# If no listen option is given (here or on the command line), opentracker
8# listens on 0.0.0.0:6969 tcp and udp.
8# 9#
9# or specify them one by one (shell option -i 192.168.0.1 -p 6969) 10# listen.tcp_udp 0.0.0.0
10# (note, that :6969 is implicite) 11# listen.tcp_udp 192.168.0.1:80
12# listen.tcp_udp 10.0.0.5:6969
11# 13#
12# listen.tcp 192.168.0.1 14# To only listen on tcp or udp family ports, list them this way:
13# listen.tcp 192.168.0.2:6969
14# listen.tcp 192.168.0.3:6969
15
16# II) the same goes for udp connections (shell option -i 192.168.0.1 -P 6969)
17# 15#
16# listen.tcp 0.0.0.0
18# listen.udp 192.168.0.1:6969 17# listen.udp 192.168.0.1:6969
19# 18#
20# Note, that using 0.0.0.0 for udp sockets may yield surprising results. 19# Note, that using 0.0.0.0 for udp sockets may yield surprising results.
21# An answer packet sent on that socket will not necessarily have the 20# An answer packet sent on that socket will not necessarily have the
22# source address that the requesting client may expect, but any address 21# source address that the requesting client may expect, but any address
23# on that interface 22# on that interface.
24# 23#
25 24
26# III) If opentracker runs in a non-open mode, point it to files containing 25# II) If opentracker runs in a non-open mode, point it to files containing
27# all torrent hashes that it will serve (shell option -w) 26# all torrent hashes that it will serve (shell option -w)
28# 27#
29# access.whitelist /path/to/whitelist 28# access.whitelist /path/to/whitelist
@@ -33,28 +32,31 @@
33# access.blacklist ./blacklist 32# access.blacklist ./blacklist
34# 33#
35# It is pointless and hence not possible to compile black AND white 34# It is pointless and hence not possible to compile black AND white
36# listing, so choose one of those options. File format is straight 35# listing, so choose one of those options at compile time. File format
37# forward: "<hex info hash>\n<hex info hash>\n..." 36# is straight forward: "<hex info hash>\n<hex info hash>\n..."
38# 37#
39 38
40# IV) ip address to listen for incoming and sending out outgoing live sync 39# III) Live sync uses udp multicast packets to keep a cluster of opentrackers
41# packets (shell option -i 192.168.0.1 -s 9696), port 9696 is default. 40# synchronized. This option tells opentracker which port to listen for
41# incoming live sync packets. The ip address tells opentracker, on which
42# interface to join the multicast group, those packets will arrive.
43# (shell option -i 192.168.0.1 -s 9696), port 9696 is default.
42# 44#
43# livesync.cluster.listen 192.168.0.1:9696 45# livesync.cluster.listen 192.168.0.1:9696
44# 46#
45# Note that two udp sockets will be opened. One on ip address 0.0.0.0 47# Note that two udp sockets will be opened. One on ip address 0.0.0.0
46# port 9696, that will join the multicast group 224.23.42.1 for incoming 48# port 9696, that will join the multicast group 224.0.42.23 for incoming
47# udp packets and one on ip address 192.168.0.1 port 9696 for outgoing 49# udp packets and one on ip address 192.168.0.1 port 9696 for outgoing
48# udp packets. 50# udp packets.
49# 51#
50# As of now one and only one ip address must be given, if opentracker 52# As of now one and only one ip address must be given, if opentracker
51# was built with the WANT_SYNC_LIVE feature 53# was built with the WANT_SYNC_LIVE feature.
52# 54#
53 55
54# V) Sync between trackers running in a cluster is restricted to packets 56# IV) Sync between trackers running in a cluster is restricted to packets
55# coming from trusted ip addresses. While source ip verification is far 57# coming from trusted ip addresses. While source ip verification is far
56# from perfect, the authors of opentracker trust in the correct 58# from perfect, the authors of opentracker trust in the correct
57# application of tunnels, filters and LAN setups (shell option -A) 59# application of tunnels, filters and LAN setups (shell option -A).
58# 60#
59# livesync.cluster.node_ip 192.168.0.4 61# livesync.cluster.node_ip 192.168.0.4
60# livesync.cluster.node_ip 192.168.0.5 62# livesync.cluster.node_ip 192.168.0.5
@@ -66,13 +68,13 @@
66# batchsync.cluster.admin_ip 10.1.1.1 68# batchsync.cluster.admin_ip 10.1.1.1
67# 69#
68 70
69# VI) Control directory where opentracker will chdir to. So all black/white 71# V) Control directory where opentracker will chdir to. So all black/white
70# list files may be put in that directory. (shell option -d) 72# list files may be put in that directory (shell option -d).
71# 73#
72# tracker.rootdir /usr/local/etc/opentracker 74# tracker.rootdir /usr/local/etc/opentracker
73# 75#
74 76
75# VII) opentracker can be told to answer to a "GET / HTTP"-request with a 77# VI) opentracker can be told to answer to a "GET / HTTP"-request with a
76# redirect to another location (shell option -r) 78# redirect to another location (shell option -r).
77# 79#
78# tracker.redirect_url https://your.tracker.local/ 80# tracker.redirect_url https://your.tracker.local/