Update CouchDB documentation

Author: wohali

couchdb/README-short.txt

@@ -1 +1 @@
-CouchDB is a database that uses JSON for documents, JavaScript for MapReduce and HTTP for its API.
+CouchDB is a database that uses JSON for documents, HTTP for its API, and offers JavaScript and declarative secondary indexing.

couchdb/content.md

@@ -1,8 +1,8 @@
 # What is Apache CouchDB?
 
-CouchDB is a database that completely embraces the web. Store your data with JSON documents. Access your documents and query your indexes with your web browser, via HTTP. Index, combine, and transform your documents with JavaScript. CouchDB works well with modern web and mobile apps. You can even serve web apps directly out of CouchDB. And you can distribute your data, or your apps, efficiently using CouchDB’s incremental replication. CouchDB supports master-master setups with automatic conflict detection.
+Apache CouchDB™ lets you access your data where you need it by defining the Couch Replication Protocol that is implemented by a variety of projects and products that span every imaginable computing environment from globally distributed server-clusters, over mobile phones to web browsers. Software that is compatible with the Couch Replication Protocol include: PouchDB, Buttant, and Couchbase Lite.
 
-CouchDB comes with a suite of features, such as on-the-fly document transformation and real-time change notifications, that makes web app development a breeze. It even comes with an easy to use web administration console. You guessed it, served up directly out of CouchDB! We care a lot about distributed scaling. CouchDB is highly available and partition tolerant, but is also eventually consistent. And we care a lot about your data. CouchDB has a fault-tolerant storage engine that puts the safety of your data first.
+Store your data safely, on your own servers, or with any leading cloud provider. Your web- and native applications love CouchDB, because it speaks JSON natively and supports binary for all your data storage needs. The Couch Replication Protocol lets your data flow seamlessly between server clusters to mobile phones and web browsers, enabling a compelling, offline-first user-experience while maintaining high performance and strong reliability. CouchDB comes with a developer-friendly query language, and optionally MapReduce for simple, efficient, and comprehensive data retrieval. 
 
 > [couchdb.apache.org](https://couchdb.apache.org)
 
@@ -26,7 +26,12 @@ In order to use the running instance from an application, link the container
 $ docker run --name my-couchdb-app --link my-couchdb:couch %%REPO%%
 ```
 
-See the [official docs](http://docs.couchdb.org/en/1.6.1/) for infomation on using and configuring CouchDB.
+Please note that CouchDB no longer autocreates system tables for you, so you will have to create `_global_changes`, `_metadata`, `_replicator` and `_users` manually (the admin interface has a "Setup" menu that does this for you).
+The node will also start in [admin party mode](http://guide.couchdb.org/draft/security.html#party)!
+
+For the `2.1` image, configuration is stored at `/opt/couchdb/etc/`.
+
+See the [official docs](http://docs.couchdb.org/en/2.1.0/) for infomation on using and configuring CouchDB.
 
 ### Exposing the port to the outside world
 
@@ -38,21 +43,25 @@ $ docker run -p 5984:5984 -d %%REPO%%
 
 CouchDB listens on port 5984 for requests and the image includes `EXPOSE 5984`. The flag `-p 5984:5984` exposes this port on the host.
 
+*WARNING*: Do not do this until you have established an admin user and setup
+permissions correctly on any databases you have created.
+
 ## Persistent Data
 
 There are several ways to store data used by applications that run in Docker containers. We encourage users of the `%%REPO%%` images to familiarize themselves with the options available, including:
 
 -	Let Docker manage the storage of your database data [by writing the database files to disk on the host system using its own internal volume management](https://docs.docker.com/engine/tutorials/dockervolumes/#adding-a-data-volume). This is the default and is easy and fairly transparent to the user. The downside is that the files may be hard to locate for tools and applications that run directly on the host system, i.e. outside containers.
 -	Create a data directory on the host system (outside the container) and [mount this to a directory visible from inside the container](https://docs.docker.com/engine/tutorials/dockervolumes/#mount-a-host-directory-as-a-data-volume). This places the database files in a known location on the host system, and makes it easy for tools and applications on the host system to access the files. The downside is that the user needs to make sure that the directory exists, and that e.g. directory permissions and other security mechanisms on the host system are set up correctly.
 
-CouchDB uses `/usr/local/var/lib/couchdb` to store its data. This directory is marked as a docker volume.
+CouchDB uses `/opt/couchdb/data` to store its data, and is exposed as a volume.
+CouchDB uses `/opt/couchdb/etc` to store its configuration.
 
 ### Using host directories
 
 You can map the container's volumes to a directory on the host, so that the data is kept between runs of the container. This example uses your current directory, but that is in general not the correct place to store your persistent data!
 
 ```console
-$ docker run -d -v $(pwd):/usr/local/var/lib/couchdb --name my-couchdb %%REPO%%
+$ docker run -d -v $(pwd):/opt/couchdb/data --name my-couchdb %%REPO%%
 ```
 
 ## Specifying the admin user in the environment
@@ -63,14 +72,22 @@ You can use the two environment variables `COUCHDB_USER` and `COUCHDB_PASSWORD`
 $ docker run -e COUCHDB_USER=admin -e COUCHDB_PASSWORD=password -d %%REPO%%
 ```
 
+Note that if you are setting up a clustered CouchDB, you will want to
+pre-hash this password and use the identical hashed text across all nodes to
+ensure sessions work correctly when a load balancer is placed in front of
+the cluster. Hashing can be accomplished by running the container with the
+`/opt/couchdb/etc/local.d` directory mounted as a volume, allowing CouchDB to
+hash the password you set, then copying out the hashed version and using this
+value in the future.
+
 ## Using your own CouchDB configuration file
 
-The CouchDB configuration is specified in `.ini` files in `/usr/local/etc/couchdb`. Take a look at the [CouchDB configuration documentation](http://docs.couchdb.org/en/1.6.1/config/index.html) to learn more about CouchDBs configuration structure.
+The CouchDB configuration is specified in `.ini` files in `/opt/couchdb/etc`. Take a look at the [CouchDB configuration documentation](http://docs.couchdb.org/en/2.1.0/config/index.html) to learn more about CouchDB's configuration structure.
 
-If you want to use a customized CouchDB configuration, you can create your configuration file in a directory on the host machine and then mount that directory as `/usr/local/etc/couchdb/local.d` inside the `%%REPO%%` container.
+If you want to use a customized CouchDB configuration, you can create your configuration file in a directory on the host machine and then mount that directory as `/opt/couchdb/etc/local.d` inside the `%%REPO%%` container.
 
 ```console
-$ docker run --name my-couchdb -v /my/custom-config-dir:/usr/local/etc/couchdb/local.d -d %%REPO%%
+$ docker run --name my-couchdb -v /my/custom-config-dir:/opt/couchdb/etc/local.d -d %%REPO%%
 ```
 
 You can also use `couchdb` as the base image for your own couchdb instance and provie your own version of the `local.ini` config file:
@@ -80,7 +97,7 @@ Example Dockerfile:
 ```dockerfile
 FROM %%REPO%%
 
-COPY local.ini /usr/local/etc/couchdb/
+COPY local.ini /opt/couchdb/etc/
 ```
 
 and then build and run
@@ -92,15 +109,16 @@ $ docker run -d -p 5984:5984 you/awesome-couchdb
 
 ## Logging
 
-By default containers run from this image only log to `stdout`. This means that the `/_log` endpoint is not available. You can enable logging to file in the [configuration](http://docs.couchdb.org/en/1.6.1/config/logging.html).
+By default containers run from this image only log to `stdout`. You can enable logging to file in the [configuration](http://docs.couchdb.org/en/2.1.0/config/logging.html).
 
 For example in `local.ini`:
 
 ```ini
 [log]
-file = /usr/local/var/log/couchdb/couch.log
+writer = file
+file = /opt/couchdb/log/couch.log
 ```
 
 ## Erlang Version
 
-This image uses Erlang `17.3` from Debian Jessie's repository. Debian's version patches a critical bug in Erlang `17.3` and is good to use with CouchDB ([confirmed by Jan Lehnardt](https://github.com/klaemo/docker-couchdb/issues/50#issuecomment-190832786)).
+This image uses Erlang `17.3` from Debian Jessie's repository. Debian's version patches a critical bug in Erlang `17.3` and is good to use with CouchDB.

couchdb/github-repo

@@ -1 +1 @@
-https://github.com/klaemo/docker-couchdb
+https://github.com/apache/couchdb-docker