Return-Path: X-Original-To: apmail-couchdb-commits-archive@www.apache.org Delivered-To: apmail-couchdb-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 2E31111E19 for ; Thu, 10 Jul 2014 09:47:03 +0000 (UTC) Received: (qmail 2468 invoked by uid 500); 10 Jul 2014 09:47:01 -0000 Delivered-To: apmail-couchdb-commits-archive@couchdb.apache.org Received: (qmail 2337 invoked by uid 500); 10 Jul 2014 09:47:01 -0000 Mailing-List: contact commits-help@couchdb.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@couchdb.apache.org Delivered-To: mailing list commits@couchdb.apache.org Received: (qmail 1732 invoked by uid 99); 10 Jul 2014 09:47:01 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 10 Jul 2014 09:47:01 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id CFC529AA9A7; Thu, 10 Jul 2014 09:47:00 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: rnewson@apache.org To: commits@couchdb.apache.org Date: Thu, 10 Jul 2014 09:47:16 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [17/50] documentation commit: updated refs/heads/import-master to fe7f7bf docs: clarify that .d and multiple .ini files only apply to unix - closes COUCHDB-2104 Thanks Ole Johan for reporting this Project: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/commit/72eaf489 Tree: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/tree/72eaf489 Diff: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/diff/72eaf489 Branch: refs/heads/import-master Commit: 72eaf489680e7153a12046c03e091606fb03fe02 Parents: 62df84e Author: Dave Cottlehuber Authored: Wed Mar 26 21:12:19 2014 +0100 Committer: Dave Cottlehuber Committed: Wed Mar 26 21:12:19 2014 +0100 ---------------------------------------------------------------------- src/config/intro.rst | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/72eaf489/src/config/intro.rst ---------------------------------------------------------------------- diff --git a/src/config/intro.rst b/src/config/intro.rst index c528f74..835643a 100644 --- a/src/config/intro.rst +++ b/src/config/intro.rst @@ -23,6 +23,14 @@ 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: @@ -148,7 +156,7 @@ Setting parameters via the HTTP API Alternatively, configuration parameters could be set via the :ref:`HTTP API `. This API allows to change CouchDB configuration -on-fly without need for server restart:: +on-the-fly without requiring a server restart:: curl -X PUT http://localhost:5984/_config/uuids/algorithm -d '"random"' @@ -157,16 +165,17 @@ 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, you'd like to change the -:option:`httpd/bind_address` for new one:: +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 would made a typo or the specified IP address is not available -from your network, you'll make CouchDB unavailable for you in both cases and -you will have the only way to fix the problem by edit the configuration file -and restart the server. To protect yourself against such accidents you may -setup the :option:`httpd/config_whitelist` of configuration parameters that -are allowed to edit via the HTTP API. For others you'll need to directly edit -the configuration file so you may quick fix any problems that had occurred due -to misconfiguring. +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.