Getting Started

Building
Server Configuration

This section of the documentation is probably best read before the tutorial. In a nutshell, this is a quick and dirty run-through of how to get and install the library and configure your server.

Building

“FSCGI"” is a header-only library, but it relies on Boost.System, which for now should be built.

Boost-related elements can be downloaded from the Boost download site at sourceforge, located here.

	Note
	"invoking `bjam`" implies calling "`bjam --toolset=<your_toolset>`", where "`<your_toolset>`" is one of these. More information can be found here (these are general instructions for building Boost and configuring `bjam`. Following these instructions will also 'tick' the first two requirements below.

Table 1.2. What you need

Element	Optional?	Instructions
Boost.Jam - `bjam`	No	Download 'Boost.Jam' (precompiled versions are highly recommended) and make it accessible to your system's PATH.
Boost.System	No	1. Download the latest Boost distro, 'boost'. 2. Set the environment variable BOOST_ROOT on your system to the download location. 3. Go to the directory BOOST_ROOT and invoke `bjam` (see above), passing it `--with-system --layout=system install` on the command line. This should finish without any failures.
Documentation	Yes	These are built by going to the libs/cgi/doc directory and invoking `bjam` (see above). You can then read the docs by directing your browser to libs/cgi/index.html
Unit tests	Yes	Tests can be run by going to the libs/cgi/test directory and invoking `bjam` (see above). Boost.CGI aims to be cross-platform, but not all platforms are available for testing. If any tests fail, problems can be reported to here.
Examples	Yes	There are some examples provided with the library in the `libs/cgi/example` directory. They are useful for learning the library or testing your server configuration, something that can be tricky. They can all be found in the lib/cgi/example directory. Invoking `bjam` in the example directory should build all examples whereas invoking `bjam` in each sub-directory will build only the example contained therein.

Server Configuration

	Note
	Setting up server's for use with the library can be tricky, especially when using FastCGI. Concise links to guides on other sites is probably the way this section will go, perhaps with some basic outlines of ways to test it.

Under construction