couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vatam...@apache.org
Subject [1/2] documentation commit: updated refs/heads/master to 17b722e
Date Wed, 08 Mar 2017 16:03:51 GMT
Repository: couchdb-documentation
Updated Branches:
  refs/heads/master 96ccc37f1 -> 17b722ea3


Add documentation for the new `max_http_request_size` parameter

COUCHDB-2992


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

Branch: refs/heads/master
Commit: 83bd3f83b9c08bfb3b8f27fe0653ba27c056c776
Parents: 96ccc37
Author: Nick Vatamaniuc <vatamane@apache.org>
Authored: Wed Mar 8 10:24:12 2017 -0500
Committer: Nick Vatamaniuc <vatamane@apache.org>
Committed: Wed Mar 8 10:24:12 2017 -0500

----------------------------------------------------------------------
 src/api/server/configuration.rst |  1 -
 src/config/couchdb.rst           | 19 -------------------
 src/config/http.rst              | 22 ++++++++++++++++++++++
 3 files changed, 22 insertions(+), 20 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/83bd3f83/src/api/server/configuration.rst
----------------------------------------------------------------------
diff --git a/src/api/server/configuration.rst b/src/api/server/configuration.rst
index 610207b..4b120d2 100644
--- a/src/api/server/configuration.rst
+++ b/src/api/server/configuration.rst
@@ -72,7 +72,6 @@ the various configuration values within a running CouchDB instance.
                 "delayed_commits": "true",
                 "max_attachment_chunk_size": "4294967296",
                 "max_dbs_open": "100",
-                "max_document_size": "4294967296",
                 "os_process_timeout": "5000",
                 "uri_file": "/var/lib/couchdb/couch.uri",
                 "util_driver_dir": "/usr/lib64/couchdb/erlang/lib/couch-1.5.0/priv/lib",

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/83bd3f83/src/config/couchdb.rst
----------------------------------------------------------------------
diff --git a/src/config/couchdb.rst b/src/config/couchdb.rst
index 62eb49c..afcef8d 100644
--- a/src/config/couchdb.rst
+++ b/src/config/couchdb.rst
@@ -105,25 +105,6 @@ Base CouchDB Options
             [couchdb]
             max_dbs_open = 100
 
-    .. config:option:: max_document_size :: Maximum HTTP request body size
-
-        .. versionchanged:: 2.0.1
-
-        Even though this setting is named `max_document_size`, currently it is
-        implemented by checking HTTP request body size. For single document
-        requests the approximation is close enough, however, when multiple
-        documents are updated in a single request the discrepancy between
-        document sizes and request body size could be large. Setting this to a
-        small value might prevent replicator from writing some documents to
-        the target database or checkpointing progress. It can also prevent
-        configuring database security options. Note: up until and including
-        version 2.0 this setting was not applied to `PUT` requests with
-        multipart/related content type, which is how attachments can be
-        uploaded together with document bodies in the same request. ::
-
-            [couchdb]
-            max_document_size = 4294967296 ; 4 GB
-
     .. config:option:: os_process_timeout :: External processes time limit
 
         If an external process, such as a query server or external process,

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/83bd3f83/src/config/http.rst
----------------------------------------------------------------------
diff --git a/src/config/http.rst b/src/config/http.rst
index 42d6275..c206b1e 100644
--- a/src/config/http.rst
+++ b/src/config/http.rst
@@ -221,6 +221,28 @@ HTTP Server Options
             [httpd]
             WWW-Authenticate = Basic realm="Welcome to the Couch!"
 
+    .. config:option:: max_http_request_size :: Maximum HTTP request body size
+
+        .. versionchanged:: 2.1.0
+
+        Limit the maximum size of the HTTP request body. This setting applies
+        to all requests and it doesn't discriminate between single vs.
+        multi-document operations. So setting it to 1MB would block a
+        `PUT` of a document larger than 1MB, but it might also block a
+        `_bulk_docs` update of 1000 1KB documents, or a multipart/related
+        update of a small document followed by two 512KB attachments. This
+        setting is intended to be used as a protection aginst maliciously
+        large HTTP requests rather than for limiting maximum document sizes. ::
+
+            [httpd]
+            max_http_request_size = 4294967296 ; 4 GB
+
+        .. warning::
+           Before version 2.1.0 couchdb.max_document_size was implemented
+           effectively as max_http_request_size. That is, it checkeded HTTP
+           request bodies instead of document sizes. After the upgrade, it is
+           advisable to review the usage of these configuration settings.
+
 .. _config/ssl:
 
 Secure Socket Level Options


Mime
View raw message