Disable forced gzip by default
[opentracker.git] / opentracker.conf.sample
blob054e405d4f52116aebc3df46fe5152251f5c3dde
1 # opentracker config file
4 # I)   Address opentracker will listen on, using both, tcp AND udp family
5 #      (note, that port 6969 is implicit if omitted).
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.
10 #      The next variable determines if udp sockets are handled in the event
11 #      loop (set it to 0, the default) or are handled in blocking reads in
12 #      dedicated worker threads. You have to set this value before the
13 #      listen.tcp_udp or listen.udp statements before it takes effect, but you
14 #      can re-set it for each listen statement. Normally you should keep it at
15 #      the top of the config file.
17 # listen.udp.workers 4
19 # listen.tcp_udp 0.0.0.0
20 # listen.tcp_udp 192.168.0.1:80
21 # listen.tcp_udp 10.0.0.5:6969
23 #      To only listen on tcp or udp family ports, list them this way:
25 # listen.tcp 0.0.0.0
26 # listen.udp 192.168.0.1:6969
28 #      Note, that using 0.0.0.0 for udp sockets may yield surprising results.
29 #      An answer packet sent on that socket will not necessarily have the
30 #      source address that the requesting client may expect, but any address
31 #      on that interface.
34 # II)  If opentracker runs in a non-open mode, point it to files containing
35 #      all torrent hashes that it will serve (shell option -w)
37 # access.whitelist /path/to/whitelist
39 #      or, if opentracker was compiled to allow blacklisting (shell option -b)
41 # access.blacklist ./blacklist
43 #      It is pointless and hence not possible to compile black AND white
44 #      listing, so choose one of those options at compile time. File format
45 #      is straight forward: "<hex info hash>\n<hex info hash>\n..."
47 # IIa) You can enable dynamic changesets to accesslists by enabling
48 #      WANT_DYNAMIC_ACCESSLIST.
50 #      The suggested way to work with dynamic changeset lists is to keep a
51 #      main accesslist file that is loaded when opentracker (re)starts and
52 #      reloaded infrequently (hourly or daily).
54 #      All changes to the accesslist (e.g. from a web frontend) should be
55 #      both appended to or removed from that file and sent to opentracker. By
56 #      keeping dynamic changeset lists, you can avoid reloading huge
57 #      accesslists whenever just a single entry is added or removed.
59 #      Any info_hash (format see above) written to the fifo_add file will be
60 #      kept on a dynamic add-changeset, removed from the dynamic
61 #      delete-changeset and treated as if it was in the main accesslist file.
62 #      The semantic of the respective dynamic changeset depends on whether
63 #      WANT_ACCESSLIST_WHITE or WANT_ACCESSLIST_BLACK is enabled.
65 # access.fifo_add /var/run/opentracker/adder.fifo
67 #      Any info_hash (format see above) written to the fifo_delete file will
68 #      be kept on a dynamic delete-changeset, removed from the dynamic
69 #      add-changeset and treated as if it was not in the main accesslist
70 #      file.
72 # access.fifo_delete /var/run/opentracker/deleter.fifo
74 #      If you reload the accesslist by sending SIGHUP to the tracker process,
75 #      the dynamic lists are flushed, as opentracker assumes thoses lists are
76 #      merged into the main accesslist.
78 #      NOTE: While you can have multiple writers sending lines to the fifos,
79 #      any writes larger than PIPE_BUF (see your limits.h, minimally 512
80 #      bytes but usually 4096) may be interleaved with data sent by other
81 #      writers. This can lead to unparsable lines of info_hashes.
83 # IIb)
84 #      If you do not want to grant anyone access to your stats, enable the
85 #      WANT_RESTRICT_STATS option in Makefile and bless the ip addresses
86 #      or network allowed to fetch stats here.
88 # access.stats 192.168.0.23
89 # access.stats 10.1.1.23
91 #      There is another way of hiding your stats. You can obfuscate the path
92 #      to them. Normally it is located at /stats but you can configure it to
93 #      appear anywhere on your tracker.
95 # access.stats_path stats
97 # II
98 #      If opentracker lives behind one or multiple reverse proxies,
99 #      every http connection appears to come from these proxies. In order to
100 #      take the X-Forwarded-For address instead, compile opentracker with the
101 #      WANT_IP_FROM_PROXY option and set your proxy addresses or networkss here.
103 # access.proxy 10.0.1.23
104 # access.proxy 192.0.0.0/8
107 # III) Live sync uses udp multicast packets to keep a cluster of opentrackers
108 #      synchronized. This option tells opentracker which port to listen for
109 #      incoming live sync packets. The ip address tells opentracker, on which
110 #      interface to join the multicast group, those packets will arrive.
111 #      (shell option -i 192.168.0.1 -s 9696), port 9696 is default.
113 # livesync.cluster.listen 192.168.0.1:9696
115 #      Note that two udp sockets will be opened. One on ip address 0.0.0.0
116 #      port 9696, that will join the multicast group 224.0.42.23 for incoming
117 #      udp packets and one on ip address 192.168.0.1 port 9696 for outgoing
118 #      udp packets.
120 #      As of now one and only one ip address must be given, if opentracker
121 #      was built with the WANT_SYNC_LIVE feature.
124 # IV)  Sync between trackers running in a cluster is restricted to packets
125 #      coming from trusted ip addresses. While source ip verification is far
126 #      from perfect, the authors of opentracker trust in the correct
127 #      application of tunnels, filters and LAN setups (shell option -A).
129 # livesync.cluster.node_ip 192.168.0.4
130 # livesync.cluster.node_ip 192.168.0.5
131 # livesync.cluster.node_ip 192.168.0.6
133 #      This is the admin ip address for old style (HTTP based) asynchronus
134 #      tracker syncing.
136 # batchsync.cluster.admin_ip 10.1.1.1
139 # V)   Control privilege drop behaviour.
140 #      Put in the directory opentracker will chroot/chdir to. All black/white
141 #      list files must be put in that directory (shell option -d).
144 # tracker.rootdir /usr/local/etc/opentracker
146 #      Tell opentracker which user to setuid to.
148 # tracker.user    nobody
151 # VI)  opentracker can be told to answer to a "GET / HTTP"-request with a
152 #      redirect to another location (shell option -r).
154 # tracker.redirect_url https://your.tracker.local/