Ceph is a distributed object, block, and file storage platform
Go to file
Abhishek Lekshmanan 2217f2bd0a doc: fix a typo in quickstart doc
* doc/start/documenting-ceph.rst: s/along side/alongside

Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
2014-07-09 11:18:49 +05:30
admin
ceph-object-corpus@bb3cee6b85
debian Merge branch 'next' 2014-06-27 12:55:44 -07:00
doc doc: fix a typo in quickstart doc 2014-07-09 11:18:49 +05:30
examples/librados
fusetrace
keys
m4
man Merge pull request #2074 from onlyjob/docs 2014-07-07 09:07:04 -07:00
qa Merge remote-tracking branch 'gh/next' 2014-07-04 21:18:55 -07:00
share
src Merge pull request #2037 from ceph/wip-async-log 2014-07-07 15:37:13 -07:00
udev
wireshark
.gitignore
.gitmodule_mirrors
.gitmodules
.mailmap mailmap: Dmitry Smirnov name normalization 2014-06-20 10:23:15 +02:00
.organizationmap mailmap: koleosfuscus affiliation 2014-06-20 10:23:15 +02:00
AUTHORS
autogen.sh Automagically setup submodules on first run. 2014-07-03 00:51:23 +02:00
ceph.spec.in ceph.spec.in: add bash completion file for radosgw-admin 2014-07-07 13:12:41 -07:00
ChangeLog
CodingStyle
configure.ac Revert "Give meaningful error when submodules are not checked out" 2014-06-25 13:19:03 -07:00
COPYING
COPYING-LGPL2.1
deps.deb.txt
deps.rpm.txt
do_autogen.sh do_autogen.sh: --disable-static 2014-06-25 10:27:07 -07:00
doc_deps.deb.txt
Doxyfile
INSTALL
Makefile.am
NEWS
PendingReleaseNotes doc/release-notes: v0.82 2014-06-27 13:25:41 -07:00
README Automagically setup submodules on first run. 2014-07-03 00:51:23 +02:00
SubmittingPatches

============================================
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 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
	./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 install dpkg-dev
	dpkg-checkbuilddeps        # make sure we have all dependencies
	dpkg-buildpackage

For RPM-based systems (Red Hat, SUSE, etc.),

	rpmbuild


Build Prerequisites
===================

debian-based
------------

The list of debian package dependencies can be found in deps.deb.txt:

	sudo apt-get install `cat deps.deb.txt`

Note: libsnappy-dev and libleveldb-dev are not available upstream for natty, oneiric, and squeeze.  Backports for Ceph can be found at ceph.com/debian-leveldb.

rpm-based
---------

The list of RPM package dependencies can be found in deps.rpm.txt:

	sudo yum install `cat deps.rpm.txt`


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

Prerequisites
-------------

The list of package dependencies for building the documentation can be found
in doc_deps.deb.txt:

	sudo apt-get install `cat doc_deps.deb.txt`

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