couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vatam...@apache.org
Subject [3/6] documentation commit: updated refs/heads/master to 3a2eadb
Date Wed, 08 Mar 2017 02:16:57 GMT
Fix the config option name and descriptions

- Re-word description of X-Auth-CouchDB-Roles header to be less awkward.  As
  previously worded, it was a list of N items with a single comma, which
  clearly makes no sense.  I reworded it to be less ambiguously a
  comma-separated listed.
- <force token to be required> was formatted as a config option.  Instead, I
  reworded the description to use the acutal config option,
  <proxy_use_secret>,
- Reword description of X-Auth-CouchDB-Token to make it clear that the
  header itself is not optional, but rather that the config option requiring
  it is optional.


Project: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/commit/5134e9cb
Tree: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/tree/5134e9cb
Diff: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/diff/5134e9cb

Branch: refs/heads/master
Commit: 5134e9cb0f11e14c0929472c8d84a2422b8f0e75
Parents: f8f7f47
Author: Jonathan Hall <flimzy@flimzy.com>
Authored: Mon Mar 6 10:59:47 2017 +0100
Committer: Nick Vatamaniuc <vatamane@apache.org>
Committed: Tue Mar 7 21:11:41 2017 -0500

----------------------------------------------------------------------
 src/api/server/authn.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/5134e9cb/src/api/server/authn.rst
----------------------------------------------------------------------
diff --git a/src/api/server/authn.rst b/src/api/server/authn.rst
index 6bf4c63..e9cb41b 100644
--- a/src/api/server/authn.rst
+++ b/src/api/server/authn.rst
@@ -288,10 +288,10 @@ headers to CouchDB with related requests:
 - :config:option:`X-Auth-CouchDB-UserName <couch_httpd_auth/x_auth_username>`:
   username;
 - :config:option:`X-Auth-CouchDB-Roles <couch_httpd_auth/x_auth_roles>`:
-  list of user roles separated by a comma (``,``);
+  comma-separated (``,``) list of user roles;
 - :config:option:`X-Auth-CouchDB-Token <couch_httpd_auth/x_auth_token>`:
-  authentication token. Optional, but strongly recommended to
-  :config:option:`force token be required <couch_httpd_auth/proxy_use_secret>`
+  authentication token. When :config:option:`proxy_use_secret <couch_httpd_auth/proxy_use_secret>`
+  is set (which is strongly recommended!), this header provides the secret token
   to prevent requests from untrusted sources.
 
 **Request**:


Mime
View raw message