Ceph is a distributed object, block, and file storage platform
Go to file
Sage Weil 74f7607afa doc: release-notes for v0.54
Signed-off-by: Sage Weil <sage@inktank.com>
2012-11-13 16:29:54 -08:00
admin doc: add JavaDoc to Sphinx 2012-10-26 10:28:50 -07:00
ceph-object-corpus@7f23ee1127 ceph-object-corpus: update with v0.52 objects 2012-09-20 16:49:57 -07:00
debian Merge branch 'wip-keystone' into wip-rgw-integration 2012-11-08 17:19:18 -08:00
doc doc: release-notes for v0.54 2012-11-13 16:29:54 -08: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 rbd: document defaults for rbd bench-write 2012-10-22 13:34:23 -07:00
qa mon: require pgnum in 'ceph osd pool create <poolname> <pgnum> [<pgp_num>]' command 2012-11-12 12:01:07 -08:00
src rgw: fix warning 2012-11-13 15:43:48 -08:00
udev Robustify ceph-rbdnamer and adapt udev rules 2012-07-16 17:34:22 -07:00
wireshark wireshark: update patch 2012-07-31 15:49:25 -07:00
.gitignore test/bench: add tp bench 2012-10-30 13:31:09 -07:00
.gitmodules ceph.newdream.net -> ceph.com 2012-06-16 14:50:29 -07:00
AUTHORS
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
ChangeLog
CodingStyle Clarify CodingStyle with respect to tab compression of space runs 2012-08-31 15:47:12 -07:00
Doxyfile
INSTALL
Makefile.am Makefile: Updates to eliminates warnings, add test for boost system lib. 2012-10-15 14:14:34 -07:00
NEWS
PendingReleaseNotes doc: release-notes for v0.54 2012-11-13 16:29:54 -08:00
README README: add libboost-program-options-dev 2012-10-31 11:36:06 -07:00
RELEASE_CHECKLIST
SubmittingPatches
autogen.sh autogen.sh: On some platforms, the m4 is created earlier. 2012-10-15 14:14:35 -07:00
ceph.spec.in ceph.spec.in: Build debuginfo subpackage. 2012-11-09 13:28:13 -08:00
configure.ac build: Add RPM release string generated from git describe. 2012-11-08 12:43:24 -08:00
do_autogen.sh do_autogen.sh: add -j flag to enable java stuff 2012-10-19 09:59:10 -07:00

README

============================================
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-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
- libaio-dev
- libgoogle-perftools-dev
- libkeyutils-dev
- uuid-dev
- libatomic-ops-dev
- libboost-program-options-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 libaio-dev libgoogle-perftools-dev libkeyutils-dev uuid-dev libatomic-ops-dev