diff options
| author | John Wilkins <john.wilkins@dreamhost.com> | 2012-03-14 11:58:27 -0700 |
|---|---|---|
| committer | Tommi Virtanen <tommi.virtanen@dreamhost.com> | 2012-05-02 12:09:54 -0700 |
| commit | a1b31ddfda6ada09d6aa17d1b92a7cce25c87f74 (patch) | |
| tree | fd19d01c4a113c93638f70affe781d020208400f /README | |
| parent | d3a2c565661790787ec2b6372b7868f399396504 (diff) | |
| download | ceph-a1b31ddfda6ada09d6aa17d1b92a7cce25c87f74.tar.gz | |
Initial cut of introduction, getting started, and installing. More to do on installation. RADOS gateway to follow.
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
Diffstat (limited to 'README')
| -rw-r--r-- | README | 76 |
1 files changed, 65 insertions, 11 deletions
@@ -1,11 +1,11 @@ +============================================ 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. @@ -24,21 +24,20 @@ contributed under the terms of the applicable license. Building Ceph -------------- - -To prepare the source tree for the first time in case it has been git cloned, +============= -$ git submodule update --init +To prepare the source tree after it has been git cloned, + + $ git submodule update --init -To build the server daemons, and FUSE client, +To build the server daemons, and FUSE client, execute the following: -$ ./autogen.sh -$ ./configure -$ make + $ ./autogen.sh + $ ./configure + $ make (Note that the FUSE client will only be built if libfuse is present.) - Dependencies ------------ @@ -66,3 +65,58 @@ $ 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 + + |