Add script to run cppcheck.
[darkhttpd] / README
1 How to build darkhttpd
2 ----------------------
3
4 Simply run make:
5         $ make
6
7
8
9 How to run darkhttpd
10 --------------------
11
12 Serve /var/www/htdocs on the default port (80 if running as root, else 8080):
13         $ ./darkhttpd /var/www/htdocs
14
15 Serve ~/public_html on port 8081:
16         $ ./darkhttpd ~/public_html --port 8081
17
18 Only bind to one IP address (useful on multi-homed systems):
19         $ ./darkhttpd ~/public_html --addr 192.168.0.1
20
21 Serve at most 4 simultaneous connections:
22         $ ./darkhttpd ~/public_html --maxconn 4
23
24 Log accesses to a file:
25         $ ./darkhttpd ~/public_html --log access.log
26
27 Chroot for extra security (you need root privs for chroot):
28         $ ./darkhttpd /var/www/htdocs --chroot
29
30 Use default.htm instead of index.html:
31         $ ./darkhttpd /var/www/htdocs --index default.htm
32
33 Add mimetypes - in this case, serve .dat files as text/plain:
34         $ cat extramime
35         text/plain      dat
36         $ ./darkhttpd /var/www/htdocs --mimetypes extramime
37
38 Drop privileges:
39         $ ./darkhttpd /var/www/htdocs --uid www --gid www
40
41 Use acceptfilter (FreeBSD only):
42         $ kldload accf_http
43         $ ./darkhttpd /var/www/htdocs --accf
44
45 Run in the background and create a pidfile:
46         $ ./darkhttpd /var/www/htdocs --pidfile /var/run/httpd.pid --daemon
47
48 Web forward (301) requests for some hosts:
49         $ ./darkhttpd /var/www/htdocs --forward example.com http://www.example.com \
50                 --forward secure.example.com https://www.example.com/secure
51
52 Commandline options can be combined:
53         $ ./darkhttpd ~/public_html --port 8080 --addr 127.0.0.1
54
55 To see a full list of commandline options,
56 run darkhttpd without any arguments:
57         $ ./darkhttpd