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 8D74FC148 for ; Fri, 14 Jun 2013 08:25:19 +0000 (UTC) Received: (qmail 87247 invoked by uid 500); 14 Jun 2013 08:25:10 -0000 Delivered-To: apmail-couchdb-commits-archive@couchdb.apache.org Received: (qmail 87128 invoked by uid 500); 14 Jun 2013 08:25:09 -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 85700 invoked by uid 99); 14 Jun 2013 08:25:00 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 14 Jun 2013 08:25:00 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 21E2D816C47; Fri, 14 Jun 2013 08:24:59 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: kxepal@apache.org To: commits@couchdb.apache.org Date: Fri, 14 Jun 2013 08:25:23 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [26/32] git commit: updated refs/heads/1781-reorganize-and-improve-docs to 11fd32a Describe httpd's x_forwarded_* options. Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/a8f268cc Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/a8f268cc Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/a8f268cc Branch: refs/heads/1781-reorganize-and-improve-docs Commit: a8f268cc0ec7432d31ad000ece66a47ce5c319e8 Parents: 7a2173d Author: Alexander Shorin Authored: Fri Jun 14 05:33:06 2013 +0400 Committer: Alexander Shorin Committed: Fri Jun 14 12:10:26 2013 +0400 ---------------------------------------------------------------------- share/doc/src/config/httpd.rst | 43 +++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/a8f268cc/share/doc/src/config/httpd.rst ---------------------------------------------------------------------- diff --git a/share/doc/src/config/httpd.rst b/share/doc/src/config/httpd.rst index ddfe3cb..0dcc700 100644 --- a/share/doc/src/config/httpd.rst +++ b/share/doc/src/config/httpd.rst @@ -225,6 +225,49 @@ List of global handlers that are available for vhost_global_handlers = _utils, _uuids, _session, _oauth, _users +.. _config/httpd/x_forwarded_host: + +``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/httpd/x_forwarded_proto: + +``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/httpd/x_forwarded_ssl: + +``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/httpd/WWW-Authenticate: ``WWW-Authenticate`` :: Force basic auth