You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by va...@apache.org on 2019/10/30 22:00:10 UTC

[couchdb-documentation] branch master updated: Document source_proxy and target_proxy replication parameters (#454)

This is an automated email from the ASF dual-hosted git repository.

vatamane pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git


The following commit(s) were added to refs/heads/master by this push:
     new 40b2ac5  Document source_proxy and target_proxy replication parameters (#454)
40b2ac5 is described below

commit 40b2ac5e288d712999df273f09c4b98aef4a8f62
Author: Nick Vatamaniuc <ni...@users.noreply.github.com>
AuthorDate: Wed Oct 30 18:00:00 2019 -0400

    Document source_proxy and target_proxy replication parameters (#454)
    
    https://github.com/apache/couchdb/commit/053d494e698181ae3b0b0698055f5a24e7995172
    implemented separate source and target proxy configurations and here we
    update the documentation accordingly.
---
 src/api/server/common.rst      | 20 ++++++++++++++------
 src/json-structure.rst         |  7 +++++--
 src/replication/replicator.rst |  6 ++++--
 3 files changed, 23 insertions(+), 10 deletions(-)

diff --git a/src/api/server/common.rst b/src/api/server/common.rst
index c52ee1a..cdd55d8 100644
--- a/src/api/server/common.rst
+++ b/src/api/server/common.rst
@@ -596,8 +596,12 @@
       Required administrator's privileges on target server.
     :<json array doc_ids: Array of document IDs to be synchronized
     :<json string filter: The name of a :ref:`filter function <filterfun>`.
-    :<json string proxy: Address of a proxy server through which replication
-      should occur (protocol can be "http" or "socks5")
+    :<json string source_proxy: Address of a proxy server through which
+      replication from the source should occur (protocol can be "http" or
+      "socks5")
+    :<json string target_proxy: Address of a proxy server through which
+      replication to the target should occur (protocol can be "http" or
+      "socks5")
     :<json string/object source: Source database name or URL or an object
       which contains the full URL of the source database with additional
       parameters like headers. Eg: 'source_db_name' or
@@ -1105,7 +1109,8 @@ error.
                     "info": null,
                     "last_updated": "2017-04-29T05:01:37Z",
                     "node": "node2@127.0.0.1",
-                    "proxy": null,
+                    "source_proxy": null,
+                    "target_proxy": null,
                     "source": "http://myserver.com/foo",
                     "start_time": "2017-04-29T05:01:37Z",
                     "state": "running",
@@ -1119,7 +1124,8 @@ error.
                     "info": null,
                     "last_updated": "2017-04-29T05:01:37Z",
                     "node": "node1@127.0.0.1",
-                    "proxy": null,
+                    "source_proxy": null,
+                    "target_proxy": null,
                     "source": "http://myserver.com/foo",
                     "start_time": "2017-04-29T05:01:37Z",
                     "state": "running",
@@ -1219,7 +1225,8 @@ error.
                     "info": null,
                     "last_updated": "2017-04-29T05:01:37Z",
                     "node": "node2@127.0.0.1",
-                    "proxy": null,
+                    "source_proxy": null,
+                    "target_proxy": null,
                     "source": "http://myserver.com/foo",
                     "start_time": "2017-04-29T05:01:37Z",
                     "state": "running",
@@ -1307,7 +1314,8 @@ error.
             "info": null,
             "last_updated": "2017-04-29T05:01:37Z",
             "node": "node2@127.0.0.1",
-            "proxy": null,
+            "source_proxy": null,
+            "target_proxy": null,
             "source": "http://myserver.com/foo",
             "start_time": "2017-04-29T05:01:37Z",
             "state": "running",
diff --git a/src/json-structure.rst b/src/json-structure.rst
index 638d352..d3d0f0a 100644
--- a/src/json-structure.rst
+++ b/src/json-structure.rst
@@ -261,8 +261,11 @@ Replication Settings
 | filter (optional)              | name of the filter function in the form of  |
 |                                | ``ddoc/myfilter``.                          |
 +--------------------------------+---------------------------------------------+
-| proxy (optional)               | Address of a proxy server through which     |
-|                                | replication should occur.                   |
+| source_proxy (optional)        | Address of a proxy server through which     |
+|                                | replication from the source should occur.   |
++--------------------------------+---------------------------------------------+
+| target_proxy (optional)        | Address of a proxy server through which     |
+|                                | replication to the target should occur.     |
 +--------------------------------+---------------------------------------------+
 | query_params (optional)        | Query parameter that are passed to the      |
 |                                | filter function; the value should be a      |
diff --git a/src/replication/replicator.rst b/src/replication/replicator.rst
index d1cb532..a977010 100644
--- a/src/replication/replicator.rst
+++ b/src/replication/replicator.rst
@@ -80,7 +80,8 @@ Replication state of this document can then be queried from
          "info": null,
          "last_updated": "2017-04-05T19:18:15Z",
          "node": "node1@127.0.0.1",
-         "proxy": null,
+         "source_proxy": null,
+         "target_proxy": null,
          "source": "http://myserver.com/foo/",
          "start_time": "2017-04-05T19:18:15Z",
          "state": "running",
@@ -188,7 +189,8 @@ crashes with an increasingly larger interval. The ``history`` list from
           "info": "db_not_found: could not open http://adm:*****@localhost:5984/missing/",
           "last_updated": "2017-04-05T20:55:10Z",
           "node": "node1@127.0.0.1",
-          "proxy": null,
+          "source_proxy": null,
+          "target_proxy": null,
           "source": "http://adm:*****@localhost:5984/missing/",
           "start_time": "2017-04-05T20:38:34Z",
           "state": "crashing",