===========================
Sheepdog Installation Guide
===========================

Run-time dependencies
---------------------
* Three or more x86-64 machines.
* The corosync and corosync lib package.
* QEMU 0.13 or later

Compile-time dependencies
-------------------------
* GNU Autotools
* corosync devel package
* git (when compiling from source repo)
* svn (when compiling from source repo)
* nss devel packages (when compiling corosync from source)

Compiling and installing from source
------------------------------------
1. Compile or install the Corosync packages:

   Nearly every modern Linux distribution has x86_64 corosync binaries
   pre-built available via their repositories.  We recommend you use these
   packages if they are available on your distribution.

   For debian package based systems:
   $ sudo aptitude install corosync

   For RPM package based systems:
   $ sudo yum install corosynclib-devel

   If your distribution doesn't provide the corosync packages, or you prefer
   to compile from source:

   $ svn co http://svn.fedorahosted.org/svn/corosync/branches/flatiron
   $ cd flatiron
   $ ./autogen.sh
   $ ./configure
   $ sudo make install
   $ cd ..

2. Download, build and install QEMU with Sheepdog support:

   QEMU 0.13 provides built-in support for sheepdog devices.  Some distributions
   provide pre-built versions of this newer version of QEMU.  If your
   distribution has an older version of QEMU or you prefer to compile from
   source, retrieve the latest QEMU and compile:

   $ git clone git://git.sv.gnu.org/qemu.git
   $ cd qemu
   $ ./configure
   $ sudo make install
   $ cd ..

3. Download, build and install the Sheepdog server and command line tools:

   $ git clone git://sheepdog.git.sf.net/gitroot/sheepdog/sheepdog
   $ cd sheepdog
   $ ./autogen.sh
   $ ./configure
   $ sudo make install
   $ cd ..

   Please note, sheepdog supports a "make rpm" target which will generate
   an rpm package that can be installed on the local machine.  To use this
   installation method, use the following instructions:

   $ git clone git://sheepdog.git.sf.net/gitroot/sheepdog/sheepdog
   $ cd sheepdog
   $ ./autogen.sh
   $ ./configure
   $ make rpm
   $ sudo rpm -ivh x86_64/sheepdog-0.*
   $ cd ..

Please read the README file, the sheep(8) or collie(8) man page for further
usage instructions.

===============================================================================
Copyright (C) 2009-2011, Nippon Telegraph and Telephone Corporation.
