3 This file describes the most direct way to set up Ashd so that it is
4 usable. Since Ashd is quite modular, it is not the only way, but it is
5 probably the most useful before one gets a more complete grasp of its
8 Compiling and Installing
10 Ashd itself uses the ordinary GNU autotools compilation and
11 installation procedure. In order to get it compiled and installed,
12 simply run `./configure', `make' and `make install' (where you will
13 probably want to run `make install' as root). If you are compiling
14 from the Git repository, you will need to run `./bootstrap' first, in
15 order to create the `configure' script.
17 Ashd has few dependencies. Apart from a function C compiler and
18 standard system headers, it needs libmagic. GnuTLS and libattr may be
19 used optionally. If compiling from the Git repository, the GNU
20 autotools and Asciidoc need also be installed. On a Debian-based
21 system, those dependencies correspond, in order, the the packages
22 build-essential, libmagic-dev, libgnutls-dev, libattr1-dev, autoconf,
23 automake and asciidoc.
27 When Ashd is compiled and installed, you will most likely want to
28 install its default configuration. To do so, simply copy the
29 `etc/ashd' directory into either `/etc' or `/usr/local/etc'. It does
30 not matter which you choose.
34 Once Ashd itself and the default configuration files have been
35 installed, you can easily test the installation by running the
36 `examples/static-files/run` script and pointing your web browser at
37 <http://localhost:8080/>. It and the other examples generally provide
38 a good starting point and some tips for the various configurations in
39 which Ashd might run. Do check them out, and read `examples/README'.
43 For documentation on how the examples work, the manpages htparser(1),
44 dirplex(1) and patplex(1) are particularly useful to read. The
45 ashd(7) manpage provides a description on how Ashd works on a higher
46 level, and is useful for a more thorough understanding.