CouchProjects/ReadMe.txt

   1 This is a readme for building the CouchDb Project.\r
   2 \r
   3 ******* Linux Build Setup *******\r
   4 \r
   5 Your machine will need installed (examples are for debian etch):\r
   6 \r
   7 ICU (http://icu.sourceforge.net/)\r
   8  apt-get install libicu34\r
   9  apt-get install libicu34-dev\r
  10 \r
  11 Erlang OTP (http://erlang.org/)\r
  12  apt-get install erlang\r
  13 \r
  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)\r
  15 \r
  16 A recent JDK\r
  17  apt-get install free-java-sdk\r
  18 \r
  19 Then execute build.sh.\r
  20 \r
  21 It should end with the message:\r
  22  CouchDb as been built successfully!\r
  23 \r
  24 Then become root or use sudo to install CouchDb\r
  25  ./build.sh --install=/usr/local --with-erlang=/usr/lib/erlang/lib\r
  26 \r
  27  The path after --install= can be anywhere you want. The installer automatically adds a couchdb directory to the path. With\r
  28  /usr/local CouchDb will installed into /usr/local/couchdb. \r
  29  \r
  30  The path after --with-erlang= needs to poing to the\r
  31  directory where your erlang installation put all other erlang libraries. If you are not sure how to\r
  32  find it, look for a directory that contains directories that are named like package-x.y.z (stdlib-1.14.1).\r
  33 \r
  34 * Patch the built-in INETS HTTP server. Instructions at "How to Patch the Erlang Inets facility code" below.\r
  35 \r
  36 To run CouchDb\r
  37  go to your installation directory (/usr/local/couchdb) and run ./bin/startCouchDb.sh\r
  38  if you don't want to run CouchDb as root, make sure to chown the installation directory to the user that\r
  39  executes ./bin/startCouchDb.sh.\r
  40 \r
  41  If an interactive Erlang shell shows up on the console and displays "CouchDb has started. Time to Relax.", relax.\r
  42  Then point your web browser to http://localhost:8888/$utils/index.html to create and administer the databases in CouchDb.\r
  43 \r
  44 \r
  45 ******* Windows Build Setup ********\r
  46 \r
  47 To Build Couch, you will need:\r
  48 \r
  49 * Microsoft Visual Studio .NET 2003\r
  50 \r
  51 * Java JRE installed and a java executable on the path (you probably already have this).\r
  52 \r
  53 * Install and build IBM's ICU (http://icu.sourceforge.net/).\r
  54   Set the environment variable ICU_ROOT to point the root of the ICU install, just below the "lib" and "include" directories:\r
  55         ICU_ROOT=C:\icu\r
  56 \r
  57 * Erlang Runtime (http://erlang.org/download.html)\r
  58 \r
  59 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)\r
  60 \r
  61 * set the ERLANG_ROOT environment variable to point the erlang root dir:\r
  62         ERLANG_ROOT=:\Program Files\erl5.5.1\\r
  63 \r
  64 * set the ERTS_ROOT environment variable to point the ERTS directory:\r
  65         ERTS_ROOT=C:\Program Files\erl5.5.1\erts-5.5.1\r
  66 \r
  67 * Patch the built-in INETS HTTP server. Instructions at "How to Patch the Erlang Inets facility code" below.\r
  68 \r
  69 Then execute build_win_kit.cmd to create a full couchdb install kit\r
  70 \r
  71 \r
  72 \r
  73 ******* How to Patch the Erlang Inets facility code ********\r
  74 \r
  75 \r
  76 Add these function heads at line 73 in \inets-X.X.X\src\httpd_request.erl:\r
  77 \r
  78 --begin--\r
  79 validate("PUT", Uri, "HTTP/1." ++ _N) ->\r
  80     validate_uri(Uri);\r
  81 validate("DELETE", Uri, "HTTP/1." ++ _N) ->\r
  82     validate_uri(Uri);\r
  83 --end--\r
  84  \r
  85 NOTE: there is also a http_request.erl file (no "d" in the name). Do not confuse this with httpd_request.erl\r
  86 \r
  87 Then compile the file from the Erlang shell.\r
  88 \r
  89 Windows Example:\r
  90 > c("C:\\Program Files\\erl5.5.1\\lib\\inets-4.7.5\\src\\httpd_request.erl",\r
  91 {outdir,"C:\\Program Files\\erl5.5.1\\lib\\inets-4.7.5\\ebin\\"}).\r
  92 \r
  93 Unix example:\r
  94 > c("/user/lib/erlang/erl5.5.1/lib/inets-4.7.5/src/httpd_request.erl",\r
  95 {outdir,"/user/lib/erlang/erl5.5.1/lib/inets-4.7.5/ebin/"}).\r
  96 \r
  97 If that completes successfully you have a patched system!\r
  98 \r
  99 \r
 100 \r
 101 ******* New Version Checklist *******\r
 102 \r
 103 1. Update version info in files: version CouchDb/couch.rel CouchDb/couch.app\r
 104 2. Add important information to dist/common/readme.txt\r
 105 \r