couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nsla...@apache.org
Subject svn commit: r922548 - in /couchdb/trunk: BUILDING CHANGES INSTALL.Unix INSTALL.Windows Makefile.am NEWS README
Date Sat, 13 Mar 2010 12:58:58 GMT
Author: nslater
Date: Sat Mar 13 12:58:58 2010
New Revision: 922548

URL: http://svn.apache.org/viewvc?rev=922548&view=rev
Log:
initial round of documentation changes

Added:
    couchdb/trunk/BUILDING
    couchdb/trunk/INSTALL.Unix
    couchdb/trunk/INSTALL.Windows
Modified:
    couchdb/trunk/CHANGES
    couchdb/trunk/Makefile.am
    couchdb/trunk/NEWS
    couchdb/trunk/README

Added: couchdb/trunk/BUILDING
URL: http://svn.apache.org/viewvc/couchdb/trunk/BUILDING?rev=922548&view=auto
==============================================================================
--- couchdb/trunk/BUILDING (added)
+++ couchdb/trunk/BUILDING Sat Mar 13 12:58:58 2010
@@ -0,0 +1,42 @@
+Building From Checkout
+======================
+
+You only need to follow these instructions if you are building from a direct
+repository checkout. If you are installing CouchDB from a tarball you can skip
+to the installation section in the `README` file.
+
+You will need the following installed:
+
+ * GNU Automake (>=1.6.3) (http://www.gnu.org/software/automake/)
+ * GNU Autoconf (>=2.59)  (http://www.gnu.org/software/autoconf/)
+ * GNU Libtool            (http://www.gnu.org/software/libtool/)
+ * GNU help2man           (http://www.gnu.org/software/help2man/)
+
+The `help2man` tool is optional, but will generate `man` pages for you.
+
+Debian-based (inc. Ubuntu) Systems
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can install the dependencies by running:
+
+    apt-get install automake autoconf libtool help2man
+
+Be sure to update the version numbers to match your system's available packages.
+
+Mac OS X
+~~~~~~~~
+
+You can install the dependencies by running:
+
+    port install automake autoconf libtool help2man
+
+You will need MacPorts installed to use the `port` command.
+
+Bootstrapping
+~~~~~~~~~~~~~
+
+Bootstrap the pristine source by running:
+
+    ./bootstrap
+
+You must repeat this step every time you update your checkout.

Modified: couchdb/trunk/CHANGES
URL: http://svn.apache.org/viewvc/couchdb/trunk/CHANGES?rev=922548&r1=922547&r2=922548&view=diff
==============================================================================
--- couchdb/trunk/CHANGES (original)
+++ couchdb/trunk/CHANGES Sat Mar 13 12:58:58 2010
@@ -6,7 +6,7 @@ Version 0.11.0
 
 This version has not been released yet.
 
-Security
+Security:
 
  * Added default cookie-authentication and users database.
  * Added Futon user interface for user signup and login.
@@ -15,22 +15,13 @@ Security
    functions.
  * Added proxy authentication handler
 
-HTTP Interface
+HTTP Interface:
 
  * Provide Content-MD5 header support for attachments.
  * Added URL Rewriter handler.
  * Added virtual host handling.
 
-Build and System Integration
-
- * Added support for building a Windows installer as part of 'make dist'.
- * Bug fix for building couch.app's module list.
- * ETap tests are now run during make distcheck. This included a number of
-   updates to the build system to properly support VPATH builds.
- * Gavin McDonald setup a build-bot instance. More info can be found at
-   http://ci.apache.org/buildbot.html
-
-View Server
+View Server:
 
  * Added optional 'raw' binary collation for faster view builds where Unicode
    collation is not important.
@@ -43,27 +34,27 @@ View Server
    support. The new HTTP interaction acts like a synchronous XHR. Example usage
    of the new system is in the JavaScript CLI test runner.
 
-Replication
+Replication:
 
  * Added option to implicitly create replication target databases.
  * Avoid leaking file descriptors on automatic replication restarts.
  * Added option to replicate a list of documents by id.
  * Allow continuous replication to be cancelled.
 
-Storage System
+Storage System:
 
  * Adds batching of multiple updating requests, to improve throughput with many
    writers. Removed the now redundant couch_batch_save module.
  * Adds configurable compression of attachments.
 
-Runtime Statistics
+Runtime Statistics:
 
  * Statistics are now calculated for a moving window instead of non-overlapping
-   timeframes. 
+   timeframes.
  * Fixed a problem with statistics timers and system sleep.
  * Moved statistic names to a term file in the priv directory.
 
-Futon
+Futon:
 
  * Added a button for view compaction.
  * JSON strings are now displayed as-is in the document view, without the escaping of
@@ -76,19 +67,28 @@ Futon
    inserts a tab character at the current caret position.
  * Fixed some font declarations.
 
+Build and System Integration:
+
+ * Added support for building a Windows installer as part of 'make dist'.
+ * Bug fix for building couch.app's module list.
+ * ETap tests are now run during make distcheck. This included a number of
+   updates to the build system to properly support VPATH builds.
+ * Gavin McDonald setup a build-bot instance. More info can be found at
+   http://ci.apache.org/buildbot.html
+
 Version 0.10.1
 --------------
 
-Replicator
+Replicator:
 
  * Stability enhancements regarding redirects, timeouts, OAuth.
 
-Query Server
+Query Server:
 
  * Avoid process leaks
  * Allow list and view to span languages
 
-Stats
+Stats:
 
  * Eliminate new process flood on system wake
 
@@ -99,31 +99,37 @@ Build and System Integration:
 Version 0.10.0
 --------------
 
-Storage Format
+Storage Format:
 
  * Add move headers with checksums to the end of database files for extra robust
    storage and faster storage.
 
-View Server
+View Server:
 
  * Added native Erlang views for high-performance applications.
 
+HTTP Interface:
+
+ * Added optional cookie-based authentication handler.
+ * Added optional two-legged OAuth authentication handler.
+
 Build and System Integration:
 
  * Changed `couchdb` script configuration options.
  * Added default.d and local.d configuration directories to load sequence.
 
-HTTP Interface:
-
- * Added optional cookie-based authentication handler.
- * Added optional two-legged OAuth authentication handler.
 
 Version 0.9.2
 -------------
 
+Replication:
+
+ * Fix replication with 0.10 servers initiated by an 0.9 server (COUCHDB-559).
+
+Build and System Integration:
+
  * Remove branch callbacks to allow building couchjs against newer versions of
    Spidermonkey.
- * Fix replication with 0.10 servers initiated by an 0.9 server (COUCHDB-559).
 
 Version 0.9.1
 -------------
@@ -151,7 +157,7 @@ External Handlers:
 
  * Fix POST requests.
 
-Futon Utility Client:
+Futon:
 
  * Redirect when loading a deleted view URI from the cookie.
 
@@ -296,7 +302,7 @@ Build and System Integration:
  * Updated `sudo` example in `README` to use the `-i` option, this fixes
    problems when invoking from a directory the `couchdb` user cannot access.
 
-Futon Utility Client:
+Futon:
 
  * The view selector dropdown should now work in Opera and Internet Explorer
    even when it includes optgroups for design documents. (COUCHDB-81)
@@ -374,7 +380,7 @@ Build and System Integration:
  * The `couchdb` and `couchjs` scripts have been improved for portability.
  * The build and system integration have been improved for portability.
 
-Futon Utility Client:
+Futon:
 
  * When adding a field to a document, Futon now just adds a field with an
    autogenerated name instead of prompting for the name with a dialog. The name

Added: couchdb/trunk/INSTALL.Unix
URL: http://svn.apache.org/viewvc/couchdb/trunk/INSTALL.Unix?rev=922548&view=auto
==============================================================================
--- couchdb/trunk/INSTALL.Unix (added)
+++ couchdb/trunk/INSTALL.Unix Sat Mar 13 12:58:58 2010
@@ -0,0 +1,201 @@
+Installing on Unix-like Systems
+===============================
+
+Dependencies
+------------
+
+You will need the following installed:
+
+ * Erlang OTP (>=R12B5)         (http://erlang.org/)
+ * ICU                          (http://icu.sourceforge.net/)
+ * OpenSSL                      (http://www.openssl.org/)
+ * Mozilla SpiderMonkey (>=1.7) (http://www.mozilla.org/js/spidermonkey/)
+ * libcurl                      (http://curl.haxx.se/libcurl/)
+ * GNU Make                     (http://www.gnu.org/software/make/)
+ * GNU Compiler Collection      (http://gcc.gnu.org/)
+
+It is recommended that you install Erlang OTP R12B-5 or above where possible.
+
+Debian-based (inc. Ubuntu) Systems
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can install the build tools by running:
+
+    sudo apt-get install build-essential
+
+You can install the other dependencies by running:
+
+    sudo apt-get install erlang libicu-dev libmozjs-dev libcurl4-openssl-dev
+
+Be sure to update the version numbers to match your system's available packages.
+
+Mac OS X
+~~~~~~~~
+
+You can install the build tools by running:
+
+    open /Applications/Installers/Xcode\ Tools/XcodeTools.mpkg
+
+You can install the other dependencies by running:
+
+    sudo port install icu erlang spidermonkey curl
+
+You will need MacPorts installed to use the `port` command.
+
+Installing
+----------
+
+Skip to the
+
+Once you have satisfied the dependencies you should run:
+
+    ./configure
+
+This script will configure CouchDB to be installed into `/usr/local` by default.
+
+If you wish to customise the installation, pass `--help` to this script.
+
+If everything was successful you should see the following message:
+
+    You have configured Apache CouchDB, time to relax.
+
+Relax.
+
+To install CouchDB you should run:
+
+    make && sudo make install
+
+You only need to use `sudo` if you're installing into a system directory.
+
+Try `gmake` if `make` is giving you any problems.
+
+If everything was successful you should see the following message:
+
+    You have installed Apache CouchDB, time to relax.
+
+Relax.
+
+Security Considerations
+-----------------------
+
+You should create a special `couchdb` user for CouchDB.
+
+On many Unix-like systems you can run:
+
+    adduser --system \
+            --home /usr/local/var/lib/couchdb \
+            --no-create-home \
+            --shell /bin/bash \
+            --group --gecos \
+            "CouchDB Administrator" couchdb
+
+On Mac OS X you can use the Workgroup Manager to create users:
+
+  http://www.apple.com/support/downloads/serveradmintools1047.html
+
+You must make sure that:
+
+    * The user has a working POSIX shell
+
+    * The user's home directory is `/usr/local/var/lib/couchdb`
+
+You can test this by:
+
+    * Trying to log in as the `couchdb` user
+
+    * Running `pwd` and checking the present working directory
+
+Change the ownership of the CouchDB directories by running:
+
+    chown -R couchdb:couchdb /usr/local/etc/couchdb
+    chown -R couchdb:couchdb /usr/local/var/lib/couchdb
+    chown -R couchdb:couchdb /usr/local/var/log/couchdb
+    chown -R couchdb:couchdb /usr/local/var/run/couchdb
+
+Change the permission of the CouchDB directories by running:
+
+    chmod 0770 /usr/local/etc/couchdb
+    chmod 0770 /usr/local/var/lib/couchdb
+    chmod 0770 /usr/local/var/log/couchdb
+    chmod 0770 /usr/local/var/run/couchdb
+
+Running as a Daemon
+-------------------
+
+SysV/BSD-style Systems
+~~~~~~~~~~~~~~~~~~~~~~
+
+You can use the `couchdb` init script to control the CouchDB daemon.
+
+On SysV-style systems, the init script will be installed into:
+
+    /usr/local/etc/init.d
+
+On BSD-style systems, the init script will be installed into:
+
+    /usr/local/etc/rc.d
+
+We use the `[init.d|rc.d]` notation to refer to both of these directories.
+
+You can control the CouchDB daemon by running:
+
+    /usr/local/etc/[init.d|rc.d]/couchdb [start|stop|restart|status]
+
+If you wish to configure how the init script works, you can edit:
+
+    /usr/local/etc/default/couchdb
+
+Comment out the `COUCHDB_USER` setting if you're running as a non-superuser.
+
+To start the daemon on boot, copy the init script to:
+
+    /etc/[init.d|rc.d]
+
+You should then configure your system to run the init script automatically.
+
+You may be able to run:
+
+    sudo update-rc.d couchdb defaults
+
+If this fails, consult your system documentation for more information.
+
+A `logrotate` configuration is installed into:
+
+    /usr/local/etc/logrotate.d/couchdb
+
+Consult your `logrotate` documentation for more information.
+
+It is critical that the CouchDB logs are rotated so as not to fill your disk.
+
+Mac OS X
+~~~~~~~~
+
+You can use the `launchctl` command to control the CouchDB daemon.
+
+You can load the configuration by running:
+
+    sudo launchctl load \
+         /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist
+
+You can stop the CouchDB daemon by running:
+
+    sudo launchctl unload \
+         /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist
+
+You can start CouchDB by running:
+
+    sudo launchctl start org.apache.couchdb
+
+You can restart CouchDB by running:
+
+    sudo launchctl stop org.apache.couchdb
+
+You can edit the launchd configuration by running:
+
+    open /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist
+
+To start the daemon on boot, copy the configuration file to:
+
+    /Library/LaunchDaemons
+
+Consult your system documentation for more information.

Added: couchdb/trunk/INSTALL.Windows
URL: http://svn.apache.org/viewvc/couchdb/trunk/INSTALL.Windows?rev=922548&view=auto
==============================================================================
--- couchdb/trunk/INSTALL.Windows (added)
+++ couchdb/trunk/INSTALL.Windows Sat Mar 13 12:58:58 2010
@@ -0,0 +1,138 @@
+Installing on Microsoft Windows
+===============================
+
+Windows
+~~~~~~~
+
+The Windows build process is very similar to the Erlang build process.
+
+Build Tools
+^^^^^^^^^^^
+
+To build on Windows, you will need the following installed:
+
+ * Erlang OTP (>=R12B5)        (http://erlang.org/)
+ * ICU                         (http://icu.sourceforge.net/)
+ * OpenSSL                     (http://www.openssl.org/)
+ * Mozilla SpiderMonkey (=1.8) (http://www.mozilla.org/js/spidermonkey/)
+ * libcurl                     (http://curl.haxx.se/libcurl/)
+ * Cygwin                      (http://www.cygwin.com/)
+ * Visual Studio 2008          (http://msdn.microsoft.com/en-gb/vstudio/default.aspx)
+
+Please note:
+
+ * When installing Erlang, you must build it from source. The CouchDB build
+   makes use of a number of the Erlang build scripts.
+
+ * When installing ICU, select the binaries built with Visual Studio 2008.
+
+ * When installing Cygwin, be sure to select all the `development` tools.
+
+ * When installing libcurl, be sure to install by hand as the Cygwin binaries
+   are built with an incompatible compiler and will not work with Erlang.
+
+Setting Up
+^^^^^^^^^^
+
+Before starting any Cygwin terminals, run the following command:
+
+    set CYGWIN=nontsec
+
+To set up your environment, run the following command:
+
+    [VS_BIN]/vcvars32.bat
+
+Replace [VS_BIN] with the path to your Visual Studio `bin` directory.
+
+After you have done this, `link.exe` and `cl.exe` should be on your path and
+correspond to the Microsoft linker and compiler, respectively.
+
+To set up your environment, run the following command:
+
+    eval `./otp_build env_win32`
+
+Do this even if you have already built Erlang because the CouchDB build system
+needs the environment variables set up by this script.
+
+To set up your path, run the following command:
+
+    export PATH=$ERL_TOP/release/win32/erts-5.7.2/bin:$PATH
+
+Everything should be set up properly now.
+
+Building
+^^^^^^^^
+
+We start by bootstrapping:
+
+  $ cd $COUCHDB_TOP
+  $ ./bootstrap
+  You have bootstrapped Apache CouchDB, time to relax.
+
+  Run `./configure' to configure the source before you install.
+  $
+
+Relax.
+
+Now we need to run a complicated configure command-line.
+
+  $ ./configure \
+      --with-js-include=/cygdrive/c/path_to_seamonkey_include \
+      --with-js-lib=/cygdrive/c/path_to_seamonkey_lib \
+      --with-win32-icu-binaries=/cygdrive/c/path_to_icu_binaries_root \
+      --with-erlang=$ERL_TOP/release/win32/usr/include \
+      --with-win32-curl=/cygdrive/c/path/to/curl/root/directory \
+      --with-openssl-bin-dir=/cygdrive/c/openssl/bin \
+      --with-msvc-redist-dir=/cygdrive/c/dir/with/vcredist_platform_executable \
+      --prefix=$ERL_TOP/release/win32
+
+Relax, then relax some more, then get a beer and relax some more; the
+above command may take many many minutes to complete...
+
+Note that all paths must be in cygwin format (ie, using '/cygdrive/c/dir/...'
+rather than 'c:/dir'.)  Those starting with $ERL_TOP can be entered
+literally, assuming ERL_TOP is set as described above.
+
+Notes:
+  When building the installer, the necessary openssl binaries are pulled from
+  the directory pointed to --with-openssl-bin-dir.
+
+Now we can build it and "install" it into the $ERL_TOP/release/win32 (or
+wherever you set --prefix to above) directory:
+
+ $ make install
+
+Relax on your new couch:
+
+  The $ERL_TOP/release/win32 directory is now ready to .zip up, be packaged
+  by an installer, etc.  To test it in-place, execute:
+
+  $ $ERL_TOP/release/win32/bin/couchdb.bat
+
+  and everything should work fine.
+
+To create an installer, execute:
+
+  $ make dist
+
+and look for etc/windows/setup-couch*.exe.  Note - only do this after
+a clean build, not after testing in-place - otherwise your test database and
+log files will be shipped!
+
+Notes
+^^^^^
+
+Building Erlang
++++++++++++++++
+
+ * Follow the instructions as described. You do need openssl, but don't need
+   the GUI tools. You can skip them with the following command:
+
+    echo "skipping gs" > lib/gs/SKIP
+    echo "skipping ic" > lib/ic/SKIP
+
+ * Ensure `which link` points at the Microsoft linker. If you do not do this,
+   the one in /usr/bin may be found instead.
+
+ * After executing `./otp_build release -a`, be sure to execute Install.exe in
+   the release/win32 directory to setup the release/win32/bin dir correctly.

Modified: couchdb/trunk/Makefile.am
URL: http://svn.apache.org/viewvc/couchdb/trunk/Makefile.am?rev=922548&r1=922547&r2=922548&view=diff
==============================================================================
--- couchdb/trunk/Makefile.am (original)
+++ couchdb/trunk/Makefile.am Sat Mar 13 12:58:58 2010
@@ -12,11 +12,35 @@
 
 SUBDIRS = bin etc src share test var utils
 
-localdoc_DATA = AUTHORS.gz BUGS.gz CHANGES.gz NEWS.gz README.gz THANKS.gz
+localdoc_DATA = \
+    AUTHORS.gz \
+    BUGS.gz \
+    BUILDING.gz \
+    CHANGES.gz \
+    INSTALL.gz \
+    INSTALL.Unix.gz \
+    INSTALL.Windows.gz \
+    LICENSE.gz \
+    NEWS.gz \
+    NOTICE.gz \
+    README.gz \
+    THANKS.gz
 
 DISTCLEANFILES = $(localdoc_DATA)
 
-EXTRA_DIST = AUTHORS BUGS CHANGES LICENSE NEWS NOTICE README THANKS license.skip
+EXTRA_DIST = \
+    AUTHORS \
+    BUGS \
+    BUILDING \
+    CHANGES \
+    INSTALL.Unix \
+    INSTALL.Windows \
+    LICENSE \
+    NEWS \
+    NOTICE \
+    README \
+    THANKS \
+    license.skip
 
 AUTHORS.gz: $(top_srcdir)/AUTHORS
 	-gzip -9 < $< > $@
@@ -24,12 +48,30 @@ AUTHORS.gz: $(top_srcdir)/AUTHORS
 BUGS.gz: $(top_srcdir)/BUGS
 	-gzip -9 < $< > $@
 
+BUILDING.gz: $(top_srcdir)/BUILDING
+	-gzip -9 < $< > $@
+
 CHANGES.gz: $(top_srcdir)/CHANGES
 	-gzip -9 < $< > $@
 
+INSTALL.gz: $(top_srcdir)/INSTALL
+	-gzip -9 < $< > $@
+
+INSTALL.Unix.gz: $(top_srcdir)/INSTALL.Unix
+	-gzip -9 < $< > $@
+
+INSTALL.Windows.gz: $(top_srcdir)/INSTALL.Windows
+	-gzip -9 < $< > $@
+
+LICENSE.gz: $(top_srcdir)/LICENSE
+	-gzip -9 < $< > $@
+
 NEWS.gz: $(top_srcdir)/NEWS
 	-gzip -9 < $< > $@
 
+NOTICE.gz: $(top_srcdir)/NOTICE
+	-gzip -9 < $< > $@
+
 README.gz: $(top_srcdir)/README
 	-gzip -9 < $< > $@
 
@@ -59,6 +101,10 @@ dev: all
 	mkdir -p $(top_builddir)/tmp/log
 	mkdir -p $(top_builddir)/tmp/run/couchdb
 
+install-data-hook:
+	@echo
+	@echo "You have installed Apache CouchDB, time to relax."
+
 distclean-local:
 	rm -fr $(top_builddir)/tmp
 

Modified: couchdb/trunk/NEWS
URL: http://svn.apache.org/viewvc/couchdb/trunk/NEWS?rev=922548&r1=922547&r2=922548&view=diff
==============================================================================
--- couchdb/trunk/NEWS (original)
+++ couchdb/trunk/NEWS Sat Mar 13 12:58:58 2010
@@ -45,8 +45,7 @@ This version has not been released yet.
  * Added ability to replicate documents by id.
  * Added virtual host handling.
  * Query server uses json2.js for JSON serialization compatiblity with native JSON.
- 
- 
+
 Version 0.10.1
 --------------
 

Modified: couchdb/trunk/README
URL: http://svn.apache.org/viewvc/couchdb/trunk/README?rev=922548&r1=922547&r2=922548&view=diff
==============================================================================
--- couchdb/trunk/README (original)
+++ couchdb/trunk/README Sat Mar 13 12:58:58 2010
@@ -1,174 +1,44 @@
 Apache CouchDB README
 =====================
 
-Apache CouchDB is beta software and still under heavy development. Please be
-aware that important areas such as the public API or internal database format
-may see backwards incompatible changes between versions.
-
-Building From Checkout
-----------------------
-
-You can skip this section if you are installing from a release tarball.
-
-Dependencies
-~~~~~~~~~~~~
-
-To build Apache CouchDB from checkout, you need some of the following installed:
-
- * GNU Automake (>=1.6.3) (http://www.gnu.org/software/automake/)
- * GNU Autoconf (>=2.59)  (http://www.gnu.org/software/autoconf/)
- * GNU Libtool            (http://www.gnu.org/software/libtool/)
- * GNU help2man           (http://www.gnu.org/software/help2man/)
-
-Debian-based (inc. Ubuntu) Systems
-++++++++++++++++++++++++++++++++++
-
-You can install the dependencies by running:
-
-    apt-get install automake autoconf libtool help2man
-
-Mac OS X
-++++++++
-
-You can install the dependencies using MacPorts by running:
-
-    port install automake autoconf libtool help2man
-
-Bootstrapping
-~~~~~~~~~~~~~
-
-Note: You must repeat this step every time you update your checkout.
+Building
+^^^^^^^^
 
-Bootstrap the pristine source by running:
+Developer build instructions are available:
 
-    ./bootstrap
+    BUILDING
 
-Installation and First Run
---------------------------
+Follow these instructions if you are building from a repository checkout.
 
-Unix-like Operating Systems (inc. Mac OS X)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+If you're unsure what this means, skip to the next section.
 
-Dependencies
+Installation
 ^^^^^^^^^^^^
 
-To build and install Apache CouchDB, you will need the following installed:
-
- * Erlang OTP (>=R12B5)        (http://erlang.org/)
- * ICU                         (http://icu.sourceforge.net/)
- * OpenSSL                     (http://www.openssl.org/)
- * Mozilla SpiderMonkey (=1.8) (http://www.mozilla.org/js/spidermonkey/)
- * libcurl                     (http://curl.haxx.se/libcurl/)
- * GNU Make                    (http://www.gnu.org/software/make/)
- * GNU Compiler Collection     (http://gcc.gnu.org/)
-
-It is recommended that you install Erlang OTP R12B-5 or above where possible.
+General installation instructions:
 
-Debian-based (inc. Ubuntu) Systems
-++++++++++++++++++++++++++++++++++
+    INSTALL
 
-You can install the dependencies by running:
+If you're running a Unix-like system, such as Ubuntu or Mac OS X:
 
-    apt-get install build-essential erlang libicu-dev libmozjs-dev libcurl4-openssl-dev
+    INSTALL.Unix
 
-If you get an error regarding the `libicu38` or `libicu-dev` be sure to check
-the version used by your distribution (using `apt-cache search libicu`) and
-install those packages instead. `libcurl4-openssl-dev` is the current version of
-`libcurl-dev` supplied by Ubuntu. You may need to specify an alternate package
-name for libcurl bindings.
+If you're running Microsoft Windows:
 
-Mac OS X
-++++++++
+    INSTALL.Windows
 
-To install GNU Make and the GNU Compiler Collection on Mac OS X you should
-install the Xcode Tools metapackage by running:
+Follow the instructions in the proper file and return to this document.
 
-    open /Applications/Installers/Xcode\ Tools/XcodeTools.mpkg
+Running
+^^^^^^^
 
-You can install the dependencies using MacPorts by running:
-
-    port install icu erlang spidermonkey curl
-
-Installing
-^^^^^^^^^^
+You can start the CouchDB server by running:
 
-Once you have satisfied the dependencies you should run:
-
-    ./configure
-
-Note: Apache CouchDB is installed into `/usr/local` by default. If you want to
-change where Apache CouchDB is installed (or where to find Erlang) be sure to
-read the output from running the `./configure --help` command.
-
-Note: All the examples assume you have installed into `/usr/local`.
-
-If everything was successful you should see the following message:
-
-    You have configured Apache CouchDB, time to relax.
-
-Relax.
-
-To install Apache CouchDB you should then run the following command:
-
-    make && sudo make install
-
-Note: The use of the `sudo` command is only required if you are installing into
-a system owned directory. You do not need to do this if you are installing
-elsewhere, such as your home directory.
-
-If you are having problems running `make` you may want to try running `gmake` if
-this is available on your system.
-
-More options can be found by reading the `INSTALL` file.
-
-Security Considerations
-^^^^^^^^^^^^^^^^^^^^^^^
-
-It is not advisable to run Apache CouchDB as the superuser. We strongly
-recommend that you create a specific user to run Apache CouchDB and own the
-data/log directories.
-
-You can use whatever tool your system provides to create a new `couchdb` user.
-
-On many Unix-like systems you can run:
-
-    adduser --system --home /usr/local/var/lib/couchdb --no-create-home \
-            --shell /bin/bash --group --gecos "CouchDB Administrator" couchdb
-
-Mac OS X provides the standard Accounts option from the System Preferences
-application or you can optionally use the Workgroup Manager application which
-can be downloaded as part of the Server Admin Tools:
-
-  http://www.apple.com/support/downloads/serveradmintools1047.html
-
-You should make sure that the `couchdb` user has a working POSIX shell and set
-the home directory to `/usr/local/var/lib/couchdb` which is the Apache CouchDB
-database directory.
-
-Change the ownership of the Apache CouchDB directories by running:
-
-    chown -R couchdb:couchdb /usr/local/etc/couchdb
-    chown -R couchdb:couchdb /usr/local/var/lib/couchdb
-    chown -R couchdb:couchdb /usr/local/var/log/couchdb
-    chown -R couchdb:couchdb /usr/local/var/run/couchdb
-
-Change the permission of the Apache CouchDB directories by running:
-
-    chmod -R 0770 /usr/local/etc/couchdb
-    chmod -R 0770 /usr/local/var/lib/couchdb
-    chmod -R 0770 /usr/local/var/log/couchdb
-    chmod -R 0770 /usr/local/var/run/couchdb
-
-Running Manually
-^^^^^^^^^^^^^^^^
-
-You can start the Apache CouchDB server by running:
-
-    sudo -i -u couchdb couchdb -b
+    sudo -i -u couchdb couchdb
 
 This uses the `sudo` command to run the `couchdb` command as the `couchdb` user.
 
-When Apache CouchDB starts it should eventually display the following message:
+When CouchDB starts it should eventually display the following message:
 
     Apache CouchDB has started, time to relax.
 
@@ -176,24 +46,29 @@ Relax.
 
 To check that everything has worked, point your web browser to:
 
-  http://127.0.0.1:5984/_utils/index.html
+    http://127.0.0.1:5984/_utils/index.html
 
 From here you should run the test suite.
 
+Check the appropriate `INSTALL` file for help with running CouchDB as a daemon.
+
 Troubleshooting
 ^^^^^^^^^^^^^^^
 
-If you're getting a cryptic error message, visit the wiki:
+For general troubleshooting:
 
-  http://wiki.apache.org/couchdb/Error_messages
+    http://wiki.apache.org/couchdb/Troubleshooting
 
-For general troubleshooting, visit the wiki:
+If you're getting a cryptic error message:
 
-  http://wiki.apache.org/couchdb/Troubleshooting
+    http://wiki.apache.org/couchdb/Error_messages
 
-Running as a Daemon
-^^^^^^^^^^^^^^^^^^^
+The mailing lists also provide a wealth of support and knowledge for you to tap
+into. Feel free to drop by with your questions or comments. See the official
+CouchDB website for more information about our community resources.
 
+<<<<<<< .mine
+=======
 Note: These instructions assume you have created the `couchdb` user. See the
 specific system information included below to learn how to reconfigure this.
 
@@ -394,21 +269,22 @@ Building Erlang
  * After executing `./otp_build release -a`, be sure to execute Install.exe in
    the release/win32 directory to setup the release/win32/bin dir correctly.
 
+>>>>>>> .r922524
 Cryptographic Software Notice
 -----------------------------
 
-This distribution includes cryptographic software.  The country in which you
+This distribution includes cryptographic software. The country in which you
 currently reside may have restrictions on the import, possession, use, and/or
-re-export to another country, of encryption software.  BEFORE using any
+re-export to another country, of encryption software. BEFORE using any
 encryption software, please check your country's laws, regulations and policies
 concerning the import, possession, or use, and re-export of encryption software,
-to see if this is permitted.  See <http://www.wassenaar.org/> for more
+to see if this is permitted. See <http://www.wassenaar.org/> for more
 information.
 
 The U.S. Government Department of Commerce, Bureau of Industry and Security
 (BIS), has classified this software as Export Commodity Control Number (ECCN)
 5D002.C.1, which includes information security software using or performing
-cryptographic functions with asymmetric algorithms.  The form and manner of this
+cryptographic functions with asymmetric algorithms. The form and manner of this
 Apache Software Foundation distribution makes it eligible for export under the
 License Exception ENC Technology Software Unrestricted (TSU) exception (see the
 BIS Export Administration Regulations, Section 740.13) for both object code and



Mime
View raw message