Skip to content

Commit 33a6af4

Browse files
authored
QF210224-1 -- add missing common module (#409)
https://issues.couchbase.com/browse//DOC-7767
1 parent 5703e22 commit 33a6af4

File tree

3 files changed

+41
-29
lines changed

3 files changed

+41
-29
lines changed

modules/ROOT/pages/_partials/commons/common-p2psync-websocket-using-active.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,12 @@ endif::[]
9191
== Configure Replicator
9292
In this section: <<configure-target>> | <<sync-mode>> | <<authenticating-the-listener>> | <<client-authentication>>
9393

94+
// [#lbl-cfg-tgt]
9495
=== Configure Target
9596

9697
include::{root-commons}sgw-replication-cfg-tgt.adoc[]
9798

99+
// [#lbl-cfg-sync]
98100
=== Sync Mode
99101

100102
include::{root-commons}sgw-replication-cfg-sync-mode.adoc[]
@@ -105,6 +107,7 @@ Define the credentials the your app (the client) is expecting to receive from th
105107

106108
include::{root-commons}set-server-authentication.adoc[]
107109

110+
// [#lbl-authclnt]
108111
=== Client Authentication
109112
Here we define the credentials that the client can present to the server if prompted to do so in order that the server can authenticate it.
110113

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
// BEGIN -- inclusion -- common-sgw-replication-cfg-tgt.adoc
2+
// Used-by:
3+
// common-p2psync-websocket-using-active.adoc
4+
// common-sgw-replication.adoc
5+
//
6+
7+
Use the
8+
{url-api-class-replicator-config} class and {url-api-constructor-replicator-config-db-tgt} constructor to initialize the replication configuration with local and remote database locations.
9+
10+
The constructor provides:
11+
12+
* the name of the local database to be sync'd
13+
* the server's URL (including the port number and the name of the remote database to sync with)
14+
+
15+
--
16+
It is expected that the app will identify the IP address and URL and append the remote database name to the URL endpoint, producing for example: `wss://10.0.2.2:4984/travel-sample`
17+
18+
The URL scheme for web socket URLs uses `ws:` (non-TLS) or `wss:` (SSL/TLS) prefixes.
19+
ifdef::is-android[]
20+
include::{root-partials}_block-caveats.adoc[tags=android-manifest-cleartext]
21+
endif::[]
22+
--
23+
24+
// Example 2
25+
.Add Target to Configuration
26+
====
27+
[source, {source-language}]
28+
----
29+
include::{snippet-p2psync-ws}[tags="sgw-act-rep-initialize", indent=0]
30+
----
31+
32+
*Notes on Example*
33+
34+
<.> Note use of the `wss://` prefix to ensure TLS encryption (strongly recommended in production)
35+
36+
====
37+
// END -- inclusion -- common-sgw-replication-cfg-tgt.adoc

modules/ROOT/pages/_partials/commons/common-sgw-replication.adoc

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -112,36 +112,8 @@ In this section::
112112
[#lbl-cfg-tgt]
113113
=== Configure Target
114114

115-
Use the
116-
{url-api-class-replicator-config} class and {url-api-constructor-replicator-config-db-tgt} constructor to initialize the replication configuration with local and remote database locations.
115+
include::{root-commons}sgw-replication-cfg-tgt.adoc[]
117116

118-
The constructor provides:
119-
120-
* the name of the local database to be sync'd
121-
* the server's URL (including the port number and the name of the remote database to sync with)
122-
+
123-
--
124-
It is expected that the app will identify the IP address and URL and append the remote database name to the URL endpoint, producing for example: `wss://10.0.2.2:4984/travel-sample`
125-
126-
The URL scheme for web socket URLs uses `ws:` (non-TLS) or `wss:` (SSL/TLS) prefixes.
127-
ifdef::is-android[]
128-
include::{root-partials}_block-caveats.adoc[tags=android-manifest-cleartext]
129-
endif::[]
130-
--
131-
132-
// Example 2
133-
.Add Target to Configuration
134-
====
135-
[source, {source-language}]
136-
----
137-
include::{snippet-p2psync-ws}[tags="sgw-act-rep-initialize", indent=0]
138-
----
139-
140-
*Notes on Example*
141-
142-
<.> Note use of the `wss://` prefix to ensure TLS encryption (strongly recommended in production)
143-
144-
====
145117

146118
[#lbl-cfg-sync]
147119
=== Sync Mode

0 commit comments

Comments
 (0)