README.txt

   1 This is a readme for building the CouchDb Project.
   2
   3 ******* Linux Build Setup *******
   4
   5 Your machine will need installed (examples are for debian etch):
   6
   7 ICU (http://icu.sourceforge.net/)
   8  apt-get install libicu34
   9  apt-get install libicu34-dev
  10
  11 Erlang OTP (http://erlang.org/)
  12  apt-get install erlang
  13
  14 Note: This project will build without modification with Erlang OTP R11B-1. If you do not have that version, you will get build errors and you will need to edit the package version numbers in CouchDb/couch.rel to match the ones in your Erlang install. (a future version of the build will allow any recent version of Erlang without edits)
  15
  16 Then execute build.sh.
  17
  18 It should end with the message:
  19  CouchDb as been built successfully!
  20
  21 Then become root or use sudo to install CouchDb
  22  ./build.sh --install=/usr/local
  23
  24  The path after --install= can be anywhere you want. The installer automatically adds a couchdb directory to the path. With
  25  /usr/local CouchDb will installed into /usr/local/couchdb.
  26
  27
  28 To run CouchDb
  29  go to your installation directory (/usr/local/couchdb) and run ./bin/startCouchDb.sh
  30  if you don't want to run CouchDb as root, make sure to chown the installation directory to the user that
  31  executes ./bin/startCouchDb.sh.
  32
  33  If an interactive Erlang shell shows up on the console and displays "CouchDb has started. Time to Relax.", relax.
  34  Then point your web browser to http://localhost:8888/ and look for a success message.
  35  Then go to the wiki (http://couchdbwiki.com/) to learn how to proceed now.
  36
  37
  38 ******* Windows Build Setup ********
  39
  40 To Build Couch, you will need:
  41
  42 * Microsoft Visual Studio .NET 2003
  43
  44 * Java JRE installed and a java executable on the path (you probably already have this).
  45
  46 * Install and build IBM's ICU (http://icu.sourceforge.net/).
  47   Set the environment variable ICU_ROOT to point the root of the ICU install, just below the "lib" and "include" directories:
  48         ICU_ROOT=C:\icu
  49
  50 * Erlang Runtime (http://erlang.org/download.html)
  51
  52 Note: This project will build without modification with Erlang OTP R11B-1. If you do not have that version, you will get build errors and you will need to edit the package version numbers in CouchDb/couch.rel to match the ones in your Erlang install. (a future version of the build will allow any recent version of Erlang without edits)
  53
  54 * set the ERLANG_ROOT environment variable to point the erlang root dir:
  55         ERLANG_ROOT=:\Program Files\erl5.5.1\
  56
  57 * set the ERTS_ROOT environment variable to point the ERTS directory:
  58         ERTS_ROOT=C:\Program Files\erl5.5.1\erts-5.5.1
  59
  60 Then execute build_win_kit.cmd to create a full couchdb install kit
  61
  62
  63 ******* New Version Checklist *******
  64
  65 1. Update version info in files: version
  66 2. Add important information to dist/common/readme.txt
  67