Documentation: Add `adm:pass` to replication endpoint URL (#4457)
When using replication, we need to specify a username and password
(`adm:pass` / `admin:password`) for the replication endpoint URL,
otherwise a 401 unauthorized error will be thrown.
Co-authored-by: jiahuili <Jiahui.Li@ibm.com>
diff --git a/src/docs/src/api/server/common.rst b/src/docs/src/api/server/common.rst
index 3715115..95478bf 100644
--- a/src/docs/src/api/server/common.rst
+++ b/src/docs/src/api/server/common.rst
@@ -764,8 +764,8 @@
Host: localhost:5984
{
- "source": "http://127.0.0.1:5984/db_a",
- "target": "http://127.0.0.1:5984/db_b"
+ "source": "http://adm:pass@127.0.0.1:5984/db_a",
+ "target": "http://adm:pass@127.0.0.1:5984/db_b"
}
**Response**
diff --git a/src/docs/src/intro/api.rst b/src/docs/src/intro/api.rst
index f18bb5d..3bf37c7 100644
--- a/src/docs/src/intro/api.rst
+++ b/src/docs/src/intro/api.rst
@@ -613,8 +613,8 @@
Now we can use the database `albums-replica` as a replication target::
- curl -vX POST http://admin:password@127.0.0.1:5984/_replicate \
- -d '{"source":"http://127.0.0.1:5984/albums","target":"http://127.0.0.1:5984/albums-replica"}' \
+ curl -X POST http://adm:pass@127.0.0.1:5984/_replicate \
+ -d '{"source":"http://adm:pass@127.0.0.1:5984/albums","target":"http://adm:pass@127.0.0.1:5984/albums-replica"}' \
-H "Content-Type: application/json"
.. note::
@@ -632,22 +632,27 @@
.. code-block:: javascript
{
+ "ok": true,
+ "session_id": "30bb4ac013ca69369c0f32be78864d6e",
+ "source_last_seq": "2-g1AAAACTeJzLYWBgYMpgTmHgz8tPSTV0MDQy1zMAQsMckEQiQ1L9____szKYExlzgQLsBiaphqYpSZjKcRqRxwIkGRqA1H8Uk4wszJIskg0wdWUBAFHwJD4",
+ "replication_id_version": 4,
"history": [
{
+ "session_id": "30bb4ac013ca69369c0f32be78864d6e",
+ "start_time": "Sun, 05 Mar 2023 20:30:26 GMT",
+ "end_time": "Sun, 05 Mar 2023 20:30:29 GMT",
"start_last_seq": 0,
+ "end_last_seq": "2-g1AAAACTeJzLYWBgYMpgTmHgz8tPSTV0MDQy1zMAQsMckEQiQ1L9____szKYExlzgQLsBiaphqYpSZjKcRqRxwIkGRqA1H8Uk4wszJIskg0wdWUBAFHwJD4",
+ "recorded_seq": "2-g1AAAACTeJzLYWBgYMpgTmHgz8tPSTV0MDQy1zMAQsMckEQiQ1L9____szKYExlzgQLsBiaphqYpSZjKcRqRxwIkGRqA1H8Uk4wszJIskg0wdWUBAFHwJD4",
+ "missing_checked": 2,
"missing_found": 2,
"docs_read": 2,
- "end_last_seq": 5,
- "missing_checked": 2,
"docs_written": 2,
"doc_write_failures": 0,
- "end_time": "Sat, 11 Jul 2009 17:36:21 GMT",
- "start_time": "Sat, 11 Jul 2009 17:36:20 GMT"
+ "bulk_get_docs": 2,
+ "bulk_get_attempts": 2
}
- ],
- "source_last_seq": 5,
- "session_id": "924e75e914392343de89c99d29d06671",
- "ok": true
+ ]
}
CouchDB maintains a *session history* of replications. The response for a
@@ -660,8 +665,8 @@
when replication was started. So, any additions, modifications,
or deletions subsequent to the start of replication will not be replicated.
-We'll punt on the details again -- the ``"ok": true`` at the end tells us all
-went well. If you now have a look at the albums-replica database,
+We'll punt on the details again -- the ``"ok": true`` at the beginning tells
+us all went well. If you now have a look at the albums-replica database,
you should see all the documents that you created in the albums database.
Neat, eh?
@@ -676,8 +681,8 @@
HTML) and so far we've seen links relative to the server we're working on
(hence local). You can also specify a remote database as the target::
- curl -vX POST http://admin:password@127.0.0.1:5984/_replicate \
- -d '{"source":"http://127.0.0.1:5984/albums","target":"http://example.org:5984/albums-replica"}' \
+ curl -X POST http://adm:pass@127.0.0.1:5984/_replicate \
+ -d '{"source":"http://adm:pass@127.0.0.1:5984/albums","target":"http://user:password@example.org:5984/albums-replica"}' \
-H "Content-Type:application/json"
Using a *local source* and a *remote target* database is called *push
@@ -695,16 +700,16 @@
replication*. This is great for getting the latest changes from a server that
is used by others::
- curl -vX POST http://admin:password@127.0.0.1:5984/_replicate \
- -d '{"source":"http://example.org:5984/albums-replica","target":"http://127.0.0.1:5984/albums"}' \
+ curl -X POST http://adm:pass@127.0.0.1:5984/_replicate \
+ -d '{"source":"http://user:password@example.org:5984/albums-replica","target":"http://adm:pass@127.0.0.1:5984/albums"}' \
-H "Content-Type:application/json"
Finally, you can run remote replication, which is mostly useful for management
operations::
- curl -vX POST http://admin:password@127.0.0.1:5984/_replicate \
- -d '{"source":"http://example.org:5984/albums","target":"http://example.org:5984/albums-replica"}' \
- -H"Content-Type: application/json"
+ curl -X POST http://adm:pass@127.0.0.1:5984/_replicate \
+ -d '{"source":"http://user:password@example.org:5984/albums","target":"http://user:password@example.org:5984/albums-replica"}' \
+ -H "Content-Type: application/json"
.. note::
**CouchDB and REST**
diff --git a/src/docs/src/replication/conflicts.rst b/src/docs/src/replication/conflicts.rst
index 1354483..09468fa 100644
--- a/src/docs/src/replication/conflicts.rst
+++ b/src/docs/src/replication/conflicts.rst
@@ -270,7 +270,7 @@
.. code-block:: bash
- $ curl -X POST http://127.0.0.1/dbname/_find \
+ $ curl -X POST http://adm:pass@127.0.0.1:5984/dbname/_find \
-d '{"selector": {"_conflicts": { "$exists": true}}, "conflicts": true}' \
-Hcontent-type:application/json
@@ -289,7 +289,7 @@
.. code-block:: bash
- $ curl -X POST http://127.0.0.1/dbname/_index \
+ $ curl -X POST http://adm:pass@127.0.0.1:5984/dbname/_index \
-d '{"index":{"fields": ["_conflicts"]}}' \
-Hcontent-type:application/json
@@ -307,7 +307,7 @@
.. code-block:: bash
- $ curl 'http://127.0.0.1:5984/conflict_test/_all_docs?include_docs=true&conflicts=true'
+ $ curl 'http://adm:pass@127.0.0.1:5984/conflict_test/_all_docs?include_docs=true&conflicts=true'
.. code-block:: javascript
@@ -330,7 +330,7 @@
.. code-block:: bash
- $ curl 'http://127.0.0.1:5984/conflict_test/test?conflicts=true'
+ $ curl 'http://adm:pass@127.0.0.1:5984/conflict_test/test?conflicts=true'
.. code-block:: javascript
diff --git a/src/docs/src/replication/replicator.rst b/src/docs/src/replication/replicator.rst
index b063829..65fd298 100644
--- a/src/docs/src/replication/replicator.rst
+++ b/src/docs/src/replication/replicator.rst
@@ -56,17 +56,17 @@
{
"_id": "my_rep",
- "source": "http://myserver.com/foo",
+ "source": "http://user:password@myserver.com/foo",
"target": {
"url": "http://localhost:5984/bar",
"auth": {
"basic": {
- "username": "user",
+ "username": "adm",
"password": "pass"
}
}
},
- "create_target": true,
+ "create_target": true,
"continuous": true
}
@@ -181,17 +181,17 @@
{
"_id": "my_rep_crashing",
- "source": "http://myserver.com/missing",
+ "source": "http://user:password@myserver.com/missing",
"target": {
"url": "http://localhost:5984/bar",
"auth": {
"basic": {
- "username": "user",
+ "username": "adm",
"password": "pass"
}
}
},
- "create_target": true,
+ "create_target": true,
"continuous": true
}
@@ -252,16 +252,16 @@
Documents describing the same replication
=========================================
-Lets suppose 2 documents are added to the ``_replicator`` database in
+Let's suppose 2 documents are added to the ``_replicator`` database in
the following order:
.. code-block:: javascript
{
"_id": "my_rep",
- "source": "http://myserver.com/foo",
- "target": "http://user:pass@localhost:5984/bar",
- "create_target": true,
+ "source": "http://user:password@myserver.com/foo",
+ "target": "http://adm:pass@localhost:5984/bar",
+ "create_target": true,
"continuous": true
}
@@ -271,9 +271,9 @@
{
"_id": "my_rep_dup",
- "source": "http://myserver.com/foo",
- "target": "http://user:pass@localhost:5984/bar",
- "create_target": true,
+ "source": "http://user:password@myserver.com/foo",
+ "target": "http://adm:pass@localhost:5984/bar",
+ "create_target": true,
"continuous": true
}
@@ -517,34 +517,34 @@
{
"_id": "rep_from_A",
- "source": "http://aserver.com:5984/foo",
+ "source": "http://user:password@aserver.com:5984/foo",
"target": {
"url": "http://localhost:5984/foo_a",
"auth": {
"basic": {
- "username": "user",
+ "username": "adm",
"password": "pass"
}
}
},
- "continuous": true
+ "continuous": true
}
.. code-block:: javascript
{
"_id": "rep_from_B",
- "source": "http://bserver.com:5984/foo",
+ "source": "http://user:password@bserver.com:5984/foo",
"target": {
"url": "http://localhost:5984/foo_b",
"auth": {
"basic": {
- "username": "user",
+ "username": "adm",
"password": "pass"
}
}
},
- "continuous": true
+ "continuous": true
}
Now without stopping and restarting CouchDB, add another replicator
@@ -552,11 +552,11 @@
.. code-block:: bash
- $ curl -X PUT http://user:pass@localhost:5984/another%2F_replicator/
+ $ curl -X PUT http://adm:pass@localhost:5984/another%2F_replicator/
{"ok":true}
.. note::
- A / character in a database name, when used in a URL, should be escaped.
+ A ``/`` (%2F) character in a database name, when used in a URL, should be escaped.
Then add a replication document to the new replicator database:
@@ -564,9 +564,9 @@
{
"_id": "rep_from_X",
- "source": "http://xserver.com:5984/foo",
- "target": "http://user:pass@localhost:5984/foo_x",
- "continuous": true
+ "source": "http://user:password@xserver.com:5984/foo",
+ "target": "http://adm:pass@localhost:5984/foo_x",
+ "continuous": true
}
From now on, there are three replications active in the system: two
@@ -576,7 +576,7 @@
.. code-block:: bash
- $ curl -X DELETE http://user:pass@localhost:5984/another%2F_replicator/
+ $ curl -X DELETE http://adm:pass@localhost:5984/another%2F_replicator/
{"ok":true}
After this operation, replication pulling from server X will be stopped
@@ -633,18 +633,18 @@
{
"_id": "rep_from_A",
- "source": "http://aserver.com:5984/foo",
- "target": "http://user:pass@localhost:5984/foo_a",
- "continuous": true
+ "source": "http://user:password@aserver.com:5984/foo",
+ "target": "http://adm:pass@localhost:5984/foo_a",
+ "continuous": true
}
.. code-block:: javascript
{
"_id": "rep_from_B",
- "source": "http://bserver.com:5984/foo",
- "target": "http://user:pass@localhost:5984/foo_b",
- "continuous": true
+ "source": "http://user:password@bserver.com:5984/foo",
+ "target": "http://adm:pass@localhost:5984/foo_b",
+ "continuous": true
}
Now you would like to have the same pull replications going on in server
@@ -697,9 +697,9 @@
{
"_id": "my_rep",
- "source": "http://bserver.com:5984/foo",
- "target": "http://user:pass@localhost:5984/bar",
- "continuous": true,
+ "source": "http://user:password@bserver.com:5984/foo",
+ "target": "http://adm:pass@localhost:5984/bar",
+ "continuous": true,
"user_ctx": {
"name": "joe",
"roles": ["erlanger", "researcher"]
@@ -770,7 +770,7 @@
.. code-block:: javascript
{
- "target": "http://user:pass@localhost:5984/bar"
+ "target": "http://adm:pass@localhost:5984/bar"
...
}
