============================================
Ceph - a scalable distributed storage system
============================================

Please see http://ceph.com/ for current info.

Contributing Code
=================

Most of Ceph is licensed under the LGPL version 2.1.  Some
miscellaneous code is under BSD-style license or is public domain.
The documentation is licensed under Creative Commons
Attribution-ShareAlike (CC BY-SA).  There are a handful of headers
included here that are licensed under the GPL.  Please see the file
COPYING for a full inventory of licenses by file.

Code contributions must include a valid "Signed-off-by" acknowledging
the license for the modified or contributed file.  Please see the file
SubmittingPatches for details on what that means and on how to
generate and submit patches.

We do not require assignment of copyright to contribute code; code is
contributed under the terms of the applicable license.


Building Ceph
=============

To prepare the source tree after it has been git cloned,

	$ git submodule update --init

To build the server daemons, and FUSE client, execute the following:

	$ ./autogen.sh
	$ ./configure
	$ make

(Note that the FUSE client will only be built if libfuse is present.)

Dependencies
------------

The configure script will complain about any missing dependencies as
it goes.  You can also refer to debian/control or ceph.spec.in for the
package build dependencies on those platforms.  In many cases,
dependencies can be avoided with --with-foo or --without-bar switches.
For example,

$ ./configure --with-nss         # use libnss instead of libcrypto++
$ ./configure --without-radosgw  # do not build radosgw and avoid libfcgi-dev
$ ./configure --without-tcmalloc # avoid google-perftools dependency


Building packages
-----------------

You can build packages for Debian or Debian-derived (e.g., Ubuntu)
systems with

$ sudo apt-get dpkg-dev
$ dpkg-checkbuilddeps        # make sure we have all dependencies
$ dpkg-buildpackage

For RPM-based systems (Redhat, Suse, etc.),

$ rpmbuild


Building the Documentation
==========================

Prerequisites
-------------
To build the documentation, you must install the following:

- python-dev
- python-pip
- python-virtualenv
- doxygen
- ditaa
- libxml2-dev
- libxslt-dev
- dot
- graphviz

For example:

	sudo apt-get install python-dev python-pip python-virtualenv doxygen ditaa libxml2-dev libxslt-dev dot graphviz

Building the Documentation
--------------------------

To build the documentation, ensure that you are in the top-level `/ceph directory, and execute the build script. For example:

	$ admin/build-doc


Build Prerequisites
-------------------
To build the source code, you must install the following:

- automake
- autoconf
- pkg-config
- gcc
- g++
- make
- libboost-dev
- libedit-dev
- libssl-dev
- libtool
- libfcgi
- libfcgi-dev
- libfuse-dev
- linux-kernel-headers
- libcrypto++-dev
- libaio-dev
- libgoogle-perftools-dev
- libkeyutils-dev
- uuid-dev
- libatomic-ops-dev
- libboost-program-options-dev
- libboost-thread-dev
- libexpat1-dev
- libleveldb-dev
- libsnappy-dev
- libcurl4-gnutls-dev

For example:

	$ apt-get install automake autoconf pkg-config gcc g++ make libboost-dev libedit-dev libssl-dev libtool libfcgi libfcgi-dev libfuse-dev linux-kernel-headers libcrypto++-dev libaio-dev libgoogle-perftools-dev libkeyutils-dev uuid-dev libatomic-ops-dev libboost-program-options-dev libboost-thread-dev libexpat1-dev libleveldb-dev libsnappy-dev libcurl4-gnutls-dev