couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kxe...@apache.org
Subject [09/14] Documentation was moved to couchdb-documentation repository
Date Thu, 16 Oct 2014 09:09:21 GMT
http://git-wip-us.apache.org/repos/asf/couchdb/blob/cdac7299/share/doc/src/config/http-handlers.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/http-handlers.rst b/share/doc/src/config/http-handlers.rst
deleted file mode 100644
index e4a1f41..0000000
--- a/share/doc/src/config/http-handlers.rst
+++ /dev/null
@@ -1,291 +0,0 @@
-.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
-.. use this file except in compliance with the License. You may obtain a copy of
-.. the License at
-..
-..   http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-.. License for the specific language governing permissions and limitations under
-.. the License.
-
-.. highlight:: ini
-
-======================
-HTTP Resource Handlers
-======================
-
-.. _config/httpd_global_handlers:
-
-Global HTTP Handlers
-====================
-
-.. config:section:: httpd_global_handlers :: Global HTTP Handlers
-
-  These HTTP resources are provided for CouchDB server root level.
-
-  .. config:option:: /
-
-    ::
-
-      [httpd_global_handlers]
-      / = {couch_httpd_misc_handlers, handle_welcome_req, <<"Welcome">>}
-
-
-
-  .. config:option:: favicon.ico
-
-    The favicon handler looks for `favicon.ico` file within specified directory::
-
-      [httpd_global_handlers]
-      favicon.ico = {couch_httpd_misc_handlers, handle_favicon_req, "/usr/share/couchdb/www"}
-
-
-
-  .. config:option:: _active_tasks
-
-    ::
-
-      [httpd_global_handlers]
-      _active_tasks = {couch_httpd_misc_handlers, handle_task_status_req}
-
-
-
-  .. config:option:: _all_dbs
-
-    Provides a list of all server's databases::
-
-      [httpd_global_handlers]
-      _all_dbs = {couch_httpd_misc_handlers, handle_all_dbs_req}
-
-    .. note::
-
-       Sometimes you don't want to disclose database names for everyone, but
-       you also don't like/want/able to setup any proxies in front of CouchDB.
-       Removing this handler disables ``_all_dbs`` resource and there will be
-       no way to get list of available databases.
-
-       The same also is true for other resource handlers.
-
-
-
-  .. config:option:: _config
-
-    Provides resource to work with CouchDB config :ref:`remotely <api/config>`.
-    Any config changes that was made via HTTP API are applied automatically on
-    fly and doesn't requires server instance to be restarted::
-
-      [httpd_global_handlers]
-      _config = {couch_httpd_misc_handlers, handle_config_req}
-
-
-
-  .. config:option:: _log
-
-    ::
-
-      [httpd_global_handlers]
-      _log = {couch_httpd_misc_handlers, handle_log_req}
-
-
-
-    .. config:option:: _oauth
-
-    ::
-
-      [httpd_global_handlers]
-      _oauth = {couch_httpd_oauth, handle_oauth_req}
-
-
-
-  .. config:option:: _replicate
-
-    Provides an API to run :ref:`temporary replications <api/server/replicate>`::
-
-      [httpd_global_handlers]
-      _replicate = {couch_replicator_httpd, handle_req}
-
-
-
-  .. config:option:: _restart
-
-    ::
-
-      [httpd_global_handlers]
-      _restart = {couch_httpd_misc_handlers, handle_restart_req}
-
-
-
-  .. config:option:: _session
-
-    Provides a resource with information about the current user's session::
-
-      [httpd_global_handlers]
-      _session = {couch_httpd_auth, handle_session_req}
-
-
-  .. config:option:: _stats
-
-    ::
-
-      [httpd_global_handlers]
-      _stats = {couch_httpd_stats_handlers, handle_stats_req}
-
-
-  .. config:option:: _utils
-
-    The :ref:`_utils <api/server/utils>` handler serves `Futon`'s web administration
-    page::
-
-      [httpd_global_handlers]
-      _utils = {couch_httpd_misc_handlers, handle_utils_dir_req, "/usr/share/couchdb/www"}
-
-    In similar way, you may setup custom handler to let CouchDB serve any static
-    files.
-
-
-  .. config:option:: _uuids
-
-    Provides a resource to get UUIDs generated by CouchDB::
-
-      [httpd_global_handlers]
-      _uuids = {couch_httpd_misc_handlers, handle_uuids_req}
-
-    This is useful when your client environment isn't capable of providing truly
-    random IDs (web browsers e.g.).
-
-
-.. _config/httpd_db_handlers:
-
-Database HTTP Handlers
-======================
-
-.. config:section:: httpd_db_handlers :: Database HTTP Handlers
-
-  These HTTP resources are available on every CouchDB database.
-
-
-  .. config:option:: _all_docs
-
-    ::
-
-      [httpd_db_handlers]
-      _all_docs = {couch_mrview_http, handle_all_docs_req}
-
-
-
-  .. config:option:: _changes
-
-    ::
-
-      [httpd_db_handlers]
-      _changes = {couch_httpd_db, handle_changes_req}
-
-
-
-  .. config:option:: _compact
-
-    ::
-
-      [httpd_db_handlers]
-      _compact = {couch_httpd_db, handle_compact_req}
-
-
-
-  .. config:option:: _design
-
-    ::
-
-      [httpd_db_handlers]
-      _design = {couch_httpd_db, handle_design_req}
-
-
-
-  .. config:option:: _temp_view
-
-    ::
-
-      [httpd_db_handlers]
-      _temp_view = {couch_mrview_http, handle_temp_view_req}
-
-
-
-  .. config:option:: _view_cleanup
-
-    ::
-
-      [httpd_db_handlers]
-      _view_cleanup = {couch_mrview_http, handle_cleanup_req}
-
-
-.. _config/httpd_design_handlers:
-
-Design Documents HTTP Handlers
-==============================
-
-.. config:section:: httpd_design_handlers :: Design Documents HTTP Handlers
-
-These HTTP resources are provided for design documents.
-
-
-  .. config:option:: _compact
-
-    ::
-
-      [httpd_design_handlers]
-      _compact = {couch_mrview_http, handle_compact_req}
-
-
-
-  .. config:option:: _info
-
-    ::
-
-      [httpd_design_handlers]
-      _info = {couch_mrview_http, handle_info_req}
-
-
-
-  .. config:option:: _list
-
-    ::
-
-      [httpd_design_handlers]
-      _list = {couch_mrview_show, handle_view_list_req}
-
-
-
-  .. config:option:: _rewrite
-
-    ::
-
-      [httpd_design_handlers]
-      _rewrite = {couch_httpd_rewrite, handle_rewrite_req}
-
-
-
-  .. config:option:: _show
-
-    ::
-
-      [httpd_design_handlers]
-      _show = {couch_mrview_show, handle_doc_show_req}
-
-
-
-  .. config:option:: _update
-
-    ::
-
-      [httpd_design_handlers]
-      _update = {couch_mrview_show, handle_doc_update_req}
-
-
-
-  .. config:option:: _view
-
-    ::
-
-      [httpd_design_handlers]
-      _view = {couch_mrview_http, handle_view_req}

