Installing OpenFaucet

1. Download OpenFaucet

OpenFaucet can be downloaded either directly from the git source repository (recommended for developers of OpenFaucet), or from a pre-packaged release archive (recommended for end users).

1. Download the master branch from git

Clone the repository at URL git@github.com:rlenglet/openfaucet.git:

git clone git@github.com:rlenglet/openfaucet.git openfaucet
cd openfaucet

Install GNU Autoconf and GNU Automake, e.g. on Debian GNU/Linux:

aptitude install autoconf automake

Generate the configure script and Makefiles:

./bootstrap.sh

Or

2. Download a release archive

Download the archive of the current release at http://midokura.github.com/openfaucet/releases/openfaucet-1.1.tar.gz (or another release) and uncompress it:

gzip -d openfaucet-1.1.tar.gz
tar x -f openfaucet-1.1.tar
cd openfaucet-1.1/

2. Install dependencies

Install all dependencies:

• Python version 2.6 or later (untested with Python 3.x)
• Twisted core version 10.2 or later
• ZopeInterface version 3.5.3 or later
• unittest2 version 0.5.1 or later (optionally, to execute the unittests)
• Sphinx version 0.6.6 or later (optionally, to generate the documentation)

On Debian GNU/Linux, all those dependencies can be installed as packages:

aptitude install python python-twisted-core python-zope.interface \
    python-unittest2 python-sphinx

3. Build and install OpenFaucet

OpenFaucet can either be built and installed “by hand”, or built and installed as a Debian package.

1. Build by hand

Check dependencies and configure to install OpenFaucet into /usr/local/ (default):

./configure

See the output of ./configure --help for configuration options.

Build:

make all

Optionally, run unittests (requires unittest2 to be installed):

make check

Optionally, generate the HTML documentation (requires Sphinx):

make html

And

2. Install by hand

Install the openfaucet package:

make install

Optionally, install the HTML documentation:

make install-html

Or

3. Install using GNU Stow

To better manage the installation of OpenFaucet into /usr/local, install GNU Stow, e.g. on Debian GNU/Linux:

aptitude install stow

Install OpenFaucet into a subdirectory of /usr/local/stow/:

make all
make install prefix=/usr/local/stow/openfaucet-1.1

Optionally, install the HTML documentation:

make install-html prefix=/usr/local/stow/openfaucet-1.1

Install the openfaucet-1.1 package using stow:

stow -d /usr/local/stow openfaucet-1.1

To uninstall the openfaucet-1.1 package, pass the -D option to stow:

stow -D -d /usr/local/stow openfaucet-1.1

Or

4. Build and install as a Debian GNU/Linux package

Download the master branch from the git source repository, as described in Step 1.1 above, and install unittest2 and Sphinx.

Install Debian GNU/Linux’s package build tools:

aptitude install devscripts

Build the packages:

debuild

Install the built packages:

dpkg -i ../python-openfaucet_1.1_all.deb \
        ../python-openfaucet-doc_1.1_all.deb