Ceph is a distributed object, block, and file storage platform
Go to file
Greg Farnum dac9f22359 Merge branch 'wip-rbd-locking'
Conflicts:
	src/cls_rbd.cc

Reviewed-by: Sage Weil <sage@inktank.com>
Reviewed-by: Josh Durgin <josh.durgin@inktank.com>
2012-06-15 17:39:48 -07:00
admin build-doc: use alternate virtualenv dir, if specified 2012-03-12 16:46:31 -07:00
ceph-object-corpus@4d64c37511 ceph-object-corpus: add some old v2 monmaps 2012-05-21 14:20:38 -07:00
debian debian: install radosgw upstart configs, daemon dir 2012-06-13 09:22:19 -07:00
doc Merge remote-tracking branch 'gh/wip-osdcap' 2012-06-15 11:10:02 -07:00
fusetrace
keys keys: new release key 2012-05-20 15:33:48 -07:00
m4 Makefile: Add recent acx_pthread.m4 that has a fix for nostdlib issue. 2012-01-12 09:17:06 -08:00
man man: Remove leftover --bin from ceph-authtool(8). 2012-05-21 08:56:08 -07:00
qa qa: disable xfstest 68 for now 2012-06-14 09:07:26 -07:00
src Merge branch 'wip-rbd-locking' 2012-06-15 17:39:48 -07:00
udev udev: drop device number from name 2011-12-08 16:36:47 -08:00
wireshark
.gitignore crushtool: allow user to select output reporting in blocks 2012-06-06 11:07:00 -07:00
.gitmodules rest-bench: build conditionally 2012-05-04 15:55:25 -07:00
AUTHORS update authors 2010-07-02 10:14:41 -07:00
autogen.sh Added LevelDBStore 2012-03-01 10:11:42 -08:00
ceph.spec.in remove ceph-kdump-copy 2012-06-12 10:10:58 -07:00
ChangeLog
CodingStyle CodingStyle: whitespace 2011-07-14 10:50:08 -07:00
configure.ac CrushTester: allow build without boost stuff for chi^2 testing 2012-06-03 16:12:20 -07:00
COPYING COPYING: doc/ CC BY-SA 2012-04-11 12:35:12 -07:00
COPYING-LGPL2.1 COPYING: note licenses for all files, not just the default 2012-01-12 10:03:27 -08:00
do_autogen.sh remove gceph 2012-05-17 20:23:33 -07:00
Doxyfile doxygen: Use first sentence as brief description. 2012-01-09 19:03:56 -08:00
INSTALL
Makefile.am Makefile: link gtest statically 2012-06-13 11:05:53 -07:00
NEWS
README doc: Whitespace cleanup. 2012-05-03 10:15:21 -07:00
RELEASE_CHECKLIST v0.22 2010-10-15 15:34:44 -07:00
SubmittingPatches SubmittingPatches: initial version 2010-10-28 14:55:09 -07:00

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

Please see http://ceph.newdream.net/ 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-virualenv
- doxygen
- ditaa
- libxml2-dev
- libxslt-dev
- dot
- graphviz

For example:

	sudo apt-get install python-dev python-pip python-virualenv 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
- automake
- gcc
- g++
- libboost-dev
- libedit-dev
- libssl-dev
- libtool
- libfcgi
- libfcgi-dev
- libfuse-dev
- linux-kernel-headers
- libcrypto++-dev

For example:

	$ apt-get install automake autoconf automake gcc g++ libboost-dev libedit-dev libssl-dev libtool libfcgi libfcgi-dev libfuse-dev linux-kernel-headers libcrypto++-dev