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