http://git-wip-us.apache.org/repos/asf/couchdb/blob/cdac7299/share/doc/src/config/http.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/http.rst b/share/doc/src/config/http.rst
deleted file mode 100644
index f4fade1..0000000
--- a/share/doc/src/config/http.rst
+++ /dev/null
@@ -1,628 +0,0 @@
-.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
-.. use this file except in compliance with the License. You may obtain a copy of
-.. the License at
-..
-..   http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-.. License for the specific language governing permissions and limitations under
-.. the License.
-
-.. default-domain:: config
-
-.. highlight:: ini
-
-===================
-CouchDB HTTP Server
-===================
-
-.. _config/httpd:
-
-HTTP Server Options
-===================
-
-.. config:section:: httpd :: HTTP Server Options
-
-  .. config:option:: allow_jsonp :: Enables JSONP support
-
-    The ``true`` value of this option enables `JSONP`_ support (it's ``false`` by
-    default)::
-
-      [httpd]
-      allow_jsonp = false
-
-    .. _JSONP: http://www.json-p.org/
-
-
-  .. config:option:: authentication_handlers :: Authentication handlers
-
-    List of used authentication handlers that used by CouchDB. You may extend
-    them via third-party plugins or remove some of them if you won't let users
-    to use one of provided methods::
-
-      [httpd]
-      authentication_handlers = {couch_httpd_oauth, oauth_authentication_handler}, {couch_httpd_auth, cookie_authentication_handler}, {couch_httpd_auth, default_authentication_handler}
-
-    - ``{couch_httpd_oauth, oauth_authentication_handler}``: handles OAuth;
-    - ``{couch_httpd_auth, cookie_authentication_handler}``: used for Cookie auth;
-    - ``{couch_httpd_auth, proxy_authentication_handler}``: used for Proxy auth;
-    - ``{couch_httpd_auth, default_authentication_handler}``: used for Basic auth;
-    - ``{couch_httpd_auth, null_authentication_handler}``: disables auth.
-      Everlasting `Admin Party`!
-
-
-  .. config:option:: bind_address :: Listen IP address
-
-    Defines the IP address by which CouchDB will be accessible::
-
-      [httpd]
-      bind_address = 127.0.0.1
-
-    To let CouchDB listen any available IP address, just setup ``0.0.0.0``
-    value::
-
-      [httpd]
-      bind_address = 0.0.0.0
-
-    For IPv6 support you need to set ``::1`` if you want to let CouchDB listen
-    local address::
-
-      [httpd]
-      bind_address = ::1
-
-    or ``::`` for any available::
-
-      [httpd]
-      bind_address = ::
-
-
-  .. config:option:: changes_timeout :: Changes feed timeout
-
-    Specifies default `timeout` value for :ref:`Changes Feed <changes>` in
-    milliseconds (60000 by default)::
-
-      [httpd]
-      changes_feed = 60000 ; 60 seconds
-
-
-  .. config:option:: config_whitelist :: Config options while list
-
-    Sets the configuration modification whitelist. Only whitelisted values
-    may be changed via the :ref:`config API <api/config>`. To allow the admin
-    to change this value over HTTP, remember to include
-    ``{httpd,config_whitelist}`` itself. Excluding it from the list would
-    require editing this file to update the whitelist::
-
-      [httpd]
-      config_whitelist = [{httpd,config_whitelist}, {log,level}, {etc,etc}]
-
-
-  .. config:option:: default_handler :: Default request handler
-
-    Specifies default HTTP requests handler::
-
-      [httpd]
-      default_handler = {couch_httpd_db, handle_request}
-
-
-  .. config:option:: enable_cors :: Activates CORS
-
-    .. versionadded:: 1.3
-
-    Controls :ref:`CORS <config/cors>` feature::
-
-      [httpd]
-      enable_cors = false
-
-
-  .. config:option:: log_max_chunk_size :: Logs chunk size
-
-    Defines maximum chunk size in bytes for :ref:`_log <api/server/log>`
-    resource::
-
-      [httpd]
-      log_max_chunk_size = 1000000
-
-
-  .. config:option:: port :: Listen port
-
-    Defined the port number to listen::
-
-      [httpd]
-      port = 5984
-
-    To let CouchDB handle any free port, set this option to ``0``::
-
-      [httpd]
-      port = 0
-
-    After that, CouchDB URI could be located within the URI file.
-
-
-  .. config:option:: redirect_vhost_handler :: Virtual Hosts custom redirect handler
-
-    This option customizes the default function that handles requests to
-    :section:`virtual hosts <vhosts>`::
-
-      [httpd]
-      redirect_vhost_handler = {Module, Fun}
-
-    The specified function take 2 arguments: the Mochiweb request object and the
-    target path.
-
-
-  .. config:option:: server_options :: MochiWeb Server Options
-
-    Server options for the `MochiWeb`_ component of CouchDB can be added to the
-    configuration files::
-
-      [httpd]
-      server_options = [{backlog, 128}, {acceptor_pool_size, 16}]
-
-    .. _MochiWeb: https://github.com/mochi/mochiweb
-
-
-  .. config:option:: secure_rewrites :: Default request handler
-
-    This option allow to isolate databases via subdomains::
-
-      [httpd]
-      secure_rewrites = true
-
-
-  .. config:option:: socket_options :: Socket Options
-
-    The socket options for the listening socket in CouchDB can be specified as
-    a list of tuples. For example::
-
-      [httpd]
-      socket_options = [{recbuf, 262144}, {sndbuf, 262144}, {nodelay, true}]
-
-    The options supported are a subset of full options supported by the
-    TCP/IP stack. A list of the supported options are provided in the
-    `Erlang inet`_ documentation.
-
-    .. _Erlang inet: http://www.erlang.org/doc/man/inet.html#setopts-2
-
-
-  .. config:option:: vhost_global_handlers :: Virtual hosts global handlers
-
-    List of global handlers that are available for :section:`virtual hosts
-    <vhosts>`::
-
-      [httpd]
-      vhost_global_handlers = _utils, _uuids, _session, _oauth, _users
-
-
-  .. config:option:: x_forwarded_host :: X-Forwarder-Host
-
-    The `x_forwarded_host` header (``X-Forwarded-Host`` by default) is used to
-    forward the original value of the ``Host`` header field in case, for
-    example, if a reverse proxy is rewriting the "Host" header field to some
-    internal host name before forward the request to CouchDB::
-
-      [httpd]
-      x_forwarded_host = X-Forwarded-Host
-
-    This header has higher priority above ``Host`` one, if only it exists in
-    the request.
-
-
-  .. config:option:: x_forwarded_proto :: X-Forwarder-Proto
-
-    `x_forwarded_proto` header (``X-Forwarder-Proto`` by default) is used for
-    identifying the originating protocol of an HTTP request, since a reverse
-    proxy may communicate with CouchDB instance using HTTP even if the request
-    to the reverse proxy is HTTPS::
-
-      [httpd]
-      x_forwarded_proto = X-Forwarded-Proto
-
-
-  .. config:option:: x_forwarded_ssl :: X-Forwarder-Ssl
-
-    The `x_forwarded_ssl` header (``X-Forwarded-Ssl`` by default) tells CouchDB
-    that it should use the `https` scheme instead of the `http`. Actually, it's
-    a synonym for ``X-Forwarded-Proto: https`` header, but used by some reverse
-    proxies::
-
-      [httpd]
-      x_forwarded_ssl = X-Forwarded-Ssl
-
-
-  .. config:option:: WWW-Authenticate :: Force basic auth
-
-    Set this option to trigger basic-auth popup on unauthorized requests::
-
-      [httpd]
-      WWW-Authenticate = Basic realm="Welcome to the Couch!"
-
-
-.. _config/ssl:
-
-Secure Socket Level Options
-===========================
-
-.. config:section:: ssl :: Secure Socket Level Options
-
-  CouchDB supports SSL natively. All your secure connection needs can
-  now be served without needing to setup and maintain a separate proxy server
-  that handles SSL.
-
-  SSL setup can be tricky, but the configuration in CouchDB was designed
-  to be as easy as possible. All you need is two files; a certificate and
-  a private key. If you bought an official SSL certificate from a
-  certificate authority, both should be in your possession already.
-
-  If you just want to try this out and don't want to pay anything upfront,
-  you can create a self-signed certificate. Everything will work the same,
-  but clients will get a warning about an insecure certificate.
-
-  You will need the `OpenSSL`_ command line tool installed. It probably
-  already is.
-
-  .. code-block:: bash
-
-    shell> mkdir /etc/couchdb/cert
-    shell> cd /etc/couchdb/cert
-    shell> openssl genrsa > privkey.pem
-    shell> openssl req -new -x509 -key privkey.pem -out couchdb.pem -days 1095
-    shell> chmod 600 privkey.pem couchdb.pem
-    shell> chown couchdb privkey.pem couchdb.pem
-
-  Now, you need to edit CouchDB's configuration, either by editing your
-  ``local.ini`` file or using the ``/_config`` API calls or the
-  configuration screen in Futon. Here is what you need to do in
-  ``local.ini``, you can infer what needs doing in the other places.
-
-  At first, :option:`enable the HTTPS daemon <daemons/httpsd>`::
-
-    [daemons]
-    httpsd = {couch_httpd, start_link, [https]}
-
-  Next, under ``[ssl]`` section setup newly generated certificates::
-
-    [ssl]
-    cert_file = /etc/couchdb/cert/couchdb.pem
-    key_file = /etc/couchdb/cert/privkey.pem
-
-  For more information please read `certificates HOWTO`_.
-
-  Now start (or restart) CouchDB. You should be able to connect to it
-  using HTTPS on port 6984:
-
-  .. code-block:: bash
-
-    shell> curl https://127.0.0.1:6984/
-    curl: (60) SSL certificate problem, verify that the CA cert is OK. Details:
-    error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed
-    More details here: http://curl.haxx.se/docs/sslcerts.html
-
-    curl performs SSL certificate verification by default, using a "bundle"
-    of Certificate Authority (CA) public keys (CA certs). If the default
-    bundle file isn't adequate, you can specify an alternate file
-    using the --cacert option.
-    If this HTTPS server uses a certificate signed by a CA represented in
-    the bundle, the certificate verification probably failed due to a
-    problem with the certificate (it might be expired, or the name might
-    not match the domain name in the URL).
-    If you'd like to turn off curl's verification of the certificate, use
-    the -k (or --insecure) option.
-
-  Oh no! What happened?! Remember, clients will notify their users that
-  your certificate is self signed. ``curl`` is the client in this case and
-  it notifies you. Luckily you trust yourself (don't you?) and you can
-  specify the ``-k`` option as the message reads:
-
-  .. code-block:: bash
-
-    shell> curl -k https://127.0.0.1:6984/
-    {"couchdb":"Welcome","version":"1.5.0"}
-
-  All done.
-
-  .. _`certificates HOWTO`: http://www.openssl.org/docs/HOWTO/certificates.txt
-  .. _OpenSSL: http://www.openssl.org/
-
-
-  .. config:option:: cacert_file :: CA Certificate file
-
-    Path to file containing PEM encoded CA certificates (trusted certificates
-    used for verifying a peer certificate). May be omitted if you do not want
-    to verify the peer::
-
-      [ssl]
-      cacert_file = /etc/ssl/certs/ca-certificates.crt
-
-
-  .. config:option:: cert_file :: Certificate file
-
-    Path to a file containing the user's certificate::
-
-      [ssl]
-      cert_file = /etc/couchdb/cert/couchdb.pem
-
-
-  .. config:option:: key_file :: Certificate key file
-
-    Path to file containing user's private PEM encoded key::
-
-      [ssl]
-      key_file = /etc/couchdb/cert/privkey.pem
-
-
-  .. config:option:: password :: Certificate key password
-
-    String containing the user's password. Only used if the private keyfile is
-    password protected::
-
-      [ssl]
-      password = somepassword
-
-
-  .. config:option:: ssl_certificate_max_depth :: Maximum peer certificate depth
-
-    Maximum peer certificate depth (must be set even if certificate validation
-    is off)::
-
-      [ssl]
-      ssl_certificate_max_depth = 1
-
-
-  .. config:option:: verify_fun :: SSL verification function
-
-    The verification fun (optional) if not specified, the default
-    verification fun will be used::
-
-      [ssl]
-      verify_fun = {Module, VerifyFun}
-
-
-  .. config:option:: verify_ssl_certificates :: Enable certificate verification
-
-    Set to `true` to validate peer certificates::
-
-      [ssl]
-      verify_ssl_certificates = false
-
-  .. config:option:: fail_if_no_peer_cert :: Require presence of client certificate if certificate verification is enabled
-
-    Set to `true` to terminate the TLS/SSL handshake with a
-    `handshake_failure` alert message if the client does not send a
-    certificate. Only used if `verify_ssl_certificates` is `true`. If
-    set to `false` it will only fail if the client sends an invalid
-    certificate (an empty certificate is considered valid)::
-
-      [ssl]
-      fail_if_no_peer_cert = false
-
-  .. config:option:: secure_renegotiate :: Enable secure renegotiation
-
-    Set to `true` to reject renegotiation attempt that does not live up to RFC 5746::
-
-      [ssl]
-      secure_renegotiate = true
-
-  .. config:option:: ciphers :: Specify permitted server cipher list
-
-    Set to the cipher suites that should be supported which can be
-    specified in erlang format "{ecdhe_ecdsa,aes_128_cbc,sha256}" or
-    in OpenSSL format "ECDHE-ECDSA-AES128-SHA256".
-
-      [ssl]
-      ciphers = ["ECDHE-ECDSA-AES128-SHA256", "ECDHE-ECDSA-AES128-SHA"]
-
-  .. config:option:: tls_versions :: Specify permitted server SSL/TLS
-                     protocol versions
-
-    Set to a list of permitted SSL/TLS protocol versions::
-
-      [ssl]
-      tls_versions = [sslv3 | tlsv1 | 'tlsv1.1' | 'tlsv1.2']
-
-
-.. _cors:
-.. _config/cors:
-
-Cross-Origin Resource Sharing
-=============================
-
-.. config:section:: cors :: Cross-Origin Resource Sharing
-
-  .. versionadded:: 1.3 added CORS support, see JIRA :issue:`431`
-
-  `CORS`, or "Cross-Origin Resource Sharing", allows a resource such as a web
-  page running JavaScript inside a browser, to make AJAX requests
-  (XMLHttpRequests) to a different domain, without compromising the security
-  of either party.
-
-  A typical use case is to have a static website hosted on a CDN make
-  requests to another resource, such as a hosted CouchDB instance. This
-  avoids needing an intermediary proxy, using `JSONP` or similar workarounds
-  to retrieve and host content.
-
-  While CouchDB's integrated HTTP server has support for document attachments
-  makes this less of a constraint for pure CouchDB projects, there are many
-  cases where separating the static content from the database access is
-  desirable, and CORS makes this very straightforward.
-
-  By supporting CORS functionality, a CouchDB instance can accept direct
-  connections to protected databases and instances, without the browser
-  functionality being blocked due to same-origin constraints. CORS is
-  supported today on over 90% of recent browsers.
-
-  CORS support is provided as experimental functionality in 1.3, and as such
-  will need to be enabled specifically in CouchDB's configuration. While all
-  origins are forbidden from making requests by default, support is available
-  for simple requests, preflight requests and per-vhost configuration.
-
-  This section requires :option:`httpd/enable_cors` option have
-  ``true`` value::
-
-    [httpd]
-    enable_cors = true
-
-
-  .. config:option:: credentials
-
-    By default, neither authentication headers nor cookies are included in
-    requests and responses. To do so requires both setting
-    ``XmlHttpRequest.withCredentials = true`` on the request object in the
-    browser and enabling credentials support in CouchDB.
-
-    ::
-
-      [cors]
-      credentials = true
-
-    CouchDB will respond to a credentials-enabled CORS request with an
-    additional header, ``Access-Control-Allow-Credentials=true``.
-
-
-  .. config:option:: origins
-
-    List of origins separated by a comma, ``*`` means accept all.
-    You can’t set ``origins = *`` and ``credentials = true`` option at the same
-    time::
-
-      [cors]
-      origins = *
-
-    Access can be restricted by protocol, host and optionally by port. Origins
-    must follow the scheme: http://example.com:80::
-
-      [cors]
-      origins = http://localhost, https://localhost, http://couch.mydev.name:8080
-
-    Note that by default, no origins are accepted. You must define them
-    explicitly.
-
-
-  .. config:option:: headers
-
-    List of accepted headers separated by a comma::
-
-      [cors]
-      headers = X-Couch-Id, X-Couch-Rev
-
-
-  .. config:option:: methods
-
-    List of accepted methods::
-
-      [cors]
-      methods = GET,POST
-
-  .. seealso::
-
-     Original JIRA `implementation ticket <https://issues.apache.org/jira/browse/COUCHDB-431>`_
-
-     Standards and References:
-
-     - IETF RFCs relating to methods: :rfc:`2618`, :rfc:`2817`, :rfc:`5789`
-     - IETF RFC for Web Origins: :rfc:`6454`
-     - W3C `CORS standard <http://www.w3.org/TR/cors>`_
-
-     Mozilla Developer Network Resources:
-
-     - `Same origin policy for URIs <https://developer.mozilla.org/en-US/docs/Same-origin_policy_for_file:_URIs>`_
-     - `HTTP Access Control <https://developer.mozilla.org/En/HTTP_access_control>`_
-     - `Server-side Access Control <https://developer.mozilla.org/En/Server-Side_Access_Control>`_
-     - `Javascript same origin policy <https://developer.mozilla.org/en-US/docs/Same_origin_policy_for_JavaScript>`_
-
-     Client-side CORS support and usage:
-
-     - `CORS browser support matrix <http://caniuse.com/cors>`_
-     - `COS tutorial <http://www.html5rocks.com/en/tutorials/cors/>`_
-     - `XHR with CORS <http://hacks.mozilla.org/2009/07/cross-site-xmlhttprequest-with-cors/>`_
-
-
-Per Virtual Host Configuration
-------------------------------
-
-To set the options for a :section:`vhosts`, you will need to create a section
-with the vhost name prefixed by ``cors:``. Example case for the vhost
-`example.com`::
-
-  [cors:example.com]
-  credentials = false
-  ; List of origins separated by a comma
-  origins = *
-  ; List of accepted headers separated by a comma
-  headers = X-CouchDB-Header
-  ; List of accepted methods
-  methods = HEAD, GET
-
-
-
-.. _config/vhosts:
-
-Virtual Hosts
-=============
-
-.. config:section:: vhosts :: Virtual Hosts
-
-  CouchDB can map requests to different locations based on the ``Host`` header,
-  even if they arrive on the same inbound IP address.
-
-  This allows different virtual hosts on the same machine to map to different
-  databases or design documents, etc. The most common use case is to map a
-  virtual host to a :ref:`Rewrite Handler <api/ddoc/rewrite>`, to provide full
-  control over the application's URIs.
-
-  To add a virtual host, add a `CNAME` pointer to the DNS for your domain
-  name. For development and testing, it is sufficient to add an entry in
-  the hosts file, typically `/etc/hosts`` on Unix-like operating systems:
-
-  .. code-block:: text
-
-     # CouchDB vhost definitions, refer to local.ini for further details
-     127.0.0.1       couchdb.local
-
-  Test that this is working:
-
-  .. code-block:: bash
-
-     $ ping -n 2 couchdb.local
-     PING couchdb.local (127.0.0.1) 56(84) bytes of data.
-     64 bytes from localhost (127.0.0.1): icmp_req=1 ttl=64 time=0.025 ms
-     64 bytes from localhost (127.0.0.1): icmp_req=2 ttl=64 time=0.051 ms
-
-  Finally, add an entry to your :ref:`configuration file <config>` in the
-  ``[vhosts]`` section::
-
-    [vhosts]
-    couchdb.local:5984 = /example
-    *.couchdb.local:5984 = /example
-
-  If your CouchDB is listening on the the default HTTP port (80), or is sitting
-  behind a proxy, then you don't need to specify a port number in the `vhost`
-  key.
-
-  The first line will rewrite the request to display the content of the
-  `example` database. This rule works only if the ``Host`` header is
-  ``couchdb.local`` and won't work for `CNAMEs`. The second rule, on the other
-  hand, matches all `CNAMEs` to `example` db, so that both `www.couchdb.local`
-  and `db.couchdb.local` will work.
-
-
-Rewriting Hosts to a Path
--------------------------
-
-Like in the :ref:`_rewrite <api/ddoc/rewrite>` handler you can match some
-variable and use them to create the target path. Some examples::
-
-  [vhosts]
-  *.couchdb.local = /*
-  :dbname. = /:dbname
-  :ddocname.:dbname.example.com = /:dbname/_design/:ddocname/_rewrite
-
-
-The first rule passes the wildcard as `dbname`. The second one does the same,
-but uses a variable name. And the third one allows you to use any URL with
-`ddocname` in any database with `dbname`.
-
-You could also change the default function to handle request by changing
-the setting :option:`httpd/redirect_vhost_handler`.

http://git-wip-us.apache.org/repos/asf/couchdb/blob/cdac7299/share/doc/src/config/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/index.rst b/share/doc/src/config/index.rst
deleted file mode 100644
index a9513c2..0000000
--- a/share/doc/src/config/index.rst
+++ /dev/null
@@ -1,34 +0,0 @@
-.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
-.. use this file except in compliance with the License. You may obtain a copy of
-.. the License at
-..
-..   http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-.. License for the specific language governing permissions and limitations under
-.. the License.
-
-.. _config:
-
-===================
-Configuring CouchDB
-===================
-
-.. toctree::
-   :maxdepth: 2
-
-   intro
-   couchdb
-   http
-   auth
-   compaction
-   logging
-   replicator
-   query-servers
-   externals
-   http-handlers
-   services
-   misc
-   proxying

http://git-wip-us.apache.org/repos/asf/couchdb/blob/cdac7299/share/doc/src/config/intro.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/intro.rst b/share/doc/src/config/intro.rst
deleted file mode 100644
index 835643a..0000000
--- a/share/doc/src/config/intro.rst
+++ /dev/null
@@ -1,181 +0,0 @@
-.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
-.. use this file except in compliance with the License. You may obtain a copy of
-.. the License at
-..
-..   http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-.. License for the specific language governing permissions and limitations under
-.. the License.
-
-.. default-domain:: config
-
-.. highlight:: ini
-
-.. _config/intro:
-
-=============================
-Introduction Into Configuring
-=============================
-
-Configuration files
--------------------
-
-.. warning::
-   The following section covering load order of config files
-   applies only to UNIX-ish systems.
-   For Windows, only the provided ``default.ini`` and ``local.ini``
-   files are relevant. These can of course have content
-   appended, which achieves the same type of functionality
-   as outlined for UNIX-ish systems below.
-
-By default, CouchDB reads configuration files from the following locations,
-in the following order:
-
-#. ``LOCALCONFDIR/default.ini``
-
-#. ``LOCALCONFDIR/default.d/*.ini``
-
-#. ``PLUGINS_DIR/*/priv/default.d/*.ini``
-
-#. ``LOCALCONFDIR/local.ini``
-
-#. ``LOCALCONFDIR/local.d/*.ini``
-
-The ``LOCALCONFDIR`` points to the directory that contains configuration files
-(``/usr/local/etc/couchdb`` by default). This variable may vary from the
-target operation system and may be changed during building from the source code.
-For binary distributions, it mostly points to the installation path
-(e.g. ``C:\Program Files\CouchDB\etc\couchdb`` for Windows).
-
-To see the actual configuration files chain run in shell::
-
-  couchdb -c
-
-This will print out all *actual* configuration files that will form the result
-CouchDB configuration::
-
-  /etc/couchdb/default.ini
-  /etc/couchdb/default.d/geocouch.ini
-  /etc/couchdb/local.ini
-  /etc/couchdb/local.d/geocouch.ini
-  /etc/couchdb/local.d/vendor.ini
-
-Settings in successive documents override the settings in earlier entries.
-For example, setting the :option:`httpd/bind_address` parameter in ``local.ini``
-would override any setting in ``default.ini``.
-
-.. warning::
-   The ``default.ini`` file may be overwritten during an upgrade or
-   re-installation, so localised changes should be made to the
-   ``local.ini`` file or files within the ``local.d`` directory.
-
-The configuration files chain may be changed by specifying additional sources
-by using next command line options:
-
-- ``-a``: adds configuration file to the chain
-- ``-A``: adds configuration directory to the chain
-
-Let's add these options and see how the configuration chain changes::
-
-  shell> couchdb -c -a /home/couchdb/custom.ini
-  /etc/couchdb/default.ini
-  /etc/couchdb/default.d/geocouch.ini
-  /etc/couchdb/local.ini
-  /etc/couchdb/local.d/geocouch.ini
-  /etc/couchdb/local.d/vendor.ini
-  /home/couchdb/custom.ini
-
-In case when `/home/couchdb/custom.ini` exists it will be added to
-the configuration chain.
-
-
-Parameter names and values
---------------------------
-
-All parameter names are *case-sensitive*. Every parameter takes a value of one
-of five types: `boolean`, `integer`, `string`, `tuple`_ and `proplist`_. Boolean
-values can be written as ``true`` or ``false``.
-
-Parameters with value type of `tuple` or `proplist` are following the Erlang
-requirement for style and naming.
-
-.. _proplist: http://www.erlang.org/doc/man/proplists.html
-.. _tuple: http://www.erlang.org/doc/reference_manual/data_types.html#id66049
-
-
-Setting parameters via the configuration file
----------------------------------------------
-
-The common way to set some parameters is to edit the `local.ini` file which is
-mostly located in the `etc/couchdb` directory relative your installation path
-root.
-
-For example::
-
-  ; This is a comment
-  [section]
-  param = value ; inline comments are allowed
-
-Each configuration file line may contains `section` definition, `parameter`
-specification, empty (space and newline characters only) or `commented` line.
-You can setup `inline` commentaries for `sections` or `parameters`.
-
-The `section` defines group of parameters that are belongs to some specific
-CouchDB subsystem. For instance, :section:`httpd` section holds not only HTTP
-server parameters, but also others that directly interacts with it.
-
-The `parameter` specification contains two parts divided by the `equal` sign
-(``=``): the parameter name on the left side and the parameter value on the
-right one. The leading and following whitespace for ``=`` is an optional to
-improve configuration readability.
-
-.. note::
-   In case when you'd like to remove some parameter from the `default.ini`
-   without modifying that file, you may override in `local.ini`, but
-   without any value::
-
-     [httpd_global_handlers]
-     _all_dbs =
-
-   This could be read as: "remove the `_all_dbs` parameter from
-   the `httpd_global_handlers` section if it was ever set before".
-
-
-The semicolon (``;``) signs about `commentary` start: everything after this
-character is counted as commentary and doesn't process by CouchDB.
-
-After editing of configuration file CouchDB server instance should be restarted
-to apply these changes.
-
-
-Setting parameters via the HTTP API
------------------------------------
-
-Alternatively, configuration parameters could be set via the
-:ref:`HTTP API <api/config>`. This API allows to change CouchDB configuration
-on-the-fly without requiring a server restart::
-
-  curl -X PUT http://localhost:5984/_config/uuids/algorithm -d '"random"'
-
-In the response the old parameter's value returns::
-
-  "sequential"
-
-You should be careful with changing configuration via the HTTP API since it's
-easy to make CouchDB unavailable. For instance, if you'd like to change the
-:option:`httpd/bind_address` for a new one::
-
-  curl -X PUT http://localhost:5984/_config/httpd/bind_address -d '"10.10.0.128"'
-
-However, if you make a typo, or the specified IP address is not available
-from your network, CouchDB will be unavailable for you in both cases and
-the only way to resolve this will be by remoting into the server, correcting
-the errant file, and restarting CouchDB. To protect yourself against such
-accidents you may set the :option:`httpd/config_whitelist` of permitted
-configuration parameters for updates via the HTTP API. Once this option is set,
-further changes to non-whitelisted parameters must take place via the
-configuration file, and in most cases, also requires a server restart before
-hand-edited options take effect.

http://git-wip-us.apache.org/repos/asf/couchdb/blob/cdac7299/share/doc/src/config/logging.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/logging.rst b/share/doc/src/config/logging.rst
deleted file mode 100644
index 086749f..0000000
--- a/share/doc/src/config/logging.rst
+++ /dev/null
@@ -1,94 +0,0 @@
-.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
-.. use this file except in compliance with the License. You may obtain a copy of
-.. the License at
-..
-..   http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-.. License for the specific language governing permissions and limitations under
-.. the License.
-
-.. default-domain:: config
-
-.. highlight:: ini
-
-=======
-Logging
-=======
-
-.. _config/log:
-
-Logging options
-================
-
-.. config:section:: log :: Logging options
-
-  CouchDB logging configuration.
-
-  .. config:option:: file :: Logging file path
-
-    Specifies the location of file for logging output::
-
-      [log]
-      file = /var/log/couchdb/couch.log
-
-    This path should be readable and writable for user that runs CouchDB service
-    (`couchdb` by default).
-
-
-  .. config:option:: level :: Logging verbose level
-
-    .. versionchanged:: 1.3: Added ``warning`` level.
-
-    Logging level defines how verbose and detailed logging will be::
-
-      [log]
-      level = info
-
-    Available levels:
-
-    - ``debug``: Very informative and detailed debug logging. Includes HTTP
-      headers, external processes communications, authorization information and
-      more;
-    - ``info``: Informative logging. Includes HTTP requests headlines, startup
-      of an external processes etc.
-    - ``warning``: Warning messages are alerts about edge situations that may
-      lead to errors. For instance, compaction daemon alerts about low or
-      insufficient disk space at this level.
-    - ``error``: Error level includes only things that going wrong, crush
-      reports and HTTP error responses (5xx codes).
-    - ``none``: Disables logging any messages.
-
-
-  .. config:option:: include_sasl
-
-    Includes `SASL`_ information in logs::
-
-      [log]
-      include_sasl = true
-
-    .. _SASL: http://www.erlang.org/doc/apps/sasl/
-
-
-.. _config/log_level_by_module:
-
-Per module logging
-==================
-
-.. config:section:: log_level_by_module :: Per module logging
-
-  .. versionadded:: 1.3
-
-  In this section you can specify :option:`log level <log/level>` on a
-  per-module basis::
-
-    [log_level_by_module]
-    couch_httpd = debug
-    couch_replicator = info
-    couch_query_servers = error
-
-  See `src/*/*.erl`_ for available modules.
-
-  .. _src/*/*.erl: https://git-wip-us.apache.org/repos/asf?p=couchdb.git;a=tree;f=src;hb=HEAD

http://git-wip-us.apache.org/repos/asf/couchdb/blob/cdac7299/share/doc/src/config/misc.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/misc.rst b/share/doc/src/config/misc.rst
deleted file mode 100644
index e97575a..0000000
--- a/share/doc/src/config/misc.rst
+++ /dev/null
@@ -1,258 +0,0 @@
-.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
-.. use this file except in compliance with the License. You may obtain a copy of
-.. the License at
-..
-..   http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-.. License for the specific language governing permissions and limitations under
-.. the License.
-
-.. default-domain:: config
-
-.. highlight:: ini
-
-========================
-Miscellaneous Parameters
-========================
-
-.. _config/attachments:
-
-Configuration of Attachment Storage
-===================================
-
-.. config:section:: attachments :: Configuration of Attachment Storage
-
-  .. config:option:: compression_level
-    
-    Defines zlib compression level for the attachments from ``1`` (lowest,
-    fastest) to ``9`` (highest, slowest). A value of ``0`` disables compression
-
-    ::
-    
-      [attachments]
-      compression_level = 8
-    
-
-  .. config:option:: compressible_types
-    
-    Since compression is ineffective for some types of files, it is possible
-    to let CouchDB compress only some types of attachments, specified by their
-    MIME type::
-    
-      [attachments]
-      compressible_types = text/*, application/javascript, application/json, application/xml
-
-
-.. _config/stats:
-
-Statistic Calculation
-=====================
-
-.. config:section:: stats :: Statistic Calculation
-  
-  
-  .. config:option:: rate
-    
-    Rate of statistics gathering in milliseconds::
-    
-      [stats]
-      rate = 1000
-
-    
-  .. config:option:: samples
-    
-    Samples are used to track the mean and standard value deviation within
-    specified intervals (in seconds)::
-    
-      [stats]
-      samples = [0, 60, 300, 900]
-
-
-.. _config/uuids:
-
-UUIDs Configuration
-===================
-
-.. config:section:: uuids :: UUIDs Configuration
-
-  .. config:option:: algorithm :: Generation Algorithm
-
-    .. versionchanged:: 1.3 Added ``utc_id`` algorithm.
-
-    CouchDB provides various algorithms to generate the UUID values that are
-    used for document `_id`'s by default::
-
-      [uuids]
-      algorithm = sequential
-
-    Available algorithms:
-
-    - ``random``: 128 bits of random awesome. All awesome, all the time:
-
-      .. code-block:: javascript
-
-        {
-          "uuids": [
-            "5fcbbf2cb171b1d5c3bc6df3d4affb32",
-            "9115e0942372a87a977f1caf30b2ac29",
-            "3840b51b0b81b46cab99384d5cd106e3",
-            "b848dbdeb422164babf2705ac18173e1",
-            "b7a8566af7e0fc02404bb676b47c3bf7",
-            "a006879afdcae324d70e925c420c860d",
-            "5f7716ee487cc4083545d4ca02cd45d4",
-            "35fdd1c8346c22ccc43cc45cd632e6d6",
-            "97bbdb4a1c7166682dc026e1ac97a64c",
-            "eb242b506a6ae330bda6969bb2677079"
-          ]
-        }
-
-    - ``sequential``: Monotonically increasing ids with random increments.
-      The first 26 hex characters are random, the last 6 increment in random
-      amounts until an overflow occurs. On overflow, the random prefix is
-      regenerated and the process starts over.
-
-      .. code-block:: javascript
-
-        {
-          "uuids": [
-            "4e17c12963f4bee0e6ec90da54804894",
-            "4e17c12963f4bee0e6ec90da5480512f",
-            "4e17c12963f4bee0e6ec90da54805c25",
-            "4e17c12963f4bee0e6ec90da54806ba1",
-            "4e17c12963f4bee0e6ec90da548072b3",
-            "4e17c12963f4bee0e6ec90da54807609",
-            "4e17c12963f4bee0e6ec90da54807718",
-            "4e17c12963f4bee0e6ec90da54807754",
-            "4e17c12963f4bee0e6ec90da54807e5d",
-            "4e17c12963f4bee0e6ec90da54808d28"
-          ]
-        }
-
-    - ``utc_random``: The time since Jan 1, 1970 UTC, in microseconds. The first
-      14 characters are the time in hex. The last 18 are random.
-
-      .. code-block:: javascript
-
-        {
-          "uuids": [
-            "04dd32b3af699659b6db9486a9c58c62",
-            "04dd32b3af69bb1c2ac7ebfee0a50d88",
-            "04dd32b3af69d8591b99a8e86a76e0fb",
-            "04dd32b3af69f4a18a76efd89867f4f4",
-            "04dd32b3af6a1f7925001274bbfde952",
-            "04dd32b3af6a3fe8ea9b120ed906a57f",
-            "04dd32b3af6a5b5c518809d3d4b76654",
-            "04dd32b3af6a78f6ab32f1e928593c73",
-            "04dd32b3af6a99916c665d6bbf857475",
-            "04dd32b3af6ab558dd3f2c0afacb7d66"
-          ]
-        }
-
-    - ``utc_id``: The time since Jan 1, 1970 UTC, in microseconds, plus
-      the ``utc_id_suffix`` string. The first 14 characters are the time in hex.
-      The :option:`uuids/utc_id_suffix` string value is appended to these.
-
-      .. code-block:: javascript
-
-        {
-          "uuids": [
-            "04dd32bd5eabcc@mycouch",
-            "04dd32bd5eabee@mycouch",
-            "04dd32bd5eac05@mycouch",
-            "04dd32bd5eac28@mycouch",
-            "04dd32bd5eac43@mycouch",
-            "04dd32bd5eac58@mycouch",
-            "04dd32bd5eac6e@mycouch",
-            "04dd32bd5eac84@mycouch",
-            "04dd32bd5eac98@mycouch",
-            "04dd32bd5eacad@mycouch"
-          ]
-        }
-
-    .. note::
-
-       **Impact of UUID choices:** the choice of UUID has a significant impact
-       on the layout of the B-tree, prior to compaction.
-
-       For example, using a sequential UUID algorithm while uploading a large
-       batch of documents will avoid the need to rewrite many intermediate
-       B-tree nodes. A random UUID algorithm may require rewriting intermediate
-       nodes on a regular basis, resulting in significantly decreased throughput
-       and wasted disk space space due to the append-only B-tree design.
-
-       It is generally recommended to set your own UUIDs, or use the sequential
-       algorithm unless you have a specific need and take into account
-       the likely need for compaction to re-balance the B-tree and reclaim
-       wasted space.
-  
-
-  .. config:option:: utc_id_suffix :: UTC ID Suffix
-
-    .. versionadded:: 1.3
-
-    The ``utc_id_suffix`` value will be appended to UUIDs generated by the
-    ``utc_id`` algorithm. Replicating instances should have unique
-    ``utc_id_suffix`` values to ensure uniqueness of ``utc_id`` ids.
-
-    ::
-
-      [uuid]
-      utc_id_suffix = my-awesome-suffix
-
-  .. config:option:: max_count :: Per-Request UUID Limit
-
-    .. versionadded:: 1.5.1
-
-    No more than this number of UUIDs will be sent in a single request. If
-    more UUIDs are requested, an HTTP error response will be thrown.
-
-    ::
-
-      [uuid]
-      max_count = 1000
-
-
-.. _config/vendor:
-
-Vendor information
-==================
-
-.. config:section:: vendor :: Vendor information
-
-  .. versionadded:: 1.3
-
-  CouchDB distributors have the option of customizing CouchDB's welcome
-  message. This is returned when requesting ``GET /``.
-
-  ::
-
-    [vendor]
-    name = The Apache Software Foundation
-    version = 1.5.0
-
-.. _config/csp:
-
-Content-Security-Policy
-=======================
-
-.. config:section:: csp :: Content-Security-Policy
-
-  Experimental support of CSP Headers for ``/_utils`` (Fauxton).
-
-  .. config:option:: enable
-
-    Enable the sending of the Header ``Content-Security-Policy``::
-
-      [csp]
-      enable = true
-
-
-  .. config:option:: header_value
-
-    You can change the default value for the Header which is sent::
-
-      [csp]
-      header_value = default-src 'self'; img-src *; font-src *;

http://git-wip-us.apache.org/repos/asf/couchdb/blob/cdac7299/share/doc/src/config/proxying.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/proxying.rst b/share/doc/src/config/proxying.rst
deleted file mode 100644
index 863311e..0000000
--- a/share/doc/src/config/proxying.rst
+++ /dev/null
@@ -1,98 +0,0 @@
-.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
-.. use this file except in compliance with the License. You may obtain a copy of
-.. the License at
-..
-..   http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-.. License for the specific language governing permissions and limitations under
-.. the License.
-
-.. highlight:: ini
-
-.. _config/proxy:
-
-======================
-Proxying Configuration
-======================
-
-.. _http-proxying:
-.. _config/proxy/couchdb:
-
-CouchDB As Proxy
-================
-
-The HTTP proxy feature makes it easy to map and redirect different
-content through your CouchDB URL. The proxy works by mapping a pathname
-and passing all content after that prefix through to the configured
-proxy address.
-
-Configuration of the proxy redirect is handled through the
-``[httpd_global_handlers]`` section of the CouchDB configuration file
-(typically ``local.ini``). The format is::
-
-  [httpd_global_handlers]
-  PREFIX = {couch_httpd_proxy, handle_proxy_req, <<"DESTINATION">>}
-
-
-Where:
-
--  ``PREFIX``
-
-   Is the string that will be matched. The string can be any valid
-   qualifier, although to ensure that existing database names are not
-   overridden by a proxy configuration, you can use an underscore
-   prefix.
-
--  ``DESTINATION``
-
-   The fully-qualified URL to which the request should be sent. The
-   destination must include the ``http`` prefix. The content is used
-   verbatim in the original request, so you can also forward to servers
-   on different ports and to specific paths on the target host.
-
-The proxy process then translates requests of the form:
-
-.. code-block:: text
-
-    http://couchdb:5984/PREFIX/path
-
-To:
-
-.. code-block:: text
-
-    DESTINATION/path
-
-.. note::
-   Everything after ``PREFIX`` including the required forward slash
-   will be appended to the ``DESTINATION``.
-
-The response is then communicated back to the original client.
-
-For example, the following configuration::
-
-  [httpd_global_handlers]
-  _google = {couch_httpd_proxy, handle_proxy_req, <<"http://www.google.com">>}
-
-Would forward all requests for ``http://couchdb:5984/_google`` to the
-Google website.
-
-The service can also be used to forward to related CouchDB services,
-such as `Lucene`::
-
-  [httpd_global_handlers]
-  _fti = {couch_httpd_proxy, handle_proxy_req, <<"http://127.0.0.1:5985">>}
-
-.. note::
-   The proxy service is basic. If the request is not identified by the
-   ``DESTINATION``, or the remainder of the ``PATH`` specification is
-   incomplete, the original request URL is interpreted as if the
-   ``PREFIX`` component of that URL does not exist.
-
-   For example, requesting ``http://couchdb:5984/_intranet/media`` when
-   ``/media`` on the proxy destination does not exist, will cause the
-   request URL to be interpreted as ``http://couchdb:5984/media``. Care
-   should be taken to ensure that both requested URLs and destination
-   URLs are able to cope.

http://git-wip-us.apache.org/repos/asf/couchdb/blob/cdac7299/share/doc/src/config/query-servers.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/query-servers.rst b/share/doc/src/config/query-servers.rst
deleted file mode 100644
index 88fab82..0000000
--- a/share/doc/src/config/query-servers.rst
+++ /dev/null
@@ -1,161 +0,0 @@
-.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
-.. use this file except in compliance with the License. You may obtain a copy of
-.. the License at
-..
-..   http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-.. License for the specific language governing permissions and limitations under
-.. the License.
-
-.. highlight:: ini
-
-=============
-Query Servers
-=============
-
-.. _config/query_servers:
-
-Query Servers Definition
-========================
-
-.. config:section:: query_servers :: Query Servers Definition
-
-  .. versionchanged:: 1.2: Added CoffeeScript query server
-
-  CouchDB delegates computation of :ref:`design documents <ddocs>` functions to
-  external query servers. The external query server is a special OS process which
-  communicates with CouchDB over standard input/output using a very simple
-  line-based protocol with JSON messages.
-
-  The external query server may be defined in configuration file following next
-  pattern::
-
-    [query_servers]
-    LANGUAGE = PATH ARGS
-
-  Where:
-
-  - ``LANGUAGE``: is a programming language which code this query server may
-    execute. For instance, there are `python`, `ruby`, `clojure` and other query
-    servers in wild. This value is also used for `ddoc` field ``language``
-    to determine which query server processes the functions.
-
-    Note, that you may setup multiple query servers for the same programming
-    language, but you have to name them different (like `python-dev` etc.).
-
-  - ``PATH``: is a system path to the executable binary program that runs the
-    query server.
-
-  - ``ARGS``: optionally, you may specify additional command line arguments for
-    the executable ``PATH``.
-
-  The default query server is written in :ref:`JavaScript <query-server/js>`,
-  running via `Mozilla SpiderMonkey`_::
-
-    [query_servers]
-    javascript = /usr/bin/couchjs /usr/share/couchdb/server/main.js
-    coffeescript = /usr/bin/couchjs /usr/share/couchdb/server/main-coffee.js
-
-
-  .. _Mozilla SpiderMonkey: https://developer.mozilla.org/en/docs/SpiderMonkey
-
-  .. seealso::
-     :ref:`Native Erlang Query Server <config/native_query_servers>` that allows
-     to process Erlang `ddocs` and runs within CouchDB bypassing stdio
-     communication and JSON serialization/deserialization round trip overhead.
-
-
-.. _config/query_server_config:
-
-Query Servers Configuration
-===========================
-
-.. config:section:: query_server_config :: Query Servers Configuration
-
-
-  .. config:option:: commit_freq :: View index commit delay
-
-    Specifies the delay in seconds before view index changes are committed to disk.
-    The default value is ``5``::
-
-      [query_server_config]
-      commit_freq = 5
-
-
-  .. config:option:: os_process_limit :: Query Server operation timeout
-
-    Amount of time in seconds that the Query Server may process CouchDB command::
-
-      [query_server_config]
-      os_process_limit = 10
-
-    CouchDB will raise `os_process_timeout` error and kill the process in case the
-    Query Server doesn't return any result within this limit.
-
-
-  .. config:option:: reduce_limit :: Reduce limit control
-
-    Controls `Reduce overflow` error that raises when output of
-    :ref:`reduce functions <reducefun>` is too big::
-
-      [query_server_config]
-      reduce_limit = true
-
-    Normally, you don't have to disable (by setting ``false`` value) this option
-    since main propose of `reduce` functions is to *reduce* the input.
-
-
-.. _config/native_query_servers:
-
-Native Erlang Query Server
-==========================
-
-.. config:section:: native_query_servers :: Native Erlang Query Server
-
-  .. warning::
-
-     Due to security restrictions, the Erlang query server is disabled by
-     default.
-
-     Unlike the JavaScript query server, the Erlang one does not runs in a sandbox
-     mode. This means that Erlang code has full access to your OS,
-     filesystem and network, which may lead to security issues. While Erlang
-     functions are faster than JavaScript ones, you need to be careful
-     about running them, especially if they were written by someone else.
-
-  CouchDB has a native Erlang query server, allowing you to write your map/reduce
-  functions in Erlang.
-
-  First, you'll need to edit your `local.ini` to include a
-  ``[native_query_servers]`` section::
-
-    [native_query_servers]
-    erlang = {couch_native_process, start_link, []}
-
-  To see these changes you will also need to restart the server.
-  To test out using :ref:`Erlang views <query-server/erlang>`, visit the
-  `Futon` admin interface, create a new database and open a temporary view.
-  You should now be able to select ``erlang`` from the language drop-down.
-
-  Let's try an example of map/reduce functions which count the total documents at
-  each number of revisions (there are x many documents at version "1", and y
-  documents at "2"... etc). Add a few documents to the database, then enter the
-  following functions as a temporary view:
-
-  .. code-block:: erlang
-
-    %% Map Function
-    fun({Doc}) ->
-      <<K,_/binary>> = proplists:get_value(<<"_rev">>, Doc, null),
-      V = proplists:get_value(<<"_id">>, Doc, null),
-      Emit(<<K>>, V)
-    end.
-
-    %% Reduce Function
-    fun(Keys, Values, ReReduce) -> length(Values) end.
-
-  If all has gone well, after running the view you should see a list of the total
-  number of documents at each revision number.

http://git-wip-us.apache.org/repos/asf/couchdb/blob/cdac7299/share/doc/src/config/replicator.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/replicator.rst b/share/doc/src/config/replicator.rst
deleted file mode 100644
index 388491c..0000000
--- a/share/doc/src/config/replicator.rst
+++ /dev/null
@@ -1,200 +0,0 @@
-.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
-.. use this file except in compliance with the License. You may obtain a copy of
-.. the License at
-..
-..   http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-.. License for the specific language governing permissions and limitations under
-.. the License.
-
-.. highlight:: ini
-
-==========
-Replicator
-==========
-
-.. _config/replicator:
-
-Replicator Database Configuration
-=================================
-
-.. config:section:: replicator :: Replicator Database Configuration
-
-  .. versionadded:: 1.2
-
-
-  .. config:option:: db
-
-    Specifies replicator database name::
-
-      [replicator]
-      db = _replicator
-
-
-
-  .. config:option:: max_replication_retry_count
-
-    Maximum replication retry count can be a non-negative integer or "infinity"
-    ::
-
-      [replicator]
-      max_replication_retry_count = 10
-
-
-
-  .. config:option:: worker_batch_size
-
-    With lower batch sizes checkpoints are done more frequently. Lower batch
-    sizes also reduce the total amount of used RAM memory::
-
-      [replicator]
-      worker_batch_size = 500
-
-
-
-  .. config:option:: worker_processes
-
-    More worker processes can give higher network throughput but can also imply
-    more disk and network IO::
-
-      [replicator]
-      worker_processes = 4
-
-
-
-  .. config:option:: http_connections
-
-    Maximum number of HTTP connections per replication::
-
-      [replicator]
-      http_connections = 20
-
-
-
-  .. config:option:: connection_timeout
-
-    HTTP connection timeout per replication.
-    Even for very fast/reliable networks it might need to be increased if
-    a remote database is too busy::
-
-      [replicator]
-      connection_timeout = 30000
-
-
-
-  .. config:option:: retries_per_request
-
-    If a request fails, the replicator will retry it up to N times::
-
-      [replicator]
-      retries_per_request = 10
-
-
-
-  .. config:option:: socket_options
-
-    Some socket options that might boost performance in some scenarios:
-
-    - ``{nodelay, boolean()}``
-    - ``{sndbuf, integer()}``
-    - ``{recbuf, integer()}``
-    - ``{priority, integer()}``
-
-    See the `inet`_ Erlang module's man page for the full list of options::
-
-      [replicator]
-      socket_options = [{keepalive, true}, {nodelay, false}]
-
-    .. _inet: http://www.erlang.org/doc/man/inet.html#setopts-2
-
-
-  .. config:option:: checkpoint_interval
-
-    .. versionadded:: 1.6
-
-    Defines replication checkpoint interval in milliseconds. :ref:`Replicator
-    <replicator>` will :get:`requests </{db}>` from the Source database at
-    the specified interval::
-
-      [replicator]
-      checkpoint_interval = 5000
-
-    Lower intervals may be useful for frequently changing data, while higher
-    values will lower bandwidth and make fewer requests for infrequently
-    updated databases.
-
-
-  .. config:option:: use_checkpoints
-
-     .. versionadded:: 1.6
-
-     If ``use_checkpoints`` is set to ``true``, CouchDB will make checkpoints
-     during replication and at the completion of replication. CouchDB can
-     efficiently resume replication from any of these checkpoints::
-
-      [replicator]
-      use_checkpoints = true
-
-     .. note:: Checkpoints are stored in :ref:`local documents <api/local>`
-        on both the source and target databases (which requires write access).
-
-     .. warning:: Disabling checkpoints is **not recommended** as CouchDB
-        will scan the Source database's changes feed from the beginning.
-
-
-  .. config:option:: cert_file
-
-    Path to a file containing the user's certificate::
-
-      [replicator]
-      cert_file = /full/path/to/server_cert.pem
-
-
-
-  .. config:option:: key_file
-
-    Path to file containing user's private PEM encoded key::
-
-      [replicator]
-      key_file = /full/path/to/server_key.pem
-
-
-
-  .. config:option:: password
-
-    String containing the user's password. Only used if the private keyfile is
-    password protected::
-
-      [replicator]
-      password = somepassword
-
-
-
-  .. config:option:: verify_ssl_certificates
-
-    Set to true to validate peer certificates::
-
-      [replicator]
-      verify_ssl_certificates = false
-
-
-
-  .. config:option:: ssl_trusted_certificates_file
-
-    File containing a list of peer trusted certificates (in the PEM format)::
-
-      [replicator]
-      ssl_trusted_certificates_file = /etc/ssl/certs/ca-certificates.crt
-
-
-
-  .. config:option:: ssl_certificate_max_depth
-
-    Maximum peer certificate depth (must be set even if certificate validation
-    is off)::
-
-      [replicator]
-      ssl_certificate_max_depth = 3

http://git-wip-us.apache.org/repos/asf/couchdb/blob/cdac7299/share/doc/src/config/services.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/services.rst b/share/doc/src/config/services.rst
deleted file mode 100644
index 9e06e03..0000000
--- a/share/doc/src/config/services.rst
+++ /dev/null
@@ -1,150 +0,0 @@
-.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
-.. use this file except in compliance with the License. You may obtain a copy of
-.. the License at
-..
-..   http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-.. License for the specific language governing permissions and limitations under
-.. the License.
-
-.. highlight:: ini
-
-=========================
-CouchDB Internal Services
-=========================
-
-
-.. _config/daemons:
-
-CouchDB Daemonized Mini Apps
-============================
-
-.. config:section:: daemons :: CouchDB Daemonized Mini Apps
-
-
-  .. config:option:: auth_cache
-
-    This daemon provides authentication caching to avoid repeated opening and
-    closing of the `_users` database for each request requiring authentication::
-
-      [daemons]
-      auth_cache={couch_auth_cache, start_link, []}
-
-
-
-  .. config:option:: compaction_daemon
-
-    :ref:`Automatic compaction <config/compactions>` daemon::
-
-      [daemons]
-      compaction_daemon={couch_compaction_daemon, start_link, []}
-
-
-
-  .. config:option:: external_manager
-
-    `External` processes manager::
-
-      [daemons]
-      external_manager={couch_external_manager, start_link, []}
-
-
-
-  .. config:option:: httpd
-
-    HTTP server daemon::
-
-      [daemons]
-      httpd={couch_httpd, start_link, []}
-
-
-
-  .. config:option:: httpsd
-
-    Provides :ref:`SSL support <config/ssl>`. The default ssl port CouchDB
-    listens on is `6984`::
-
-      [daemons]
-      httpsd = {couch_httpd, start_link, [https]}
-
-
-
-
-  .. config:option:: index_server
-
-    The `couch_index` application is responsible for managing all of the
-    different types of indexers. This manages the process handling for
-    keeping track of the index state as well as managing the updater and
-    compactor handling::
-
-      [daemons]
-      index_server={couch_index_server, start_link, []}
-
-
-
-  .. config:option:: os_daemons
-
-    :ref:`OS Daemons <config/os_daemons>` manager::
-
-      [daemons]
-      os_daemons={couch_os_daemons, start_link, []}
-
-
-
-  .. config:option:: query_servers
-
-    :ref:`Query servers <config/query_servers>` manager::
-
-      [daemons]
-      query_servers={couch_query_servers, start_link, []}
-
-
-
-  .. config:option:: replicator_manager
-
-    Replications manager::
-
-      [daemons]
-      replicator_manager={couch_replicator_manager, start_link, []}
-
-
-
-  .. config:option:: stats_aggregator
-
-    Runtime statistics aggregator::
-
-      [daemons]
-      stats_aggregator={couch_stats_aggregator, start, []}
-
-
-
-  .. config:option:: stats_collector
-
-    Runtime statistics collector::
-
-      [daemons]
-      stats_collector={couch_stats_collector, start, []}
-
-
-
-  .. config:option:: uuids
-
-    :ref:`UUIDs <config/uuids>` generator daemon::
-
-      [daemons]
-      uuids={couch_uuids, start, []}
-
-
-
-  .. config:option:: vhosts
-
-    :ref:`Virtual hosts <config/vhosts>` manager. Provides dynamic add of vhosts
-    without restart, wildcards support and dynamic routing via pattern matching
-    ::
-
-      [daemons]
-      vhosts={couch_httpd_vhost, start_link, []}
-

http://git-wip-us.apache.org/repos/asf/couchdb/blob/cdac7299/share/doc/src/contents.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/contents.rst b/share/doc/src/contents.rst
deleted file mode 100644
index 4395f92..0000000
--- a/share/doc/src/contents.rst
+++ /dev/null
@@ -1,40 +0,0 @@
-.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
-.. use this file except in compliance with the License. You may obtain a copy of
-.. the License at
-..
-..   http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-.. License for the specific language governing permissions and limitations under
-.. the License.
-
-
-|Apache CouchDB(TM)|_ |release| Documentation
-=============================================
-
-.. toctree::
-    :maxdepth: 3
-    :numbered: 3
-
-    intro/index
-    install/index
-    config/index
-    replication/index
-    maintenance/index
-    couchapp/index
-    externals
-    query-server/index
-    fauxton/index
-    api/index
-    json-structure
-    experimental
-    contributing
-    whatsnew/index
-    cve/index
-    about
-
-.. This is how you get a TM sign into a link. Haha. Seriously.
-.. |Apache CouchDB(TM)| unicode:: Apache U+0020 CouchDB U+2122
-.. _Apache CouchDB(TM): http://couchdb.apache.org/

http://git-wip-us.apache.org/repos/asf/couchdb/blob/cdac7299/share/doc/src/contributing.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/contributing.rst b/share/doc/src/contributing.rst
deleted file mode 100644
index edc20d5..0000000
--- a/share/doc/src/contributing.rst
+++ /dev/null
@@ -1,167 +0,0 @@
-.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
-.. use this file except in compliance with the License. You may obtain a copy of
-.. the License at
-..
-..   http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-.. License for the specific language governing permissions and limitations under
-.. the License.
-
-.. _contributing:
-
-==================================
-Contributing to this Documentation
-==================================
-
-The documentation lives in the CouchDB source tree. We'll start by forking and
-closing the CouchDB GitHub mirror. That will allow us to send the contribution
-to CouchDB with a pull request.
-
-If you don't have a GitHub account yet, it is a good time to get one, they are
-free. If you don't want to use GitHub, there are alternate ways to
-contributing back, that we'll cover next time.
-
-Go to https://github.com/apache/couchdb and click the "fork" button in the top
-right. This will create a fork of CouchDB in your GitHub account. Mine is
-`janl`, so my fork lives at https://github.com/janl/couchdb. In the header, it
-tells me me my "GitHub Clone URL". We need to copy that and start a terminal:
-
-.. code-block:: bash
-
-    $ git clone https://github.com/janl/couchdb.git
-    $ cd couchdb
-    $ subl .
-
-I'm opening the whole CouchDB source tree in my favourite editor. It gives
-me the usual directory listing:
-
-.. code-block:: bash
-
-    .git/
-    .gitignore
-    .mailmap
-    .travis.yml
-    AUTHORS
-    BUGS
-    CHANGES
-    DEVELOPERS
-    INSTALL
-    INSTALL.Unix
-    INSTALL.Windows
-    LICENSE
-    Makefile.am
-    NEWS
-    NOTICE
-    README
-    THANKS.in
-    acinclude.m4.in
-    bin/
-    bootstrap
-    build-aux/
-    configure.ac
-    etc/
-    license.skip
-    share/
-    src/
-    test/
-    utils/
-    var/
-
-The documentation sources live in `share/doc/src`, you can safely ignore all
-the other files and directories.
-
-First we should determine where we want to document this inside the
-documentation. We can look through http://docs.couchdb.org/en/latest/
-for inspiration. The `JSON Structure Reference`_ looks like a fine place to write this up.
-
-.. _JSON Structure Reference: http://docs.couchdb.org/en/latest/json-structure.html
-
-The current state includes mostly tables describing the JSON structure (after
-all, that's the title of this chapter), but some prose about the number
-representation can't hurt. For future reference, since the topic in the thread
-includes views and different encoding in views (as opposed to the storage
-engine), we should remember to make a note in the views documentation as well,
-but we'll leave this for later.
-
-Let's try and find the source file that builds the file
-http://docs.couchdb.org/en/latest/json-structure.html -- we are in luck, under
-`share/doc/src` we find the file `json-structure.rst`. That looks promising.
-`.rst` stands for ReStructured Text (see
-http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
-for a markup reference), which is an ascii format for writing
-documents, documentation in this case. Let's have a look and open it.
-
-We see ascii tables with some additional formatting, all looking like the
-final HTML. So far so easy. For now, let's just add to the bottom of this. We
-can worry about organising this better later.
-
-We start by adding a new headline::
-
-    Number Handling
-    ===============
-
-Now we paste in the rest of the main email of the thread. It is mostly text,
-but it includes some code listings. Let's mark them up. We'll turn::
-
-    ejson:encode(ejson:decode(<<"1.1">>)).
-    <<"1.1000000000000000888">>
-
-Into::
-
-    .. code-block:: erlang
-        
-      ejson:encode(ejson:decode(<<"1.1">>)).
-      <<"1.1000000000000000888">>
-
-And we follow along with the other code samples. We turn::
-
-    Spidermonkey
-
-    $ js -h 2>&1 | head -n 1
-    JavaScript-C 1.8.5 2011-03-31
-    $ js
-    js> JSON.stringify(JSON.parse("1.01234567890123456789012345678901234567890"))
-    "1.0123456789012346"
-    js> var f = JSON.stringify(JSON.parse("1.01234567890123456789012345678901234567890"))
-    js> JSON.stringify(JSON.parse(f))
-    "1.0123456789012346"
-
-into::
-
-    Spidermonkey::
-
-        $ js -h 2>&1 | head -n 1
-        JavaScript-C 1.8.5 2011-03-31
-        $ js
-        js> JSON.stringify(JSON.parse("1.01234567890123456789012345678901234567890"))
-        "1.0123456789012346"
-        js> var f = JSON.stringify(JSON.parse("1.01234567890123456789012345678901234567890"))
-        js> JSON.stringify(JSON.parse(f))
-        "1.0123456789012346"
-
-And then follow all the other ones.
-
-I cleaned up the text a little but to make it sound more like a documentation
-entry as opposed to a post on a mailing list.
-
-The next step would be to validate that we got all the markup right. I'll
-leave this for later. For now we'll contribute our change back to CouchDB.
-
-First, we commit our changes::
-
-    $ > git commit -am 'document number encoding'
-    [master a84b2cf] document number encoding
-    1 file changed, 199 insertions(+)
-
-Then we push the commit to our CouchDB fork::
-
-    $ git push origin master
-
-Next, we go back to our GitHub page https://github.com/janl/couchdb and click
-the "Pull Request" button. Fill in the description with something useful and
-hit the "Send Pull Request" button.
-
-And we're done!


Mime
View raw message