diff options
Diffstat (limited to 'man1/opentracker.1')
-rw-r--r-- | man1/opentracker.1 | 130 |
1 files changed, 130 insertions, 0 deletions
diff --git a/man1/opentracker.1 b/man1/opentracker.1 new file mode 100644 index 0000000..0103ebe --- /dev/null +++ b/man1/opentracker.1 | |||
@@ -0,0 +1,130 @@ | |||
1 | .Dd 15/4/2024 | ||
2 | .Dt opentracker 1 | ||
3 | .Os Unix | ||
4 | .Sh opentracker | ||
5 | .Nm opentracker | ||
6 | .Nd a free and open bittorrent tracker | ||
7 | .Sh SYNOPSIS | ||
8 | .Nm | ||
9 | .Op Fl f Ar config | ||
10 | .Op Fl i Ar ip-select | ||
11 | .Op Fl p Ar port-bind-tcp | ||
12 | .Op Fl P Ar port-bind-udp | ||
13 | .Op Fl A Ar blessed-ip | ||
14 | .Op Fl r Ar redirect-url | ||
15 | .Op Fl d Ar chdir | ||
16 | .Op Fl u Ar user | ||
17 | .Op Fl w| Fl b accesslist | ||
18 | .Sh DESCRIPTION | ||
19 | .Nm | ||
20 | is a bittorrent tracker that implements announce and scrape actions over the | ||
21 | UDP and the plain http protocol, aiming for minimal resource usage. | ||
22 | .Pp | ||
23 | When invoked with parameters, it binds to TCP and UDP port 6969 on all | ||
24 | interfaces. The recommended way to configure opentracker is by providing a | ||
25 | config file using the | ||
26 | .Op Fl f Ar config | ||
27 | option. See | ||
28 | .Xr opentracker.conf 4 | ||
29 | for details. | ||
30 | .Pp | ||
31 | .Sh OPTIONS | ||
32 | The following options are available: | ||
33 | .Bl -tag -width -indent=8 | ||
34 | .It Fl f Ar config | ||
35 | Parse a config file with a list of options. Consecutive command options | ||
36 | will override options from the config file. See | ||
37 | .Xr opentracker.conf 4 | ||
38 | for details. | ||
39 | .It Fl i Ar ip-select | ||
40 | Select an ip address that will be used with the next | ||
41 | .Op Fl p | ||
42 | or | ||
43 | .Op Fl P | ||
44 | command to actually bind to this address. Setting this option without any bind | ||
45 | options in the config file or | ||
46 | .Op Fl p | ||
47 | or | ||
48 | .Op Fl P | ||
49 | commands will limit opentracker to only bind to this address. | ||
50 | .It Fl p Ar port-bind-tcp | ||
51 | Bind to the TCP port on the last preceding ip address set with the | ||
52 | .Op Fl i ip-select | ||
53 | option or to all available addresses if none has been set. Can be given multiple | ||
54 | times. | ||
55 | .It Fl P Ar port-bind-udp | ||
56 | Bind to the UDP port on the last preceding ip address set with the | ||
57 | .Op Fl i ip-select | ||
58 | option or to all available addresses if none has been set. Can be given multiple | ||
59 | times. | ||
60 | .It Fl A Ar blessed-ip | ||
61 | Set an ip address in IPv4 or IPv6 or a net in CIDR notation to bless the network | ||
62 | for access to restricted resources. | ||
63 | .It Fl r Ar redirect-url | ||
64 | Set the URL that | ||
65 | .Nm | ||
66 | will redirect users to when the / address is requested via HTTP. | ||
67 | .It Fl d Ar chdir | ||
68 | Sets the directory | ||
69 | .Nm | ||
70 | will | ||
71 | .Xr chroot 2 | ||
72 | to if ran as root or | ||
73 | .Xr chdir 2 | ||
74 | to if ran as unprivileged user. Note that any accesslist files need to be | ||
75 | relative to and within that directory. | ||
76 | .It Fl u Ar user | ||
77 | User to run | ||
78 | .Nm | ||
79 | under after all operations that need privileges have finished. | ||
80 | .It Fl w Ar accesslist | Fl b Ar accesslist | ||
81 | If | ||
82 | .Nm | ||
83 | has been compiled with the | ||
84 | .B WANT_ACCESSLIST_BLACK | ||
85 | or | ||
86 | .Br WANT_ACCESSLIST_WHITE | ||
87 | options, this option sets the location of the accesslist. | ||
88 | .El | ||
89 | .Sh EXAMPLES | ||
90 | Start | ||
91 | .Nm | ||
92 | bound on UDP and TCP ports 6969 on IPv6 localhost. | ||
93 | .Dl # ./opentracker -i ::1 -p 6969 -P 6969 | ||
94 | .Pp | ||
95 | Start | ||
96 | .Nm | ||
97 | bound on UDP port 6868 and TCP port 6868 on IPv4 localhost and allow | ||
98 | privileged access from the network 192.168/16 while redirecting | ||
99 | HTTP clients accessing the root directory, which is not covered by the | ||
100 | bittorrent tracker protocol, to https://my-trackersite.com/. | ||
101 | .Dl # ./opentracker -i 192.168.0.4 -p 6868 -P 6969 -A 192.168/16 -r https://my-trackersite.com/ | ||
102 | The announce URLs are http://192.168.0.4:6868/announce and | ||
103 | udp://192.168.0.4:6868/announce respectively. | ||
104 | .Sh FILES | ||
105 | .Bl -tag -width indent | ||
106 | .It Pa opentracker.conf | ||
107 | The | ||
108 | .Nm | ||
109 | config file. | ||
110 | .El | ||
111 | .Sh SEE ALSO | ||
112 | .Xr opentracker.conf 4 | ||
113 | .Pp | ||
114 | opentracker documentation | ||
115 | .Lk https://erdgeist.org/arts/software/opentracker | ||
116 | .Pp | ||
117 | Bittorrent tracker protocol | ||
118 | .Lk http://www.bittorrent.org/beps/bep_0015.html | ||
119 | .Sh AUTHOR | ||
120 | .An Dirk Engling | ||
121 | .Aq Mt erdgeist@erdgeist.org . | ||
122 | .Sh LICENSE | ||
123 | This software is released under the Beerware License: | ||
124 | .Pp | ||
125 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software | ||
126 | and associated documentation files (the "Software"), to deal in the Software with the following | ||
127 | terms and conditions: | ||
128 | .Pp | ||
129 | If you meet the author(s) someday, and you think this software is worth it, you can buy them | ||
130 | a beer in return. | ||