Dolda2000 GitWeb / ashd.git / blame
| Commit | Line | Data |
|---|---|---|
| 065b84ef FT |
1 | Ashd -- Installation |
| 2 | ||
| 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 | |
| 6 | workings. | |
| 7 | ||
| 8 | Compiling and Installing | |
| 9 | ||
| 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. | |
| 16 | ||
| 0f287027 | 17 | Ashd has few dependencies. Apart from a functional C compiler and |
| 065b84ef FT |
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 | |
| e3a69eab | 21 | system, those dependencies correspond, in order, to the packages |
| 065b84ef FT |
22 | build-essential, libmagic-dev, libgnutls-dev, libattr1-dev, autoconf, |
| 23 | automake and asciidoc. | |
| 24 | ||
| 25 | Configuration | |
| 26 | ||
| 27 | When Ashd is compiled and installed, you will most likely want to | |
| 28 | install its default configuration. To do so, simply copy the | |
| fda48525 FT |
29 | `etc/ashd' directory into either `/etc' or `/usr/local/etc'. As long |
| 30 | as your system is fairly normal, it should not matter which you | |
| 31 | choose. | |
| 065b84ef FT |
32 | |
| 33 | Testing | |
| 34 | ||
| 35 | Once Ashd itself and the default configuration files have been | |
| 36 | installed, you can easily test the installation by running the | |
| 37 | `examples/static-files/run` script and pointing your web browser at | |
| 38 | <http://localhost:8080/>. It and the other examples generally provide | |
| 39 | a good starting point and some tips for the various configurations in | |
| 40 | which Ashd might run. Do check them out, and read `examples/README'. | |
| 41 | ||
| 42 | Further Reading | |
| 43 | ||
| 44 | For documentation on how the examples work, the manpages htparser(1), | |
| 45 | dirplex(1) and patplex(1) are particularly useful to read. The | |
| 46 | ashd(7) manpage provides a description on how Ashd works on a higher | |
| 47 | level, and is useful for a more thorough understanding. |