summaryrefslogtreecommitdiff
path: root/man1
diff options
context:
space:
mode:
authorDirk Engling <erdgeist@erdgeist.org>2024-04-18 16:40:29 +0200
committerDirk Engling <erdgeist@erdgeist.org>2024-04-18 16:40:29 +0200
commitdcc47f9612577ff4109f9448f08641eff5284baa (patch)
tree21d31a492603ef6bf85ab729712d980bd5d85cdd /man1
parent33bd2c9094e7f90a62cb59cdf5cf670ac58d5308 (diff)
Add first draft of a man page
Diffstat (limited to 'man1')
-rw-r--r--man1/opentracker.1125
1 files changed, 125 insertions, 0 deletions
diff --git a/man1/opentracker.1 b/man1/opentracker.1
new file mode 100644
index 0000000..45d71cb
--- /dev/null
+++ b/man1/opentracker.1
@@ -0,0 +1,125 @@
1.Dd 15/4/2024
2.Dt opentracker 1
3.Os posix
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
20is a bittorrent tracker that implements announce and scrape actions over the
21udp and the plain http protocol, aiming for minimal resource usage.
22.Pp
23
24When invoked with parameters, it binds to tcp and udp port 6969 on all
25interfaces. The recommended way to configure opentracker is by providing a
26config file using the
27.Op Fl f Ar config
28option. See
29.Xr opentracker.conf 4
30for details.
31.Pp
32
33.Sh OPTIONS
34The following options are available:
35
36.Bl -tag -width -indent=8
37.It Fl f Ar config
38Parse a config file with a list of options. Consecutive command options
39will override options from the config file. See
40.Xr opentracker.conf 4
41for details.
42
43.It Fl i Ar ip-select
44Select an ip address that will be used with the next
45.Op Fl p
46or
47.Op Fl P
48command to actually bind to this address. Setting this option without any bind
49options in the config file or
50.Op Fl p
51or
52.Op Fl P
53commands will limit opentracker to only bind to this address.
54.It Fl p Ar port-bind-tcp
55Bind to the tcp port on the last preceding ip address set with the
56.Op Fl i ip-select
57option or to all available addresses if none has been set. Can be given multiple
58times.
59.It Fl p Ar port-bind-udp
60Bind to the udp port on the last preceding ip address set with the
61.Op Fl i ip-select
62option or to all available addresses if none has been set. Can be given multiple
63times.
64.It Fl A Ar blessed-ip
65Set an ip address in IPv4 or IPv6 or a net in CIDR notation to bless the network
66for access to restricted resources.
67.It Fl r Ar redirect-url
68Set the URL that
69.Nm
70will redirect users to when the / address is requested via HTTP.
71.It Fl d Ar chdir
72Sets the directory
73.Nm
74will
75.Xr chroot 2
76to if ran as root or
77.Xr chdir 2
78to if ran as unprivileged user. Note that any accesslist files need to be
79relative to and within that directory.
80.It Fl u Ar user
81User to run
82.Nm
83under after all operations that need privileges have finished.
84.It Fl w Ar accesslist | Fl b Ar accesslist
85If
86.Nm
87has been compiled with the
88.B WANT_ACCESSLIST_BLACK
89or
90.Br WANT_ACCESSLIST_WHITE
91options, this option sets the location of the accesslist.
92.El
93
94.Sh EXAMPLES
95
96Start
97.Nm
98bound on udp and tcp ports 6969 on IPv6 localhost.
99
100.Dl # ./opentracker -i ::1 -p 6969 -P 6969
101
102.Pp
103Start
104.Nm
105bound on port udp and tcp port 6868 on IPv4 localhost and allow
106privileged access from the nnetwork 192.168/16 while redirecting
107HTTP clients accessing / to https://my-trackersite.com/.
108
109.Dl # ./opentracker -i 192.168.0.4 -p 6868 -P 6969 -A 192.168/16 -r https://my-trackersite.com/
110
111The announce URLs are http://192.168.0.4:6868/announce and
112udp://192.168.0.4:6868/announce respectively.
113
114.Sh FILES
115.Bl -tag -width -compact
116.It Pa opentracker.conf
117config file.
118.El
119.Sh SEE ALSO
120.Xr opentracker.conf 4
121.Sh
122.Sh AUTHOR
123.An Dirk Engling
124.Aq erdgeist@erdgeist.org .
125