diff --git a/.gitignore b/.gitignore index 3e50d2ad6..199325e7f 100644 --- a/.gitignore +++ b/.gitignore @@ -93,7 +93,6 @@ $RECYCLE.BIN/ # Build results [Dd]ebug/ [Dd]ebugPublic/ -[Rr]elease/ [Rr]eleases/ x64/ x86/ @@ -416,4 +415,4 @@ modules/ROOT/assets/attachments/.DS_Store #OpenAPI Generator files .openapi-generator -.openapi-generator-ignore \ No newline at end of file +.openapi-generator-ignore diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index e29a26294..72cb478e1 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1,148 +1,148 @@ // -* xref:introduction.adoc[Introduction] +* xref:ROOT:introduction.adoc[Introduction] // // -* xref:whatsnew.adoc[pass:q,a[*_New in {release}_*]] +* xref:ROOT:whatsnew.adoc[pass:q,a[*_New in {release}_*]] // .Start Here! -// * xref:index.adoc[Quick Links] -* xref:start-here/get-started-prepare.adoc[Prepare] -* xref:start-here/get-started-install.adoc[Install] -* xref:start-here/get-started-verify-install.adoc[Verify] +// * xref:ROOT:index.adoc[Quick Links] +* xref:start-here:get-started-prepare.adoc[Prepare] +* xref:start-here:get-started-install.adoc[Install] +* xref:start-here:get-started-verify-install.adoc[Verify] // -* xref:data-modeling.adoc[Data Modeling] +* xref:ROOT:data-modeling.adoc[Data Modeling] // .Configuration - * xref:configuration/configuration-overview.adoc[Overview] - * xref:configuration/configuration-schema-bootstrap.adoc[Bootstrap] - * xref:configuration/configuration-schema-database.adoc[Database] - ** xref:configuration/scopes-and-collections-config.adoc[Scopes and Collections Configuration for Sync Gateway] - * xref:configuration/configuration-schema-db-security.adoc[Database Security] - * xref:configuration/configuration-schema-access-control.adoc[Access Control] - * xref:configuration/configuration-schema-import-filter.adoc[Import Filter] - * xref:configuration/configuration-schema-isgr.adoc[Inter-Sync Gateway Replication] - * xref:configuration/configuration-properties-legacy.adoc[Legacy Pre-3.0 Configuration] - * xref:configuration/configuration-javascript-functions.adoc[Javascript Functions] - * xref:configuration/configuration-environment-variables.adoc[Environment Variables] + * xref:configuration:configuration-overview.adoc[Overview] + * xref:configuration:configuration-schema-bootstrap.adoc[Bootstrap] + * xref:configuration:configuration-schema-database.adoc[Database] + ** xref:configuration:scopes-and-collections-config.adoc[Scopes and Collections Configuration for Sync Gateway] + * xref:configuration:configuration-schema-db-security.adoc[Database Security] + * xref:configuration:configuration-schema-access-control.adoc[Access Control] + * xref:configuration:configuration-schema-import-filter.adoc[Import Filter] + * xref:configuration:configuration-schema-isgr.adoc[Inter-Sync Gateway Replication] + * xref:configuration:configuration-properties-legacy.adoc[Legacy Pre-3.0 Configuration] + * xref:configuration:configuration-javascript-functions.adoc[Javascript Functions] + * xref:configuration:configuration-environment-variables.adoc[Environment Variables] .Security - * xref:security/secure-sgw-access.adoc[Secure Access] - * xref:security/authentication-users.adoc[User Authentication] - * xref:security/authentication-certs.adoc[TLS Cert Authentication] - * xref:security/audit-logging.adoc[] - ** xref:security/manage-audit-logs.adoc[] - ** xref:security/audit-log-events.adoc[] + * xref:security:secure-sgw-access.adoc[Secure Access] + * xref:security:authentication-users.adoc[User Authentication] + * xref:security:authentication-certs.adoc[TLS Cert Authentication] + * xref:security:audit-logging.adoc[] + ** xref:security:manage-audit-logs.adoc[] + ** xref:security:audit-log-events.adoc[] .Access Control - * xref:access-control/access-control-concepts.adoc[Concepts] - ** xref:access-control/access-control-model.adoc[Access Control Model] - ** xref:access-control/channels.adoc[Channels] - ** xref:access-control/roles.adoc[Roles] - ** xref:access-control/users.adoc[Users] - * xref:access-control/sync-function/sync-function.adoc[Sync Function] - ** xref:access-control/sync-function/sync-function-api.adoc[API Reference] - *** xref:access-control/sync-function/sync-function-api-access-cmd.adoc[access()] - *** xref:access-control/sync-function/sync-function-api-channel-cmd.adoc[channel()] - *** xref:access-control/sync-function/sync-function-api-expiry-cmd.adoc[expiry()] - *** xref:access-control/sync-function/sync-function-api-require-access-cmd.adoc[requireAccess()] - *** xref:access-control/sync-function/sync-function-api-require-admin-cmd.adoc[requireAdmin()] - *** xref:access-control/sync-function/sync-function-api-require-role-cmd.adoc[requireRole()] - *** xref:access-control/sync-function/sync-function-api-require-user-cmd.adoc[requireUser()] - *** xref:access-control/sync-function/sync-function-api-role-cmd.adoc[role()] - *** xref:access-control/sync-function/sync-function-api-throw-cmd.adoc[throw()] - * xref:access-control/access-control-how.adoc[How-to] - ** xref:access-control/access-control-how-create-users.adoc[Create Users] - ** xref:access-control/access-control-how-create-roles.adoc[Create Roles] - ** xref:access-control/access-control-how-assign-users-to-roles.adoc[Assign User to Role] - ** xref:access-control/access-control-how-control-document-access.adoc[Control Document Access] - ** xref:access-control/access-control-how-verify-access.adoc[Verify Access] - ** xref:access-control/access-control-how-use-xattrs-for-access-grants.adoc[Use XATTRS for Access Grants] - * xref:access-control/auto-purge-channel-access-revocation.adoc[Auto-Purge Channel Access Revocation] + * xref:access-control:access-control-concepts.adoc[Concepts] + ** xref:access-control:access-control-model.adoc[Access Control Model] + ** xref:access-control:channels.adoc[Channels] + ** xref:access-control:roles.adoc[Roles] + ** xref:access-control:users.adoc[Users] + * xref:access-control:sync-function/sync-function.adoc[Sync Function] + ** xref:access-control:sync-function/sync-function-api.adoc[API Reference] + *** xref:access-control:sync-function/sync-function-api-access-cmd.adoc[access()] + *** xref:access-control:sync-function/sync-function-api-channel-cmd.adoc[channel()] + *** xref:access-control:sync-function/sync-function-api-expiry-cmd.adoc[expiry()] + *** xref:access-control:sync-function/sync-function-api-require-access-cmd.adoc[requireAccess()] + *** xref:access-control:sync-function/sync-function-api-require-admin-cmd.adoc[requireAdmin()] + *** xref:access-control:sync-function/sync-function-api-require-role-cmd.adoc[requireRole()] + *** xref:access-control:sync-function/sync-function-api-require-user-cmd.adoc[requireUser()] + *** xref:access-control:sync-function/sync-function-api-role-cmd.adoc[role()] + *** xref:access-control:sync-function/sync-function-api-throw-cmd.adoc[throw()] + * xref:access-control:access-control-how.adoc[How-to] + ** xref:access-control:access-control-how-create-users.adoc[Create Users] + ** xref:access-control:access-control-how-create-roles.adoc[Create Roles] + ** xref:access-control:access-control-how-assign-users-to-roles.adoc[Assign User to Role] + ** xref:access-control:access-control-how-control-document-access.adoc[Control Document Access] + ** xref:access-control:access-control-how-verify-access.adoc[Verify Access] + ** xref:access-control:access-control-how-use-xattrs-for-access-grants.adoc[Use XATTRS for Access Grants] + * xref:access-control:auto-purge-channel-access-revocation.adoc[Auto-Purge Channel Access Revocation] .REST API - * xref:rest-api/rest-api-access.adoc[Secure Access] - * xref:rest-api/rest-api-admin.adoc[Admin REST API] - ** xref:rest_api_admin_static.adoc[Admin API Reference] - * xref:rest-api/rest-api-metrics.adoc[Metrics REST API] - ** xref:rest_api_metrics_static.adoc[Metrics API Reference] - * xref:rest-api/rest-api.adoc[Public REST API] - ** xref:rest_api_public_static.adoc[Public API Reference] - * xref:rest-api/rest-api-access-rbac-roles.adoc[RBAC Role - Endpoint Cross-Reference] + * xref:rest-api:rest-api-access.adoc[Secure Access] + * xref:rest-api:rest-api-admin.adoc[Admin REST API] + ** xref:ROOT:rest_api_admin_static.adoc[Admin API Reference] + * xref:rest-api:rest-api-metrics.adoc[Metrics REST API] + ** xref:ROOT:rest_api_metrics_static.adoc[Metrics API Reference] + * xref:rest-api:rest-api.adoc[Public REST API] + ** xref:ROOT:rest_api_public_static.adoc[Public API Reference] + * xref:rest-api:rest-api-access-rbac-roles.adoc[RBAC Role - Endpoint Cross-Reference] .Sync - * xref:sync/sync-with-couchbase-server.adoc[Sync with Server] - * xref:sync/sync-using-app.adoc[Sync with Application] + * xref:sync:sync-with-couchbase-server.adoc[Sync with Server] + * xref:sync:sync-using-app.adoc[Sync with Application] * Inter-Sync Gateway Replication - ** xref:sync/sync-inter-syncgateway-overview.adoc[Overview] - ** xref:sync/sync-inter-syncgateway-run.adoc[Initialize] - ** xref:sync/sync-inter-syncgateway-manage.adoc[Manage] - ** xref:sync/sync-inter-syncgateway-monitor.adoc[Monitor] - ** xref:sync/sync-inter-syncgateway-conflict-resolution.adoc[Inter Syncgateway Conflict Resolution] - * xref:sync/delta-sync.adoc[Delta Sync] - * xref:sync/import-processing.adoc[Import Processing] + ** xref:sync:sync-inter-syncgateway-overview.adoc[Overview] + ** xref:sync:sync-inter-syncgateway-run.adoc[Initialize] + ** xref:sync:sync-inter-syncgateway-manage.adoc[Manage] + ** xref:sync:sync-inter-syncgateway-monitor.adoc[Monitor] + ** xref:sync:sync-inter-syncgateway-conflict-resolution.adoc[Inter Syncgateway Conflict Resolution] + * xref:sync:delta-sync.adoc[Delta Sync] + * xref:sync:import-processing.adoc[Import Processing] .Manage - * xref:manage/revisions.adoc[Revisions] - * xref:manage/managing-tombstones.adoc[Tombstones] - * xref:manage/resync.adoc[Resync] - * xref:manage/stats-monitoring.adoc[Stats Monitoring] - ** xref:manage/stats-monitoring-json.adoc[] - ** xref:manage/stats-monitoring-prometheus.adoc[] - * xref:manage/database-offline.adoc[Database Offline] - * xref:manage/logging.adoc[Logging] - ** xref:manage/sgcollect-info.adoc[SG Collect Info] + * xref:manage:revisions.adoc[Revisions] + * xref:manage:managing-tombstones.adoc[Tombstones] + * xref:manage:resync.adoc[Resync] + * xref:manage:stats-monitoring.adoc[Stats Monitoring] + ** xref:manage:stats-monitoring-json.adoc[] + ** xref:manage:stats-monitoring-prometheus.adoc[] + * xref:manage:database-offline.adoc[Database Offline] + * xref:manage:logging.adoc[Logging] + ** xref:manage:sgcollect-info.adoc[SG Collect Info] .Deploy - * xref:deploy/deployment.adoc[Overview] - * xref:deploy/command-line-options.adoc[Command Line Options] - * xref:deploy/load-balancer.adoc[Load Balancer] - * xref:deploy/os-level-tuning.adoc[OS Level Tuning] - * xref:deploy/webhooks.adoc[Webhooks] - * xref:deploy/changes-feed.adoc[Changes Feed] -// * xref:integrating-external-stores.adoc[External Stores] - * xref:deploy/stats-prometheus.adoc[Prometheus Feed] - * xref:deploy/indexing.adoc[Indexing] - ** xref:deploy/index-partitions.adoc[] - * xref:deploy/setting-up-dr-cluster.adoc[Disaster Recovery] + * xref:deploy:deployment.adoc[Overview] + * xref:deploy:command-line-options.adoc[Command Line Options] + * xref:deploy:load-balancer.adoc[Load Balancer] + * xref:deploy:os-level-tuning.adoc[OS Level Tuning] + * xref:deploy:webhooks.adoc[Webhooks] + * xref:deploy:changes-feed.adoc[Changes Feed] +// * xref:ROOT:integrating-external-stores.adoc[External Stores] + * xref:deploy:stats-prometheus.adoc[Prometheus Feed] + * xref:deploy:indexing.adoc[Indexing] + ** xref:deploy:index-partitions.adoc[] + * xref:deploy:setting-up-dr-cluster.adoc[Disaster Recovery] // - * xref:upgrading.adoc[Upgrade] + * xref:ROOT:upgrading.adoc[Upgrade] // .Use Kubernetes - * xref:use-kubernetes/deploy-cluster-to-kubernetes.adoc[Deploy] + * xref:use-kubernetes:deploy-cluster-to-kubernetes.adoc[Deploy] * xref:operator:ROOT:tutorial-sync-gateway-manage.adoc[Manage a Sync Gateway Cluster] * xref:operator:ROOT:tutorial-sync-gateway-clients.adoc[Expose Sync Gateway to Couchbase Lite clients] .Server Compatibility - * xref:server-compatibility/server-compatibility-buckets.adoc[Buckets] - * xref:server-compatibility/server-compatibility-collections.adoc[Collections] - * xref:server-compatibility/server-compatibility-eventing.adoc[Eventing] - * xref:server-compatibility/server-compatibility-transactions.adoc[Transactions] - * xref:server-compatibility/server-compatibility-xdcr.adoc[XDCR] - * xref:server-compatibility/xdcr-active-active-eventing.adoc[XDCR Active-Active and Eventing] - * xref:server-compatibility/server-compatibility-backups.adoc[Backup and Restore] + * xref:server-compatibility:server-compatibility-buckets.adoc[Buckets] + * xref:server-compatibility:server-compatibility-collections.adoc[Collections] + * xref:server-compatibility:server-compatibility-eventing.adoc[Eventing] + * xref:server-compatibility:server-compatibility-transactions.adoc[Transactions] + * xref:server-compatibility:server-compatibility-xdcr.adoc[XDCR] + * xref:server-compatibility:xdcr-active-active-eventing.adoc[XDCR Active-Active and Eventing] + * xref:server-compatibility:server-compatibility-backups.adoc[Backup and Restore] .Product Notes - * xref:product-notes/release-notes.adoc[Release Notes] - * xref:product-notes/supported-environments.adoc[Supported Environments] - * xref:product-notes/compatibility.adoc[Compatibility Matrix] + * xref:product-notes:release-notes.adoc[Release Notes] + * xref:product-notes:supported-environments.adoc[Supported Environments] + * xref:product-notes:compatibility.adoc[Compatibility Matrix] // list divider - * xref:glossary.adoc[Glossary] + * xref:ROOT:glossary.adoc[Glossary] // \ No newline at end of file diff --git a/modules/ROOT/pages/_partials/howto/how-to-sync-function-api.adoc b/modules/ROOT/pages/_partials/howto/how-to-sync-function-api.adoc deleted file mode 100644 index 4d65195b7..000000000 --- a/modules/ROOT/pages/_partials/howto/how-to-sync-function-api.adoc +++ /dev/null @@ -1,60 +0,0 @@ -// BEGIN how-to -- CONTROL DOCUMENT ACCESS -// Parameters -- use-topic-header -- to show the topic heading (optional) - -:ouroffset: +1 - -[#lbl-access] -== access() - -include::partial$sync-api/sync-function-api-access.adoc[leveloffset={ouroffset}] - -[#lbl-channel] -== channel() - -include::partial$sync-api/sync-function-api-channel.adoc[leveloffset={ouroffset}] - - -[#lbl-expiry] -== expiry() - -include::partial$sync-api/sync-function-api-expiry.adoc[leveloffset={ouroffset}] - - -[#lbl-require-access] -== requireAccess() - -include::partial$sync-api/sync-function-api-require-access.adoc[leveloffset={ouroffset}] - - -[#lbl-require-admin] -== requireAdmin() - -include::partial$sync-api/sync-function-api-require-admin.adoc[leveloffset={ouroffset}] - - -[#lbl-require-role] -== requireRole() - -include::partial$sync-api/sync-function-api-require-role.adoc[leveloffset={ouroffset}] - - -[#lbl-require-user] -== requireUser() - -include::partial$sync-api/sync-function-api-require-user.adoc[leveloffset={ouroffset}] - - -[#lbl-role] -== role() - -include::partial$sync-api/sync-function-api-role.adoc[leveloffset={ouroffset}] - - -[#lbl-throw] -== throw() - -include::partial$sync-api/sync-function-api-throw.adoc[leveloffset={ouroffset}] - - - -// END how-to -- ALLOW ACCESS diff --git a/modules/ROOT/pages/_partials/stats-schema.adoc b/modules/ROOT/pages/_partials/stats-schema.adoc deleted file mode 100644 index e384fb515..000000000 --- a/modules/ROOT/pages/_partials/stats-schema.adoc +++ /dev/null @@ -1,5 +0,0 @@ -"{syncgateway}": { -include::partial$stats-schema-global.adoc[indent=2] -include::partial$stats-schema-per-db.adoc[indent=2] -include::partial$stats-schema-per-replication-sgr1.adoc[indent=2] -} \ No newline at end of file diff --git a/modules/ROOT/pages/conflict-resolution.adoc b/modules/ROOT/pages/conflict-resolution.adoc index 4a6290f35..d8958db70 100644 --- a/modules/ROOT/pages/conflict-resolution.adoc +++ b/modules/ROOT/pages/conflict-resolution.adoc @@ -25,12 +25,12 @@ ifdef::prerelease[:page-status: {prerelease}] :idprefix: :idseparator: - -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-abstract!: :param-related: {conflict-resolution--xref} | {configuration-schema-bootstrap--xref} :topic-group: Sync -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] Conflicts are automatically resolved footnote:[Since Couchbase Lite 2.0]. The functionality aims to simplify the default behavior of conflict handling and save disk space (conflicting revisions are no longer be stored in the database). @@ -44,6 +44,6 @@ xref:couchbase-lite:objc:learn/objc-conflict.adoc[Objective-C] For conflict resolution on 1.x clients -- see : {xref-sgw-pg-resolving-conflicts-legacy}. -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- PAGE -- conflict-resolution.adoc \ No newline at end of file diff --git a/modules/ROOT/pages/couchbase-mobile-index.adoc b/modules/ROOT/pages/couchbase-mobile-index.adoc index 68128c024..b2bd8b32f 100644 --- a/modules/ROOT/pages/couchbase-mobile-index.adoc +++ b/modules/ROOT/pages/couchbase-mobile-index.adoc @@ -4,7 +4,7 @@ ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: -toc -include::partial$_define_component_attributes.adoc[] +include::ROOT:partial$_define_component_attributes.adoc[] [abstract] diff --git a/modules/ROOT/pages/data-modeling.adoc b/modules/ROOT/pages/data-modeling.adoc index 4aca4bc30..c5971c323 100644 --- a/modules/ROOT/pages/data-modeling.adoc +++ b/modules/ROOT/pages/data-modeling.adoc @@ -5,7 +5,7 @@ ifdef::prerelease[:page-status: {prerelease}] :description: pass:q[_Couchbase Sync Gateway's_ data model; for secure cloud-to-edge synchronization of enterprise data.] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes :xref-sdk-nodejs-pg-start: xref:nodejs-sdk:hello-world:start-using-sdk.adoc[Node.js Server SDK] @@ -15,7 +15,7 @@ include::partial$_set_page_context.adoc[] // BEGIN -- Page Heading :param-abstract!: :param-related: {revisions--xref} | {managing-tombstones--xref} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading == Introduction @@ -120,5 +120,5 @@ Its main purpose is to enable the replicator to determine which data to sync and Each document change is assigned a unique revision ID. The IDs of past revisions are available. The content of past revisions may be available if the revision was created locally and the database has not yet been compacted. // BEGIN -- Page Footer -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] // END -- Page Footer \ No newline at end of file diff --git a/modules/ROOT/pages/database-management.adoc b/modules/ROOT/pages/database-management.adoc index 893fb8b6a..828edf2b9 100644 --- a/modules/ROOT/pages/database-management.adoc +++ b/modules/ROOT/pages/database-management.adoc @@ -7,13 +7,13 @@ :description: Describes the various database management functions available to maintain an efficient sync gateway database -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Heading :param-abstract: pass:q[Revisions are at the heart of Couchbase Mobile's ability to respond flexibly and securely to changing data from server to edge.] :param-related: {url-blog-dbsizemng-pruning} | {url-blog-doc-conflicts-repl-protocol-revisions} | {url-blog-doc-conflicts-demystifying-mvcc}] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -92,8 +92,8 @@ Set the expiry time to be sufficient to allow for all other devices to sync and |Tombstones are automatically purged from the bucket based on the server's metadata purge interval. |Manual -|Tombstones can be manually removed via Sync Gateway's xref:rest_api_admin.adoc#tag/Document/operation/post_keyspace-_purge[+/{keyspace}/_purge+] endpoint, or deleting documents directly in the bucket. -|Tombstones can be manually removed via Sync Gateway's xref:rest_api_admin.adoc#tag/Document/operation/post_keyspace-_purge[+/{keyspace}/_purge+] endpoint. +|Tombstones can be manually removed via Sync Gateway's xref:rest-api:rest_api_admin.adoc#tag/Document/operation/post_keyspace-_purge[+/{keyspace}/_purge+] endpoint, or deleting documents directly in the bucket. +|Tombstones can be manually removed via Sync Gateway's xref:rest-api:rest_api_admin.adoc#tag/Document/operation/post_keyspace-_purge[+/{keyspace}/_purge+] endpoint. |=== Purging of tombstones is also required on Couchbase Lite. @@ -122,7 +122,7 @@ Purged On | Couchbase Server | Restarting Sync Gateway will flush the cache | * Restarting Sync Gateway will flush the cache -* Running the xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_compact[+/{db}/_compact+] endpoint will remove purged tombstones from the channel cache {fn-211} +* Running the xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_compact[+/{db}/_compact+] endpoint will remove purged tombstones from the channel cache {fn-211} | Sync Gateway a| * Restarting Sync Gateway will flush the cache. @@ -174,15 +174,15 @@ Therefore, the Sync Function update will result in application downtime whilst t . Restart Sync Gateway. . Take the database offline. Use this Admin REST API endpoint: -xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_offline[+/{db}/_offline+] +xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_offline[+/{db}/_offline+] . Resync the database. Use this Admin REST API endpoint: -xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_resync[+/{db}/_resync+] +xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_resync[+/{db}/_resync+] + The message body of the response contains the number of changes that were made as a result of calling resync. . Bring the database back online. Use this Admin REST API endpoint: + -xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_online[+/{db}/_online+] +xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_online[+/{db}/_online+] === Uses @@ -207,9 +207,9 @@ Running a resync operation does not revoke access to that document. If you need to ensure access to the database during the update, you can create a read-only backup of the Sync Gateway's bucket beforehand, then run a secondary Sync Gateway on the backup bucket, in read-only mode. After the update is complete, switch to the main Gateway and bucket. -In a clustered environment with multiple Sync Gateway instances sharing the load, all the instances need to share the same configuration, so they all need to be taken offline either by stopping the process or taking them offline using the xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_offline[+/{db}/_offline+] endpoint. +In a clustered environment with multiple Sync Gateway instances sharing the load, all the instances need to share the same configuration, so they all need to be taken offline either by stopping the process or taking them offline using the xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_offline[+/{db}/_offline+] endpoint. After the configuration is updated, *one* instance should be brought up so it can update the database--if more than one is running at this time, they'll conflict with each other. After the first instance finishes opening the database, the others can be started. -include::partial$block-related-content-data.adoc[] \ No newline at end of file +include::ROOT:partial$block-related-content-data.adoc[] \ No newline at end of file diff --git a/modules/ROOT/pages/deploy-dr-cluster.adoc b/modules/ROOT/pages/deploy-dr-cluster.adoc index 92f584f47..dc553b65a 100644 --- a/modules/ROOT/pages/deploy-dr-cluster.adoc +++ b/modules/ROOT/pages/deploy-dr-cluster.adoc @@ -8,12 +8,12 @@ ifdef::prerelease[:page-status: {prerelease}] :keywords: high-availability, disaster recovery, sync, replicate, edge, cloud, dr, ha, sync gateway cluster, mobile cluster, data migration -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: deploy :param-related: {get-started-verify-install--xref} | {rest-api-admin--xref} | {rest-api--xref} | {rest-api-client-app--xref} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == Introduction @@ -96,4 +96,4 @@ image::sgw-xdcr-dr-diff-regn-in-disaster.png[,600] // end::clusters-in-diff-region[] -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/glossary.adoc b/modules/ROOT/pages/glossary.adoc index 27b6c5534..a888e80eb 100644 --- a/modules/ROOT/pages/glossary.adoc +++ b/modules/ROOT/pages/glossary.adoc @@ -9,11 +9,11 @@ ifdef::prerelease[:page-status: {prerelease}] :page-content-type: reference // End of Page Definition Statements -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] -include::partial$block-authors-notes.adoc[tag=wip] +include::ROOT:partial$block-authors-notes.adoc[tag=wip] :topic-group: {tg-ref-info} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // Glosary entry name tag format: // {component} = sgw- @@ -471,8 +471,8 @@ They have the '“_deleted”: true' property, are replicated, but are not retur } ---- Mentioned in: -* xref:manage/managing-tombstones.adoc[Managing Tombstones] -* xref:shared-bucket-access.adoc#metadata-purge-interval[Metadata Purge Interval] +* xref:manage:managing-tombstones.adoc[Managing Tombstones] +* xref:ROOT:shared-bucket-access.adoc#metadata-purge-interval[Metadata Purge Interval] * {configuration-schema-database--pfx--db}-enable_shared_bucket_access[$dbname.enable_shared_bucket_access] * xref:server:learn:buckets-memory-and-storage/storage.adoc#tombstones[Server Tombstones] // end::sgw-conf-res-tombstone[] diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 293cef057..c80cad1a7 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -10,7 +10,7 @@ = Sync Gateway Quickstart -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN: Override CSS Styles to get better alignment and spacing ++++ @@ -79,16 +79,16 @@ It serves as the synchronization server in a Couchbase Mobile deployment, enabli .Features * Data Sync - ** xref:sync/sync-with-couchbase-server.adoc[Sync with Server] -** xref:sync/sync-using-app.adoc[Sync with Application] - ** xref:access-control/sync-function/sync-function.adoc[Sync Function] - ** xref:import-filter.adoc[Import Filter] + ** xref:sync:sync-with-couchbase-server.adoc[Sync with Server] +** xref:sync:sync-using-app.adoc[Sync with Application] + ** xref:access-control:sync-function/sync-function.adoc[Sync Function] + ** xref:ROOT:import-filter.adoc[Import Filter] * Inter Sync Gateway Sync - ** xref:sync/sync-inter-syncgateway-overview.adoc[Overview] -** xref:sync/sync-inter-syncgateway-run.adoc[Initialize] -** xref:sync/sync-inter-syncgateway-manage.adoc[Manage] -** xref:sync/sync-inter-syncgateway-monitor.adoc[Monitor] + ** xref:sync:sync-inter-syncgateway-overview.adoc[Overview] +** xref:sync:sync-inter-syncgateway-run.adoc[Initialize] +** xref:sync:sync-inter-syncgateway-manage.adoc[Manage] +** xref:sync:sync-inter-syncgateway-monitor.adoc[Monitor] * {logging--xref} * {indexing--xref} diff --git a/modules/ROOT/pages/introduction.adoc b/modules/ROOT/pages/introduction.adoc index accc84081..e104c4eea 100644 --- a/modules/ROOT/pages/introduction.adoc +++ b/modules/ROOT/pages/introduction.adoc @@ -19,19 +19,19 @@ image::cbm-architecture.png[] As you can see from <> Sync Gateway synchronizes changes made by web clients through its REST API, Couchbase Lite mobile-device applications, and Couchbase Server buckets. -You can read more about the Data Synchronization process in xref:sync/sync-with-couchbase-server.adoc[Sync with Couchbase Server]. -Some of its most central, and commonly used features, are those used to secure xref:access-control/access-control-model.adoc[Access Control]. +You can read more about the Data Synchronization process in xref:sync:sync-with-couchbase-server.adoc[Sync with Couchbase Server]. +Some of its most central, and commonly used features, are those used to secure xref:access-control:access-control-model.adoc[Access Control]. Sync Gateway assures secure access control using: * **User authentication**, which ensures that only authorized users can connect to Sync Gateway. For more information see the -xref:access-control/users.adoc[Users], xref:access-control/roles.adoc[Roles] and xref:security/authentication-users.adoc[User Authentication] content. +xref:access-control:users.adoc[Users], xref:access-control:roles.adoc[Roles] and xref:security:authentication-users.adoc[User Authentication] content. -* *Data Routing*, which ensures that authorized users can only access documents in those xref:access-control/channels.adoc[Channels] assigned to them and only in accordance with their assigned privileges. -You can set those privileges to confer xref:access-control/access-control-how-control-document-access.adoc#lbl-read-access[Read Access] and-or xref:access-control/access-control-how-control-document-access.adoc#lbl-write-access[Write Access] as required. +* *Data Routing*, which ensures that authorized users can only access documents in those xref:access-control:channels.adoc[Channels] assigned to them and only in accordance with their assigned privileges. +You can set those privileges to confer xref:access-control:access-control-how-control-document-access.adoc#lbl-read-access[Read Access] and-or xref:access-control:access-control-how-control-document-access.adoc#lbl-write-access[Write Access] as required. -The business logic behind the validation and authorization of document access is provided by the customizable xref:access-control/sync-function/sync-function.adoc[Sync Function]. +The business logic behind the validation and authorization of document access is provided by the customizable xref:access-control:sync-function/sync-function.adoc[Sync Function]. == Why Use Sync Gateway? @@ -61,103 +61,103 @@ The business logic behind the validation and authorization of document access is = {empty} [.full-width-tile] -TIP: For more information about the latest changes to Sync Gateway, see xref:whatsnew.adoc[]. +TIP: For more information about the latest changes to Sync Gateway, see xref:ROOT:whatsnew.adoc[]. == Get Started Get started with Sync Gateway, from preparing your environment to installing and verifying your installation. -* xref:start-here/get-started-prepare.adoc[Prepare your environment] -* xref:start-here/get-started-install.adoc[Install Sync Gateway] -* xref:start-here/get-started-verify-install.adoc[Verify your installation] +* xref:start-here:get-started-prepare.adoc[Prepare your environment] +* xref:start-here:get-started-install.adoc[Install Sync Gateway] +* xref:start-here:get-started-verify-install.adoc[Verify your installation] == Data Modeling Learn how to design and structure your data buckets and documents using Sync Gateway. -* xref:data-modeling.adoc[] +* xref:ROOT:data-modeling.adoc[] == Configuration Learn how to configure Sync Gateway for cloud to edge synchronization including bootstrap, database settings, security, and more. -* xref:configuration/configuration-schema-bootstrap.adoc[] -* xref:configuration/configuration-schema-database.adoc[] -* xref:configuration/configuration-schema-db-security.adoc[] -* xref:configuration/configuration-schema-access-control.adoc[] -* xref:configuration/configuration-schema-import-filter.adoc[] -* xref:configuration/configuration-schema-isgr.adoc[] -* xref:configuration/configuration-javascript-functions.adoc[] -* xref:configuration/configuration-environment-variables.adoc[] +* xref:configuration:configuration-schema-bootstrap.adoc[] +* xref:configuration:configuration-schema-database.adoc[] +* xref:configuration:configuration-schema-db-security.adoc[] +* xref:configuration:configuration-schema-access-control.adoc[] +* xref:configuration:configuration-schema-import-filter.adoc[] +* xref:configuration:configuration-schema-isgr.adoc[] +* xref:configuration:configuration-javascript-functions.adoc[] +* xref:configuration:configuration-environment-variables.adoc[] == Security Implement comprehensive security measures to protect your data and control access to Sync Gateway. -* xref:security/secure-sgw-access.adoc[] -* xref:security/authentication-users.adoc[] -* xref:security/authentication-certs.adoc[] -* xref:security/audit-logging.adoc[] +* xref:security:secure-sgw-access.adoc[] +* xref:security:authentication-users.adoc[] +* xref:security:authentication-certs.adoc[] +* xref:security:audit-logging.adoc[] == Access Control Configure fine-grained access control with users, roles, channels, and sync functions. -* xref:access-control/access-control-concepts.adoc[] -* xref:access-control/sync-function/sync-function.adoc[] -* xref:access-control/access-control-how.adoc[How to] -* xref:access-control/auto-purge-channel-access-revocation.adoc[] +* xref:access-control:access-control-concepts.adoc[] +* xref:access-control:sync-function/sync-function.adoc[] +* xref:access-control:access-control-how.adoc[How to] +* xref:access-control:auto-purge-channel-access-revocation.adoc[] == REST API Interact with Sync Gateway programmatically using comprehensive REST API interfaces. -* xref:rest-api/rest-api-access.adoc[] -* xref:rest-api/rest-api-admin.adoc[] -* xref:rest-api/rest-api-metrics.adoc[] -* xref:rest-api/rest-api.adoc[] -* xref:rest-api/rest-api-access-rbac-roles.adoc[] +* xref:rest-api:rest-api-access.adoc[] +* xref:rest-api:rest-api-admin.adoc[] +* xref:rest-api:rest-api-metrics.adoc[] +* xref:rest-api:rest-api.adoc[] +* xref:rest-api:rest-api-access-rbac-roles.adoc[] == Sync Synchronize data between Sync Gateway and your applications, servers, and other Sync Gateway instances. -* xref:sync/sync-with-couchbase-server.adoc[] -* xref:sync/sync-using-app.adoc[] -* xref:sync/sync-inter-syncgateway-overview.adoc[] -* xref:sync/delta-sync.adoc[] -* xref:sync/import-processing.adoc[] +* xref:sync:sync-with-couchbase-server.adoc[] +* xref:sync:sync-using-app.adoc[] +* xref:sync:sync-inter-syncgateway-overview.adoc[] +* xref:sync:delta-sync.adoc[] +* xref:sync:import-processing.adoc[] == Manage Perform administrative and operational tasks to maintain and monitor Sync Gateway. -* xref:manage/revisions.adoc[] -* xref:manage/managing-tombstones.adoc[] -* xref:manage/resync.adoc[] -* xref:manage/stats-monitoring.adoc[] -* xref:manage/database-offline.adoc[] -* xref:manage/logging.adoc[] +* xref:manage:revisions.adoc[] +* xref:manage:managing-tombstones.adoc[] +* xref:manage:resync.adoc[] +* xref:manage:stats-monitoring.adoc[] +* xref:manage:database-offline.adoc[] +* xref:manage:logging.adoc[] == Deploy Deploy Sync Gateway in production environments with scalability and reliability considerations. -* xref:deploy/command-line-options.adoc[] -* xref:deploy/load-balancer.adoc[] -* xref:deploy/webhooks.adoc[] -* xref:deploy/stats-prometheus.adoc[] -* xref:deploy/indexing.adoc[] -* xref:use-kubernetes/deploy-cluster-to-kubernetes.adoc[] +* xref:deploy:command-line-options.adoc[] +* xref:deploy:load-balancer.adoc[] +* xref:deploy:webhooks.adoc[] +* xref:deploy:stats-prometheus.adoc[] +* xref:deploy:indexing.adoc[] +* xref:use-kubernetes:deploy-cluster-to-kubernetes.adoc[] == Server Compatibility Understand Sync Gateway compatibility with Couchbase Server features and services. -* xref:server-compatibility/server-compatibility-buckets.adoc[Buckets] -* xref:server-compatibility/server-compatibility-collections.adoc[Collections] -* xref:server-compatibility/server-compatibility-eventing.adoc[Eventing] -* xref:server-compatibility/server-compatibility-transactions.adoc[Transactions] -* xref:server-compatibility/server-compatibility-xdcr.adoc[XDCR] -* xref:server-compatibility/server-compatibility-backups.adoc[Backup and Restore] \ No newline at end of file +* xref:server-compatibility:server-compatibility-buckets.adoc[Buckets] +* xref:server-compatibility:server-compatibility-collections.adoc[Collections] +* xref:server-compatibility:server-compatibility-eventing.adoc[Eventing] +* xref:server-compatibility:server-compatibility-transactions.adoc[Transactions] +* xref:server-compatibility:server-compatibility-xdcr.adoc[XDCR] +* xref:server-compatibility:server-compatibility-backups.adoc[Backup and Restore] \ No newline at end of file diff --git a/modules/ROOT/pages/rest-api/rest_api_admin.adoc b/modules/ROOT/pages/rest-api/rest_api_admin.adoc deleted file mode 100644 index 88acd22f5..000000000 --- a/modules/ROOT/pages/rest-api/rest_api_admin.adoc +++ /dev/null @@ -1,8 +0,0 @@ -:page-layout: rest-api -:page-aliases: rest_api_admin_static.adoc, rest_api_admin.adoc -:doctitle: Sync Gateway Admin API Reference -:navtitle: Admin API Reference - -++++ -include::partial$sgw-openapi-admin.html[] -++++ diff --git a/modules/ROOT/pages/rest-api/rest_api_metric.adoc b/modules/ROOT/pages/rest-api/rest_api_metric.adoc deleted file mode 100644 index 87a905c9b..000000000 --- a/modules/ROOT/pages/rest-api/rest_api_metric.adoc +++ /dev/null @@ -1,8 +0,0 @@ -:page-layout: rest-api -:doctitle: Sync Gateway Metrics API Reference -:navtitle: Metrics API Reference -:page-aliases: rest_api_metrics_static.adoc, rest_api_metric.adoc - -++++ -include::partial$sgw-openapi-metric.html[] -++++ diff --git a/modules/ROOT/pages/rest-api/rest_api_public.adoc b/modules/ROOT/pages/rest-api/rest_api_public.adoc deleted file mode 100644 index f5331a250..000000000 --- a/modules/ROOT/pages/rest-api/rest_api_public.adoc +++ /dev/null @@ -1,8 +0,0 @@ -:page-layout: rest-api -:doctitle: Sync Gateway Public API Reference -:navtitle: Public API Reference -:page-aliases: rest_api_public_static.adoc, rest_api_public.adoc - -++++ -include::partial$sgw-openapi-public.html[] -++++ diff --git a/modules/ROOT/pages/sync/sync-inter-syncgateway-manage.adoc b/modules/ROOT/pages/sync/sync-inter-syncgateway-manage.adoc deleted file mode 100644 index 7f41b345f..000000000 --- a/modules/ROOT/pages/sync/sync-inter-syncgateway-manage.adoc +++ /dev/null @@ -1,21 +0,0 @@ -= Manage Inter-Sync Gateway Replications -:page-aliases: learn/icr-admin.adoc, icr-admin.adoc, sync-inter-syncgateway-manage.adoc -ifdef::show_edition[:page-edition: {release}] -ifdef::prerelease[:page-status: {prerelease}] -:page-role: -:description: Managing inter-Sync Gateway replications -:keywords: cloud edge sync replicate - -include::partial$_set_page_context.adoc[] - - -:param-topic-group: inter-syncgateway -:param-related: {configuration-properties-legacy--xref} | {rest-api-admin--xref} -:param-abstract!: -include::partial$_show_page_header_block.adoc[] - -include::partial$block-caveats.adoc[tags=sgr2-only] - -include::partial$incpg-icr-admin.adoc[tags=!in-this-section] - -include::partial$block-related-content-icr.adoc[] diff --git a/modules/ROOT/pages/sync/sync-inter-syncgateway-run.adoc b/modules/ROOT/pages/sync/sync-inter-syncgateway-run.adoc deleted file mode 100644 index a4437032c..000000000 --- a/modules/ROOT/pages/sync/sync-inter-syncgateway-run.adoc +++ /dev/null @@ -1,21 +0,0 @@ -= Initialize Inter-Sync Gateway Replications -:page-aliases: running-replications.adoc, learn/icr-running.adoc, icr-running.adoc, sync-inter-syncgateway-run.adoc -ifdef::show_edition[:page-edition: {release}] -ifdef::prerelease[:page-status: {prerelease}] -:page-role: -:description: Initializing and running inter-Sync Gateway replication - -include::partial$_set_page_context.adoc[] - -:param-topic-group: inter-syncgateway -:param-related: {configuration-properties-legacy--xref} | {rest-api-admin--xref} -:param-abstract!: -include::partial$_show_page_header_block.adoc[] - -include::partial$static_restapi/css.adoc[] - -include::partial$block-caveats.adoc[tags=sgr2-only] - -include::partial$incpg-icr-initialization.adoc[tags=!in-this-section] - -include::partial$block-related-content-icr.adoc[] diff --git a/modules/ROOT/pages/upgrading.adoc b/modules/ROOT/pages/upgrading.adoc index e64a87e9e..ec17a916a 100644 --- a/modules/ROOT/pages/upgrading.adoc +++ b/modules/ROOT/pages/upgrading.adoc @@ -25,7 +25,7 @@ ifdef::prerelease[:page-status: {prerelease}] :page-content: procedural :description: This page documents various implementation details and functionalities to consider when performing an upgrade to Sync Gateway {page-component-version}. -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :sc1title: Continue with SG Replicate (no conflict resolution) :sc2title: Continue with SG Replicate (custom conflict resolution) @@ -37,7 +37,7 @@ include::partial$_set_page_context.adoc[] :param-abstract: :topic-group: Application Deployment :param-related: {get-started-prepare--xref} | {get-started-install--xref} | {release-notes--xref} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == Upgrade Approaches @@ -152,7 +152,7 @@ To opt out of this, you can configure {bootstrap-schema--xref--api-admin-interf === Use Legacy-mode Configuration :no-admonition: -include::partial$block-caveats.adoc[tags=disable-persistent-config] +include::ROOT:partial$block-caveats.adoc[tags=disable-persistent-config] == 1.x to 2.x No Views @@ -184,7 +184,7 @@ Then, Sync Gateway will wait until indexes are available before starting to serv === Tidy-up Sync Gateway 2.1 or above will *not* automatically remove the previously used design documents. -Removal of the obsolete design documents is done via a call to the xref:rest_api_admin.adoc#tag/Server/operation/post__post_upgrade[+/_post_upgrade+] endpoint in Sync Gateway`'s Admin REST API. +Removal of the obsolete design documents is done via a call to the xref:rest-api:rest_api_admin.adoc#tag/Server/operation/post__post_upgrade[+/_post_upgrade+] endpoint in Sync Gateway`'s Admin REST API. This endpoint can be run in preview mode (`?preview=true`) to see which design documents would be removed. @@ -234,7 +234,7 @@ If the view request exceeds the default timeout of 75s (which would be expected === Tidy-up Sync Gateway 2.0 will *not* automatically remove the previous design documents. -Removal of the obsolete design documents is done via a call to the xref:rest_api_admin.adoc#tag/Server/operation/post__post_upgrade[`_post_upgrade`] endpoint in Sync Gateway's Admin REST API. +Removal of the obsolete design documents is done via a call to the xref:rest-api:rest_api_admin.adoc#tag/Server/operation/post__post_upgrade[`_post_upgrade`] endpoint in Sync Gateway's Admin REST API. This endpoint can be run in preview mode (`?preview=true`) to see which design documents would be removed. @@ -649,7 +649,7 @@ They are also accessible from {sqlpp} in Couchbase Server 5.5 or above with the WARNING: The sync metadata is maintained internally by Sync Gateway and its structure can change at any time. It should not be used to drive business logic of applications. The direct use of the {sqlpp} query is unsupported and must not be used in production environments. -The xref:rest_api_admin.adoc#tag/Document/operation/get_keyspace-_raw-docid[raw] +The xref:rest-api:rest_api_admin.adoc#tag/Document/operation/get_keyspace-_raw-docid[raw] endpoint on Sync Gateway's Admin REST API returns both the document and its associated mobile metadata. @@ -669,7 +669,7 @@ To enable shared bucket access on incoming documents, set the `import_docs`: `tr Enabling shared bucket access on your existing deployment is *not* reversible. It is recommended to test the upgrade on a staging environment before upgrading the production environment. -The known issue xref:release-notes.adoc#2-5-0[CBG-394], means that the upgrade will *require downtime* when enabling shared bucket access on an existing deployment that is running with GSI indexing. This is to allow all documents to migrate, using index-based data requests whilst migration is in progress could result in an incomplete data set being returned (containing only those docs migrated at the time of the request). You are advised to schedule a maintenance window to allow time for migration to complete. +The known issue xref:product-notes:release-notes.adoc#2-5-0[CBG-394], means that the upgrade will *require downtime* when enabling shared bucket access on an existing deployment that is running with GSI indexing. This is to allow all documents to migrate, using index-based data requests whilst migration is in progress could result in an incomplete data set being returned (containing only those docs migrated at the time of the request). You are advised to schedule a maintenance window to allow time for migration to complete. | *Sync Gateway 2.1 to 3.2* `num_index_replicas: 2` (or n) @@ -696,7 +696,7 @@ The following steps outline a recommended method for migrating from Bucket Shado image:bucket-shadowing-migration.png[] -include::partial$block-related-content-deploy.adoc[] +include::ROOT:partial$block-related-content-deploy.adoc[] // END -- PAGE -- upgrading.adoc diff --git a/modules/ROOT/pages/whatsnew.adoc b/modules/ROOT/pages/whatsnew.adoc index c489d61a7..9a5312f47 100644 --- a/modules/ROOT/pages/whatsnew.adoc +++ b/modules/ROOT/pages/whatsnew.adoc @@ -14,9 +14,9 @@ include::ROOT:partial$_set_page_context.adoc[] :param-abstract: This content covers the new features introduced in Sync Gateway {release} :param-related: {xref-sgw-pg-release-notes} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] -include::partial$block-caveats.adoc[tags=eventing-mixed-mode] +include::ROOT:partial$block-caveats.adoc[tags=eventing-mixed-mode] == Release 3.3.0 (July 2025) @@ -33,17 +33,17 @@ They may decrease performance, as each partition is queried separately and resul You should only migrate to partitioned indexes in cases where you are using memory-optimized indexes which exceed the memory capacity of a single index node, and you cannot reduce the index size using collections or database sharding. -For more information, see xref:deploy/index-partitions.adoc[]. +For more information, see xref:deploy:index-partitions.adoc[]. ==== Disable the Public All Docs Endpoint -Sync Gateway 3.3 introduces an option to disable the xref:rest_api_public.adoc#tag/Document/operation/get_keyspace-_all_docs[`GET /{keyspace}/_all_docs`] operation in the Public REST API. +Sync Gateway 3.3 introduces an option to disable the xref:rest-api:rest_api_public.adoc#tag/Document/operation/get_keyspace-_all_docs[`GET /{keyspace}/_all_docs`] operation in the Public REST API. That operation is intended mainly for debugging in a small setup. With a large number of documents, it may lead to timeouts and out-of-memory conditions on the Query nodes. -In any sizeable setup, it is recommended that you should instead use the xref:rest_api_public.adoc#tag/Database-Management/operation/get_keyspace-_changes[`GET /{keyspace}/_changes`] operation to get all documents for a user, or the xref:rest_api_public.adoc#tag/Document/operation/post_keyspace-_bulk_docs[`POST /{keyspace}/_bulk_docs`] operation to return a specific subset of documents. +In any sizeable setup, it is recommended that you should instead use the xref:rest-api:rest_api_public.adoc#tag/Database-Management/operation/get_keyspace-_changes[`GET /{keyspace}/_changes`] operation to get all documents for a user, or the xref:rest-api:rest_api_public.adoc#tag/Document/operation/post_keyspace-_bulk_docs[`POST /{keyspace}/_bulk_docs`] operation to return a specific subset of documents. -To disable the xref:rest_api_public.adoc#tag/Document/operation/get_keyspace-_all_docs[`GET /{keyspace}/_all_docs`] operation in the Public REST API, set xref:configuration/configuration-schema-database.adoc#disable_public_all_docs[`disable_public_all_docs`] to `true` in the database configuration. +To disable the xref:rest-api:rest_api_public.adoc#tag/Document/operation/get_keyspace-_all_docs[`GET /{keyspace}/_all_docs`] operation in the Public REST API, set xref:configuration:configuration-schema-database.adoc#disable_public_all_docs[`disable_public_all_docs`] to `true` in the database configuration. This option is set to `false` by default; it will be set to `true` by default in a future release. ==== Interactive Admin Credentials for SG Collect Info @@ -54,7 +54,7 @@ Attempting to use the `--sync-gateway-password` option causes an error, with ins Alternatively, you can set credentials using the `SG_USERNAME` and `SG_PASSWORD` environment variables to avoid the prompt. -For more information, see xref:manage/sgcollect-info.adoc[]. +For more information, see xref:manage:sgcollect-info.adoc[]. ==== Performance Improvements for Larger Deployments @@ -69,11 +69,11 @@ xref:3.2@sync-gateway:ROOT:whatsnew.adoc[What's new in previous version 3.2]. === Sync Gateway Release Notes -xref:product-notes/release-notes.adoc[Read the full 3.3 release notes here]. +xref:product-notes:release-notes.adoc[Read the full 3.3 release notes here]. == Upgrading -xref:upgrading.adoc[]. +xref:ROOT:upgrading.adoc[]. -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] diff --git a/modules/ROOT/pages/_partials/_define_component_attributes.adoc b/modules/ROOT/partials/_define_component_attributes.adoc similarity index 94% rename from modules/ROOT/pages/_partials/_define_component_attributes.adoc rename to modules/ROOT/partials/_define_component_attributes.adoc index 24b984b29..e0fb599a4 100644 --- a/modules/ROOT/pages/_partials/_define_component_attributes.adoc +++ b/modules/ROOT/partials/_define_component_attributes.adoc @@ -95,9 +95,9 @@ ifeval::["{page-toclevels}" == "2"] endif::[] // Set global switches -:concepts: partial$concepts/ -:howto: partial$howto/how-to- -:sync-api: partial$sync-api/how-to- +:concepts: ROOT:partial$concepts/ +:howto: ROOT:partial$howto/how-to- +:sync-api: ROOT:partial$sync-api/how-to- // Sync Gateway Common url links @@ -168,12 +168,12 @@ endif::[] :ns: None specified :examples: -:example-cfg: example$configuration/sync-gateway-config.json -:example-restapi: example$configuration/sync-gateway-restapi.adoc +:example-cfg: ROOT:example$configuration/sync-gateway-config.json +:example-restapi: ROOT:example$configuration/sync-gateway-restapi.adoc -:examples-lib: example$examples-library.adoc -:examples-code-csharp: example$code/csharp/cbsSdkUserXattrKeySol/cbsSdkUserXattrKeyProj/Program.cs -:examples-code-js: example$/code/javascript/javasnippets.js +:examples-lib: ROOT:example$examples-library.adoc +:examples-code-csharp: ROOT:example$code/csharp/cbsSdkUserXattrKeySol/cbsSdkUserXattrKeyProj/Program.cs +:examples-code-js: ROOT:example$/code/javascript/javasnippets.js // Define a standard snippet / terminal header :snippet-header: source, bash, subs="+attributes, +macro" @@ -256,7 +256,7 @@ ifdef::releasetag[:tag: -{releasetag}] :fn_post270: footnote:fnpost270[Since 2.7] :fnref_post270: footnote:fnpost270[] -:fn_legacy: footnote:fnlegacy[For Pre-3.0 legacy configuration see: xref:configuration/configuration-properties-legacy.adoc[Configuration Properties (legacy Pre3.0)]] +:fn_legacy: footnote:fnlegacy[For Pre-3.0 legacy configuration see: xref:configuration:configuration-properties-legacy.adoc[Configuration Properties (legacy Pre3.0)]] :fnref_legacy: footnote:fnlegacy[] diff --git a/modules/ROOT/pages/_partials/_define_glossary_links.adoc b/modules/ROOT/partials/_define_glossary_links.adoc similarity index 95% rename from modules/ROOT/pages/_partials/_define_glossary_links.adoc rename to modules/ROOT/partials/_define_glossary_links.adoc index f0fa0cc83..cb494fd88 100644 --- a/modules/ROOT/pages/_partials/_define_glossary_links.adoc +++ b/modules/ROOT/partials/_define_glossary_links.adoc @@ -1,13 +1,13 @@ // inclusion // removed commented out docs-mobile _attributes-shared link -include::partial$_define_component_attributes.adoc[] +include::ROOT:partial$_define_component_attributes.adoc[] // :sgw--xref: {sgw--xref}: -include::partial$_define_page_index.adoc[] +include::ROOT:partial$_define_page_index.adoc[] :_glos--pfx: {sgw--xref}{sgw-pg-refer-sgw-glossary}# -:glossicon: image:icons/glossaryIconImage2.png[glossary icon,14] +:glossicon: image:ROOT:icons/glossaryIconImage2.png[glossary icon,14] // A diff --git a/modules/ROOT/pages/_partials/_define_page_index.adoc b/modules/ROOT/partials/_define_page_index.adoc similarity index 88% rename from modules/ROOT/pages/_partials/_define_page_index.adoc rename to modules/ROOT/partials/_define_page_index.adoc index 45faac41f..48e4d9b2e 100644 --- a/modules/ROOT/pages/_partials/_define_page_index.adoc +++ b/modules/ROOT/partials/_define_page_index.adoc @@ -123,180 +123,180 @@ endif::xref--pfx-sgw[] // BEGIN -- SYNC GATEWAY PAGE ATTRIBUTES -:access--control-model--page: access-control/access-control-model.adoc +:access--control-model--page: access-control:access-control-model.adoc :access--control-model--xref: {sgw--xref}{access--control-model--page}[Access Control Model] -:access-control-overview--page: access-control/access-control-overview.adoc +:access-control-overview--page: access-control:access-control-overview.adoc :access-control-overview--xref: {sgw--xref}{access-control-overview--page}[Access Control Overview] -:access-control-concepts--page: access-control/access-control-concepts.adoc +:access-control-concepts--page: access-control:access-control-concepts.adoc :access-control-concepts--xref: {sgw--xref}{access-control-concepts--page}[Access Control Concepts] -:access-control-how--page: access-control/access-control-how.adoc +:access-control-how--page: access-control:access-control-how.adoc :access-control-how--xref: {sgw--xref}{access-control-how--page}[Access Control How-to] -:access-control-how-assign-users-to-roles--page: access-control/access-control-how-assign-users-to-roles.adoc +:access-control-how-assign-users-to-roles--page: access-control:access-control-how-assign-users-to-roles.adoc :access-control-how-assign-users-to-roles--xref: {sgw--xref}{access-control-how-assign-users-to-roles--page}[Assign Users to Roles] -:access-control-how-control-document-access--page: access-control/access-control-how-control-document-access.adoc +:access-control-how-control-document-access--page: access-control:access-control-how-control-document-access.adoc :access-control-how-control-document-access--xref: {sgw--xref}{access-control-how-control-document-access--page}[Control Document Access] :access-control-how-control-document-access--xref-write-access: {sgw--xref}{access-control-how-control-document-access--page}[Control Write Access] -:access-control-how-create-roles--page: access-control/access-control-how-create-roles.adoc +:access-control-how-create-roles--page: access-control:access-control-how-create-roles.adoc :access-control-how-create-roles--xref: {sgw--xref}{access-control-how-create-roles--page}[Create Roles] -:access-control-how-create-users--page: access-control/access-control-how-create-users.adoc +:access-control-how-create-users--page: access-control:access-control-how-create-users.adoc :access-control-how-create-users--xref: {sgw--xref}{access-control-how-create-users--page}[Create Users] -:access-control-how-verify-access--page: access-control/access-control-how-verify-access.adoc +:access-control-how-verify-access--page: access-control:access-control-how-verify-access.adoc :access-control-how-verify-access--xref: {sgw--xref}{access-control-how-verify-access--page}[Verify Access] -:access-control-how-use-xattrs--page: access-control/access-control-how-use-xattrs.adoc +:access-control-how-use-xattrs--page: access-control:access-control-how-use-xattrs.adoc :access-control-how-use-xattrs--xref: {sgw--xref}{access-control-how-use-xattrs--page}[Use XATTRS for Access Grants] -:access-control-how-write-access--page: access-control/access-control-how-write-access.adoc +:access-control-how-write-access--page: access-control:access-control-how-control-document-access.adoc :access-control-how-write-access--xref: {sgw--xref}{access-control-how-write-access--page}[Write Access] -:access-control-how-use-xattrs-for-access-grants--page: access-control/access-control-how-use-xattrs-for-access-grants.adoc +:access-control-how-use-xattrs-for-access-grants--page: access-control:access-control-how-use-xattrs-for-access-grants.adoc :access-control-how-use-xattrs-for-access-grants--xref: {sgw--xref}{access-control-how-use-xattrs-for-access-grants--page}[Use XATTRs for Access Grants] -:access-control-model--page: access-control/access-control-model.adoc +:access-control-model--page: access-control:access-control-model.adoc :access-control-model--xref: {sgw--xref}{access-control-model--page}[Access control Model] -:access-grants--page: access-control/access-grants.adoc +:access-grants--page: access-control:access-grants.adoc :access-grants--xref: {sgw--xref}{access-grants--page}[Access Grants] :access-grants--xref-access-grant: {sgw--xref}{access-grants--page}#lbl-access-grants[Access Grants] :access-grants--xref-control-write-access: {sgw--xref}{access-grants--page}#lbl-control-write-access[Controlling Write Access] :access-grants--xref: {sgw--xref}{access-grants--page}[Access Grants] // Begin -- Authentication Certs Cross-Reference Attributes -:authentication-certs--page: security/authentication-certs.adoc +:authentication-certs--page: security:authentication-certs.adoc :authentication-certs--xref: {sgw--xref}{authentication-certs--page}[TLS Certificate Authentication] -:authentication-users--page: security/authentication-users.adoc +:authentication-users--page: security:authentication-users.adoc :authentication-users--xref: {sgw--xref}{authentication-users--page}[User Authentication] // End -- Authentication Certs Cross-Reference Attributes // Begin -- Audit Logging Cross-Reference Attributes -:audit-logging--page: security/audit-logging.adoc +:audit-logging--page: security:audit-logging.adoc :audit-logging--xref: {sgw--xref}{audit-logging--page}[Audit Logging] -:manage-audit-logs--page: security/manage-audit-logs.adoc +:manage-audit-logs--page: security:manage-audit-logs.adoc :manage-audit-logs--xref: {sgw--xref}{manage-audit-logs--page}[Manage Audit Logs] -:audit-log-events--page: security/audit-log-events.adoc +:audit-log-events--page: security:audit-log-events.adoc :audit-log-events--xref: {sgw--xref}{audit-log-events--page}[Audit Log Events] // End -- Audit Logging Cross-Reference Attributes -:auto-purge-channel-access-revocation--page: access-control/auto-purge-channel-access-revocation.adoc +:auto-purge-channel-access-revocation--page: access-control:auto-purge-channel-access-revocation.adoc :auto-purge-channel-access-revocation--xref: {sgw--xref}{auto-purge-channel-access-revocation--page}[Auto-purge on Channel Access Revocation] -:changes-feed--page: deploy/changes-feed.adoc +:changes-feed--page: deploy:changes-feed.adoc :changes-feed--xref: {sgw--xref}{changes-feed--page}[Changes Feed] // Begin -- Channels Cross-Reference Attributes -:channels--page: access-control/channels.adoc +:channels--page: access-control:channels.adoc :channels--xref: {sgw--xref}{channels--page}[Channels] :channel--xref: {sgw--xref}{channels--page}[Channel] :channels--xref-public-channel: {sgw--xref}{channels--page}#lbl-public-channel[Public Channel] // End -- Channels Cross-Reference Attributes -:command-line-options--page: deploy/command-line-options.adoc +:command-line-options--page: deploy:command-line-options.adoc :command-line-options--xref: {sgw--xref}{command-line-options--page}[Command Line Options] -:compatibility--page: compatibility.adoc +:compatibility--page: product-notes:compatibility.adoc :compatibility--xref: {sgw--xref}{compatibility--page}[Compatibility Matrix] -:configuration-environment-variables--page: configuration/configuration-environment-variables.adoc +:configuration-environment-variables--page: configuration:configuration-environment-variables.adoc :configuration-environment-variables--xref: {sgw--xref}{configuration-environment-variables--page}[Configuration Environment Variables] -:configuration-javascript-functions--page: configuration/configuration-javascript-functions.adoc +:configuration-javascript-functions--page: configuration:configuration-javascript-functions.adoc :configuration-javascript-functions--xref: {sgw--xref}{configuration-javascript-functions--page}[Configuration Javascript Functions] -:configuration-overview--page: configuration/configuration-overview.adoc +:configuration-overview--page: configuration:configuration-overview.adoc :configuration-overview--pfx: {sgw--xref}{configuration-overview--page} :configuration-overview--xref: {configuration-overview--pfx}[Configuration Overview] :configuration-overview--xref--groups: {configuration-overview--pfx}#lbl-config-grp[Configuration Groups] -:configuration-rest-api--page: configuration/configuration-rest-api.adoc +:configuration-rest-api--page: configuration:configuration-rest-api.adoc :configuration-rest-api--xref: {sgw--xref}{configuration-rest-api--page}[Configuration REST API] -:configuration-schema-database--page: configuration/configuration-schema-database.adoc +:configuration-schema-database--page: configuration:configuration-schema-database.adoc :configuration-schema-database--xref: {sgw--xref}{configuration-schema-database--page}[Database Configuration] :configuration-schema-database--xref--enable-shared-bucket-access: {sgw--xref}{configuration-schema-database--page}#enable_shared_bucket_access[database.enable_shared_bucket_access] :configuration-schema-database--xref-user-xattr-key: {sgw--xref}{configuration-schema-database--page}#databases-this_db-user_xattr_key[user_xattr_key] -:configuration-schema-db-security--page: configuration/configuration-schema-db-security.adoc +:configuration-schema-db-security--page: configuration:configuration-schema-db-security.adoc :configuration-schema-db-security--xref: {sgw--xref}{configuration-schema-db-security--page}[Database Security Configuration] -:configuration-schema-access-control--page: configuration/configuration-schema-access-control.adoc +:configuration-schema-access-control--page: configuration:configuration-schema-access-control.adoc :configuration-schema-access-control--xref: {sgw--xref}{configuration-schema-access-control--page}[Access Control Configuration] -:configuration-schema-import-filter--page: configuration/configuration-schema-import-filter.adoc +:configuration-schema-import-filter--page: configuration:configuration-schema-import-filter.adoc :configuration-schema-import-filter--xref: {sgw--xref}{configuration-schema-import-filter--page}[Import Filter Configuration] -:configuration-schema-isgr--page: configuration/configuration-schema-isgr.adoc +:configuration-schema-isgr--page: configuration:configuration-schema-isgr.adoc :configuration-schema-isgr--xref: {sgw--xref}{configuration-schema-isgr--page}[Inter-Sync Gateway Configuration] -:conflict-resolution--page: conflict-resolution.adoc +:conflict-resolution--page: ROOT:conflict-resolution.adoc :conflict-resolution--xref: {sgw--xref}{conflict-resolution--page}[Conflict Resolution] -:couchbase-mobile-index--page: couchbase-mobile-index.adoc +:couchbase-mobile-index--page: ROOT:couchbase-mobile-index.adoc :couchbase-mobile-index--xref: {sgw--xref}{couchbase-mobile-index--page}[Couchbase Mobile Index] -:data-modeling--page: data-modeling.adoc +:data-modeling--page: ROOT:data-modeling.adoc :data-modeling--xref: {sgw--xref}{data-modeling--page}[Data Modeling] -:database-offline--page: manage/database-offline.adoc +:database-offline--page: manage:database-offline.adoc :database-offline--xref: {sgw--xref}{database-offline--page}[Database Offline] -:delta-sync--page: sync/delta-sync.adoc +:delta-sync--page: sync:delta-sync.adoc :delta-sync--xref: {sgw--xref}{delta-sync--page}[Delta Sync] -:deploy-cluster-to-kubernetes--page: use-kubernetes/deploy-cluster-to-kubernetes.adoc +:deploy-cluster-to-kubernetes--page: use-kubernetes:deploy-cluster-to-kubernetes.adoc :deploy-cluster-to-kubernetes--xref: {sgw--xref}{deploy-cluster-to-kubernetes--page}[Deploy Cluster To Kubernetes] -:deployment--page: deploy/deployment.adoc +:deployment--page: deploy:deployment.adoc :deployment--xref: {sgw--xref}{deployment--page}[Deployment] -:rest-api-access--page: rest-api/rest-api-access.adoc +:rest-api-access--page: rest-api:rest-api-access.adoc :rest-api-access--xref: {sgw--xref}{rest-api-access--page}[REST API Access] -:rest-api-access-rbac-roles--xref: {sgw--xref}rest-api/rest-api-access-rbac-roles.adoc[RBAC Role - Endpoint Cross-Reference] +:rest-api-access-rbac-roles--xref: {sgw--xref}rest-api:rest-api-access-rbac-roles.adoc[RBAC Role - Endpoint Cross-Reference] -:get-started-configure-server--page: get-started-configure-server.adoc +:get-started-configure-server--page: start-here:get-started-prepare.adoc#configure-server :get-started-configure-server--xref: {sgw--xref}{get-started-configure-server--page}[Configure Server for Sync Gateway] -:get-started-install--page: start-here/get-started-install.adoc +:get-started-install--page: start-here:get-started-install.adoc :get-started-install--xref: {sgw--xref}{get-started-install--page}[Install] -:get-started-prepare--page: start-here/get-started-prepare.adoc +:get-started-prepare--page: start-here:get-started-prepare.adoc :get-started-prepare--pfx: {sgw--xref}{get-started-prepare--page} :get-started-prepare--xref: {get-started-prepare--pfx}[Prepare] :get-started-prepare--config-server--xref: {get-started-prepare--pfx}#configure-server[Configure Server for Sync Gateway] :get-started-prepare--xref--create-rbac-users: {get-started-prepare--pfx}#step-2create-rbac-user[Create RBAC users] -:get-started-verify-install--page: start-here/get-started-verify-install.adoc +:get-started-verify-install--page: start-here:get-started-verify-install.adoc :get-started-verify-install--xref: {sgw--xref}{get-started-verify-install--page}[Verify] -:glossary--page: glossary.adoc +:glossary--page: ROOT:glossary.adoc :glossary--xref: {sgw--xref}{glossary--page}[Glossary] -:import-filter--page: import-filter.adoc +:import-filter--page: ROOT:import-filter.adoc :import-filter--xref: {sgw--xref}{import-filter--page}[Import filter] -:import-process--page: import-process.adoc +:import-process--page: sync:import-processing.adoc :import-process--xref: {sgw--xref}{import-process--page}[Import Process] -:index--page: index.adoc +:index--page: ROOT:index.adoc :index--xref: {sgw--xref}{index--page}[Index] -:indexing--page: deploy/indexing.adoc +:indexing--page: deploy:indexing.adoc :indexing--xref: {sgw--xref}{indexing--page}[Indexing] -:index-partitions--page: deploy/index-partitions.adoc +:index-partitions--page: deploy:index-partitions.adoc :index-partitions--xref: {sgw--xref}{index-partitions--page}[Index Partitions] :integrating-external-stores--page: integrating-external-stores.adoc :integrating-external-stores--xref: {sgw--xref}{integrating-external-stores--page}[Integrating External Stores] -:introduction--page: introduction.adoc +:introduction--page: ROOT:introduction.adoc :introduction--xref: {sgw--xref}{introduction--page}[Introduction] -:configuration-schema-bootstrap--page: configuration/configuration-schema-bootstrap.adoc +:configuration-schema-bootstrap--page: configuration:configuration-schema-bootstrap.adoc :bootstrap-schema--pfx: {sgw--xref}{configuration-schema-bootstrap--page} :bootstrap-schema--xref: {bootstrap-schema--pfx}[Bootstrap Configuration] :configuration-schema-bootstrap--xref: {bootstrap-schema--pfx}[Bootstrap Configuration] @@ -516,7 +516,7 @@ endif::xref--pfx-sgw[] // LEGACY CONFIG -:configuration-properties-legacy--page: configuration/configuration-properties-legacy.adoc +:configuration-properties-legacy--page: configuration:configuration-properties-legacy.adoc :configuration-properties-legacy--pfx: {sgw--xref}{configuration-properties-legacy--page} :configuration-properties-legacy--pfx--db: {configuration-properties-legacy--pfx}#databases @@ -596,33 +596,31 @@ endif::xref--pfx-sgw[] :configuration-properties-legacy--xref--schema: {configuration-properties-legacy--pfx}#configuration-reference[Configuration] -:load-balancer--page: deploy/load-balancer.adoc +:load-balancer--page: deploy:load-balancer.adoc :load-balancer--xref: {sgw--xref}{load-balancer--page}[Load Balancer] -:logging--page: manage/logging.adoc +:logging--page: manage:logging.adoc :logging--xref: {sgw--xref}{logging--page}[Logging] -:managing-tombstones--page: manage/managing-tombstones.adoc +:managing-tombstones--page: manage:managing-tombstones.adoc :managing-tombstones--xref: {sgw--xref}{managing-tombstones--page}[Managing Tombstones] -:os-level-tuning--page: deploy/os-level-tuning.adoc +:os-level-tuning--page: deploy:os-level-tuning.adoc :os-level-tuning--xref: {sgw--xref}{os-level-tuning--page}[OS-Level Tuning] :quickstart--page: quickstart.adoc :quickstart--xref: {sgw--xref}{quickstart--page}[Quickstart] -:read-access--page: access-control-how-control-document-access.adoc#lbl-read-access +:read-access--page: access-control:access-control-how-control-document-access.adoc#lbl-read-access :read-access--xref: {sgw--xref}{read-access--page}[Read Access] -:deploy-read-only-dr-cluster--page: deploy-dr-cluster.adoc +:deploy-read-only-dr-cluster--page: ROOT:deploy-dr-cluster.adoc :deploy-read-only-dr-cluster--xref: {sgw--xref}{deploy-read-only-dr-cluster--page}[Deploy DR Cluster] -:release-notes--page: releasenotes.adoc -:release-notes--xref: {sgw--xref}{release-notes--page}[Release Notes] -:release-notes--page: release-notes.adoc +:release-notes--page: product-notes:release-notes.adoc :release-notes--xref: {sgw--xref}{release-notes--page}[Release Notes] -:rest-api--page: rest-api/rest-api.adoc +:rest-api--page: rest-api:rest-api.adoc :rest-api--xref: {sgw--xref}{rest-api--page}[Public REST API] // :configuration-schema-database--page: rest-api-admin-database.adoc @@ -634,36 +632,36 @@ endif::xref--pfx-sgw[] // :configuration-schema-access-control--page: rest-api-admin-access-control.adoc // :configuration-schema-access-control--xref: {sgw--xref}{configuration-schema-access-control--page}[Access Control Configuration API] -:configuration-schema--isgr--page: configuration/configuration-schema-isgr.adoc +:configuration-schema--isgr--page: configuration:configuration-schema-isgr.adoc :configuration-schema--isgr--xref: {sgw--xref}{configuration-schema--isgr--page}[Inter-Sync{nbsp}Replication Configuration API] -:rest-api-admin--page: rest-api/rest-api-admin.adoc +:rest-api-admin--page: rest-api:rest-api-admin.adoc :rest-api-admin--pfx: {sgw--xref}{rest-api-admin--page} :rest-api-admin--xref: {rest-api-admin--pfx}[Admin REST API] -:rest-api-admin--pfx--database-configuration: xref:rest_api_admin.adoc#tag/Database-Configuration +:rest-api-admin--pfx--database-configuration: xref:rest-api:rest_api_admin.adoc#tag/Database-Configuration :rest-api-admin--xref--database-configuration: {rest-api-admin--pfx--database-configuration}[Database Configuration] -:rest-api-admin--xref--database-security: xref:rest_api_admin.adoc#tag/Database-Security[Database Security] -:rest-api-admin--xref--access-control: xref:rest_api_admin.adoc#tag/Authentication[Authentication] +:rest-api-admin--xref--database-security: xref:rest-api:rest_api_admin.adoc#tag/Database-Security[Database Security] +:rest-api-admin--xref--access-control: xref:rest-api:rest_api_admin.adoc#tag/Authentication[Authentication] :rest-api-admin--xref--import-filter: {rest-api-admin--pfx--database-configuration}/operation/put_keyspace-_config-import_filter[/\{keyspace}/_config/import_filter] :rest-api-admin--xref--sync-function: {rest-api-admin--pfx--database-configuration}/operation/put_keyspace-_config-sync[\{keyspace\}/_config/sync] -:rest-api-admin--xref--replication: xref:rest_api_admin.adoc#tag/Replication[Replication] +:rest-api-admin--xref--replication: xref:rest-api:rest_api_admin.adoc#tag/Replication[Replication] -:rest-api-admin-role-get--xref: xref:rest_api_admin.adoc#tag/Database-Security/operation/get_db-_role-name[/\{db}/_role/\{name}] -:rest-api-admin-role-post--xref: xref:rest_api_admin.adoc#tag/Database-Security/operation/post_db-_role-[/\{db}/_role/] -:rest-api-admin-role-put--xref: xref:rest_api_admin.adoc#tag/Database-Security/operation/put_db-_role-name[/\{db}/_role/\{name}] +:rest-api-admin-role-get--xref: xref:rest-api:rest_api_admin.adoc#tag/Database-Security/operation/get_db-_role-name[/\{db}/_role/\{name}] +:rest-api-admin-role-post--xref: xref:rest-api:rest_api_admin.adoc#tag/Database-Security/operation/post_db-_role-[/\{db}/_role/] +:rest-api-admin-role-put--xref: xref:rest-api:rest_api_admin.adoc#tag/Database-Security/operation/put_db-_role-name[/\{db}/_role/\{name}] -:rest-api-admin-user-get--xref: xref:rest_api_admin.adoc#tag/Database-Security/operation/get_db-_user-name[/\{db}/_user/\{name}] -:rest-api-admin-user-post--xref: xref:rest_api_admin.adoc#tag/Database-Security/operation/post_db-_user-[/\{db}/_user] -:rest-api-admin-user-put--xref: xref:rest_api_admin.adoc#tag/Database-Security/operation/put_db-_user-name[/\{db}/_user/\{name}] +:rest-api-admin-user-get--xref: xref:rest-api:rest_api_admin.adoc#tag/Database-Security/operation/get_db-_user-name[/\{db}/_user/\{name}] +:rest-api-admin-user-post--xref: xref:rest-api:rest_api_admin.adoc#tag/Database-Security/operation/post_db-_user-[/\{db}/_user] +:rest-api-admin-user-put--xref: xref:rest-api:rest_api_admin.adoc#tag/Database-Security/operation/put_db-_user-name[/\{db}/_user/\{name}] -:rest-api-admin--pfx--database-management: xref:rest_api_admin.adoc#tag/Database-Management +:rest-api-admin--pfx--database-management: xref:rest-api:rest_api_admin.adoc#tag/Database-Management :rest-api-admin--xref--database-management--compact: {rest-api-admin--pfx--database-management}/operation/post_db-_compact[\{db\}/_compact] -:rest-api-admin-doc-channels-get--xref: xref:rest_api_admin.adoc#tag/Document/operation/get_keyspace-_all_docs[/\{keyspace}/_alldocs] +:rest-api-admin-doc-channels-get--xref: xref:rest-api:rest_api_admin.adoc#tag/Document/operation/get_keyspace-_all_docs[/\{keyspace}/_alldocs] // :configuration-schema-access-control--page: rest-api-admin-access-control.adoc @@ -674,7 +672,7 @@ endif::xref--pfx-sgw[] // :configuration-schema-database--xref-configure: {sgw--xref}{configuration-schema-database--page}#/configure[Configure Database] // :configuration-schema-database--xref-configure-model: {sgw--xref}{configuration-schema-database--page}#/configure/put__db___config[Database Configuration - Data Model] -:rest-api-admin-user--page: rest-api/rest-api-admin.adoc +:rest-api-admin-user--page: rest-api:rest-api-admin.adoc :rest-api-admin-user-post--xref: {sgw--xref}{rest-api-admin--page}#tag/Database-Security/operation/put_db-_user-name[\{db\}/_user/\{name\}] // :configuration-schema--isgr--page: rest-api-admin-isgr.adoc @@ -688,123 +686,123 @@ endif::xref--pfx-sgw[] :rest-api-client-app--page: rest-api-client-app.adoc :rest-api-client-app--xref: {sgw--xref}{rest-api-client-app--page}[Use the REST API?] -:rest-api-metrics--page: rest-api/rest-api-metrics.adoc +:rest-api-metrics--page: rest-api:rest-api-metrics.adoc :rest-api-metrics--xref: {sgw--xref}{rest-api-metrics--page}[Metrics REST API] -:resync--page: manage/resync.adoc +:resync--page: manage:resync.adoc :resync--xref: {sgw--xref}{resync--page}[Resync] -:revisions--page: manage/revisions.adoc +:revisions--page: manage:revisions.adoc :revisions--pfx: {sgw--xref}{revisions--page} :revisions--xref: {revisions--pfx}[Revisions] :revisions--xref-compacting: {revisions--pfx}#compacting[Revisions -- Compacting] -:roles--page: access-control/roles.adoc +:roles--page: access-control:roles.adoc :roles--xref: {sgw--xref}{roles--page}[Roles] :role--xref: {sgw--xref}{roles--page}[Role] -:secure-sgw-access--page: security/secure-sgw-access.adoc +:secure-sgw-access--page: security:secure-sgw-access.adoc :secure-sgw-access--pfx: {sgw--xref}{secure-sgw-access--page} :secure-sgw-access--xref: {secure-sgw-access--pfx}[Secure Sync Gateway Access] -:setting-up-dr-cluster--page: deploy/setting-up-dr-cluster.adoc +:setting-up-dr-cluster--page: deploy:setting-up-dr-cluster.adoc :setting-up-dr-cluster--xref: {sgw--xref}{setting-up-dr-cluster--page}[Disaster Recovery] -:server-compatibility-buckets--page: server-compatibility/server-compatibility-buckets.adoc +:server-compatibility-buckets--page: server-compatibility:server-compatibility-buckets.adoc :server-compatibility-buckets-xref: {sgw--xref}{server-compatibility-buckets--page}[Server Compatibility - Buckets] -:server-compatibility-collections--page: server-compatibility/server-compatibility-collections.adoc +:server-compatibility-collections--page: server-compatibility:server-compatibility-collections.adoc :server-compatibility-collections--xref: {sgw--xref}{server-compatibility-collections--page}[Server Compatibility - Collections] -:server-compatibility-eventing--page: server-compatibility/server-compatibility-eventing.adoc +:server-compatibility-eventing--page: server-compatibility:server-compatibility-eventing.adoc :server-compatibility-eventing--xref: {sgw--xref}{server-compatibility-eventing--page}[Server Compatibility - Eventing] -:server-compatibility-transactions--page: server-compatibility/server-compatibility-transactions.adoc +:server-compatibility-transactions--page: server-compatibility:server-compatibility-transactions.adoc :server-compatibility-transactions--xref: {sgw--xref}{server-compatibility-transactions--page}[Server Compatibility - Transactions] -:server-compatibility-xdcr--page: server-compatibility/server-compatibility-xdcr.adoc +:server-compatibility-xdcr--page: server-compatibility:server-compatibility-xdcr.adoc :server-compatibility-xdcr--xref: {sgw--xref}{server-compatibility-xdcr--page}[Server Compatibility - XDCR] -:server-compatibility-backup-and-restore--page: server-compatibility/server-compatibility-backups.adoc +:server-compatibility-backup-and-restore--page: server-compatibility:server-compatibility-backups.adoc :server-compatibility-backup-and-restore--xref: {sgw--xref}{server-compatibility-backup-and-restore--page}[Server Compatibility - Backup and restore] -:xdcr-active-active-eventing--page: server-compatibility/xdcr-active-active-eventing.adoc +:xdcr-active-active-eventing--page: server-compatibility:xdcr-active-active-eventing.adoc :xdcr-active-active-eventing--xref: {sgw--xref}{xdcr-active-active-eventing--page}[XDCR Active-Active and Eventing] -:sgcollect-info--page: manage/sgcollect-info.adoc +:sgcollect-info--page: manage:sgcollect-info.adoc :sgcollect-info--xref: {sgw--xref}{sgcollect-info--page}[SGCollect Info] -:stats-monitoring--page: manage/stats-monitoring.adoc +:stats-monitoring--page: manage:stats-monitoring.adoc :stats-monitoring--xref: {sgw--xref}{stats-monitoring--page}[Stats Monitoring] -:stats-prometheus--page: deploy/stats-prometheus.adoc +:stats-prometheus--page: deploy:stats-prometheus.adoc :stats-prometheus--xref: {sgw--xref}{stats-prometheus--page}[Stats Prometheus] -:supported-environments--page: supported-environments.adoc +:supported-environments--page: product-notes:supported-environments.adoc :supported-environments--xref: {sgw--xref}{supported-environments--page}[Supported OS] -:sync-function-overview--page: access-control/sync-function/sync-function-overview.adoc +:sync-function-overview--page: access-control:sync-function/sync-function.adoc :sync-function-overview--xref: {sgw--xref}{sync-function-overview--page}[Sync Function Overview] -:sync-function--page: access-control/sync-function/sync-function.adoc +:sync-function--page: access-control:sync-function/sync-function.adoc :sync-function--xref: {sgw--xref}{sync-function--page}[Sync Function] -:sync-function-api--page: access-control/sync-function/sync-function-api.adoc +:sync-function-api--page: access-control:sync-function/sync-function-api.adoc :sync-function-api--xref: {sgw--xref}{sync-function-api--page}[Sync Function API] -:sync-function-api-access-cmd--page: access-control/sync-function/sync-function-api-access-cmd.adoc +:sync-function-api-access-cmd--page: access-control:sync-function/sync-function-api-access-cmd.adoc :sync-function-api-access-cmd--xref: {sgw--xref}{sync-function-api-access-cmd--page}[access()] -:sync-function-api-channel-cmd--page: access-control/sync-function/sync-function-api-channel-cmd.adoc +:sync-function-api-channel-cmd--page: access-control:sync-function/sync-function-api-channel-cmd.adoc :sync-function-api-channel-cmd--xref: {sgw--xref}{sync-function-api-channel-cmd--page}[channel()] -:sync-function-api-expiry-cmd--page: access-control/sync-function/sync-function-api-expiry-cmd.adoc +:sync-function-api-expiry-cmd--page: access-control:sync-function/sync-function-api-expiry-cmd.adoc :sync-function-api-expiry-cmd--xref: {sgw--xref}{sync-function-api-expiry-cmd--page}[expiry()] -:sync-function-api-require-access-cmd--page: access-control/sync-function/sync-function-api-require-access-cmd.adoc +:sync-function-api-require-access-cmd--page: access-control:sync-function/sync-function-api-require-access-cmd.adoc :sync-function-api-require-access-cmd--xref: {sgw--xref}{sync-function-api-require-access-cmd--page}[requireAccess()] -:sync-function-api-require-admin-cmd--page: access-control/sync-function/sync-function-api-require-admin-cmd.adoc +:sync-function-api-require-admin-cmd--page: access-control:sync-function/sync-function-api-require-admin-cmd.adoc :sync-function-api-require-admin-cmd--xref: {sgw--xref}{sync-function-api-require-admin-cmd--page}[requireAdmin()] -:sync-function-api-require-role-cmd--page: access-control/sync-function/sync-function-api-require-role-cmd.adoc +:sync-function-api-require-role-cmd--page: access-control:sync-function/sync-function-api-require-role-cmd.adoc :sync-function-api-require-role-cmd--xref: {sgw--xref}{sync-function-api-require-role-cmd--page}[requireRole()] -:sync-function-api-require-user-cmd--page: access-control/sync-function/sync-function-api-require-user-cmd.adoc +:sync-function-api-require-user-cmd--page: access-control:sync-function/sync-function-api-require-user-cmd.adoc :sync-function-api-require-user-cmd--xref: {sgw--xref}{sync-function-api-require-user-cmd--page}[requireUser()] -:sync-function-api-role-cmd--page: access-control/sync-function/sync-function-api-role-cmd.adoc +:sync-function-api-role-cmd--page: access-control:sync-function/sync-function-api-role-cmd.adoc :sync-function-api-role-cmd--xref: {sgw--xref}{sync-function-api-role-cmd--page}[role()] -:sync-function-api-throw-cmd--page: access-control/sync-function/sync-function-api-throw-cmd.adoc +:sync-function-api-throw-cmd--page: access-control:sync-function/sync-function-api-throw-cmd.adoc :sync-function-api-throw-cmd--xref: {sgw--xref}{sync-function-api-throw-cmd--page}[throw()] // :sync-function-api-require-channel: {sgw--xref}{sync-function-api--page}#lbl-require-channel[requireChannel()role] -:sync-inter-syncgateway-conflict-resolution--page: sync/sync-inter-syncgateway-conflict-resolution.adoc +:sync-inter-syncgateway-conflict-resolution--page: sync:sync-inter-syncgateway-conflict-resolution.adoc :sync-inter-syncgateway-conflict-resolution--xref: {sgw--xref}{sync-inter-syncgateway-conflict-resolution--page}[Inter Sync Gateway Sync - Conflict Resolution] :sync-inter-syncgateway-conflict-resolution--custom-conflict-resolution: {sgw--xref}{sync-inter-syncgateway-conflict-resolution--page}#custom-conflict-resolution-ee[Inter Sync Gateway Sync - Custom Conflict Resolution] -:sync-inter-syncgateway-manage--page: sync/sync-inter-syncgateway-manage.adoc +:sync-inter-syncgateway-manage--page: sync:sync-inter-syncgateway-manage.adoc :sync-inter-syncgateway-manage--pfx: {sgw--xref}{sync-inter-syncgateway-manage--page} :sync-inter-syncgateway-manage--xref: {sync-inter-syncgateway-manage--pfx}[Inter Sync Gateway Sync - Manage] :sync-inter-syncgateway-manage--xref-start: {sync-inter-syncgateway-manage--pfx}#starting-a-replication[Starting a replication] -:sync-inter-syncgateway-monitor--page: sync/sync-inter-syncgateway-monitor.adoc +:sync-inter-syncgateway-monitor--page: sync:sync-inter-syncgateway-monitor.adoc :sync-inter-syncgateway-monitor--xref: {sgw--xref}{sync-inter-syncgateway-monitor--page}[Inter Sync Gateway Sync - Monitor] -:sync-inter-syncgateway-overview--page: sync/sync-inter-syncgateway-overview.adoc +:sync-inter-syncgateway-overview--page: sync:sync-inter-syncgateway-overview.adoc :sync-inter-syncgateway-overview--xref: {sgw--xref}{sync-inter-syncgateway-overview--page}[Inter Sync Gateway Sync - Overview] -:sync-inter-syncgateway-run--page: sync/sync-inter-syncgateway-run.adoc +:sync-inter-syncgateway-run--page: sync:sync-inter-syncgateway-run.adoc :sync-inter-syncgateway-run--xref: {sgw--xref}{sync-inter-syncgateway-run--page}[Inter Sync Gateway Sync - Run] -:sync-using-app--page: sync/sync-using-app.adoc +:sync-using-app--page: sync:sync-using-app.adoc :sync-using-app--xref: {sgw--xref}{sync-using-app--page}[Sync Using App] -:sync-with-couchbase-server--page: sync/sync-with-couchbase-server.adoc +:sync-with-couchbase-server--page: sync:sync-with-couchbase-server.adoc :sync-with-couchbase-server--xref: {sgw--xref}{sync-with-couchbase-server--page}[Sync with Couchbase Server] -:import-processing--page: sync/import-processing.adoc +:import-processing--page: sync:import-processing.adoc :import-processing--xref: {sgw--xref}{import-processing--page}[Import Processing] -:upgrading--page: upgrading.adoc +:upgrading--page: ROOT:upgrading.adoc :upgrading--xref: {sgw--xref}{upgrading--page}[Upgrading] -:users--page: access-control/users.adoc +:users--page: access-control:users.adoc :users--xref: {sgw--xref}{users--page}[Users] :user--xref: {sgw--xref}{users--page}[User] -:webhooks--page: deploy/webhooks.adoc +:webhooks--page: deploy:webhooks.adoc :webhooks--xref: {sgw--xref}{webhooks--page}[Webhooks] -:whatsnew--page: whatsnew.adoc +:whatsnew--page: ROOT:whatsnew.adoc :whatsnew--xref: {sgw--xref}{whatsnew--page}[What's New] -:write-access--page: access-control-how-control-document-access.adoc#lbl-write-access +:write-access--page: access-control:access-control-how-control-document-access.adoc#lbl-write-access :write-access--xref: {sgw--xref}{write-access--page}[Write Access] :using-xattr-access-grants--page: using-xattr-access-grants.adoc @@ -820,7 +818,7 @@ endif::xref--pfx-sgw[] // :sgw-pg-channels: sync-gateway-channels.adoc // :sgw-pg-concept-fundamentals-data: concept-fundamentals-data.adoc // :sgw-pg-concept-fundamentals: concept-fundamentals.adoc -// :sgw-pg-conflict-resolution: conflict-resolution.adoc +// :sgw-pg-conflict-resolution: ROOT:conflict-resolution.adoc // :sgw-pg-database-offline: database-offline.adoc // :sgw-pg-deploy-cluster: {deploy-cluster-to-kubernetes--page} // :sgw-pg-deployment: deployment.adoc @@ -838,48 +836,47 @@ endif::xref--pfx-sgw[] :sgw-pg-icr-sgreplicate-sgr2: icr-sgreplicate-sgr2.adoc :sgw-pg-icr-sgreplicate: icr-sgreplicate.adoc // :sgw-pg-icr-stats: icr-stats.adoc -// :sgw-pg-import-process: import-process.adoc -// :sgw-pg-index-sgw: index.adoc -// :sgw-pg-index: index.adoc +// :sgw-pg-index-sgw: ROOT:index.adoc +// :sgw-pg-index: ROOT:index.adoc // :sgw-pg-indexing: {indexing--page} // :sgw-pg-integrating-external-stores: {integrating-external-stores--page} -// :sgw-pg-introduction: introduction.adoc +// :sgw-pg-introduction: ROOT:introduction.adoc // :sgw-pg-legacy-logging-pre2-1: legacy-legacy-logging-pre2-1.adoc // :sgw-load-balancer--page: {load-balancer--page} -:sgw-pg-logging: logging.adoc +:sgw-pg-logging: manage:logging.adoc // :sgw-pg-managing-tombstones: managing-tombstones.adoc // :sgw-pg-os-level-tuning: {os-level-tuning--page} -:sgw-pg-read-access: read-access.adoc -:sgw-pg-refer-sgw-glossary: refer-sgw-glossary.adoc +:sgw-pg-read-access: access-control:access-control-how-control-document-access.adoc#lbl-read-access +:sgw-pg-refer-sgw-glossary: ROOT:glossary.adoc :sgw-pg-release-notes-archive: pn-release-notes-archive.adoc -:sgw-pg-release-notes: pn-release-notes.adoc +:sgw-pg-release-notes: product-notes:release-notes.adoc :sgw-pg-resolving-conflicts-legacy: resolving-conflicts.adoc -:sgw-pg-resync: resync.adoc +:sgw-pg-resync: manage:resync.adoc :sgw-pg-roles: roles.adoc -:sgw-pg-running-replications: running-replications.adoc +:sgw-pg-running-replications: sync:sync-inter-syncgateway-run.adoc :sgw-pg-server-integration: changes-feed.adoc :sgw-pg-sgcollect-info: sgcollect-info.adoc -:sgw-pg-stats-monitoring: stats-monitoring.adoc +:sgw-pg-stats-monitoring: manage:stats-monitoring.adoc :sgw-pg-stats-prometheus: {stats-prometheus--page} -:sgw-pg-sync-from-client: sync-from-client.adoc +:sgw-pg-sync-from-client: ROOT:sync-from-client.adoc :sgw-pg-sync-function: {sync-function-overview--page} :sgw-pg-upgrade: {upgrading--page} :sgw-pg-users: users-and-roles.adoc :sgw-pg-whatsnew: sgw-whatsnew.adoc -:sgw-pg-write-access: write-access.adoc +:sgw-pg-write-access: access-control:access-control-how-control-document-access.adoc#lbl-write-access // :xref-sgw-bmk-icr-sgreplicate--conflict: {sgw--xref}{sgw-pg-icr-sgreplicate}#conflict-resolution[Conflict Resolution] -:xref-sgw--xref-admin-api-attachment: xref:rest_api_admin.adoc#tag/Document +:xref-sgw--xref-admin-api-attachment: xref:rest-api:rest_api_admin.adoc#tag/Document :rest-api-admin--pfx-attachment-get: {xref-sgw--xref-admin-api-attachment}/operation/get_keyspace-docid-attach[Get Attachment (/\{keyspace}/\{docid}/\{attach})] :rest-api-admin--pfx-attachment-put: {xref-sgw--xref-admin-api-attachment}/operation/put_keyspace-docid-attach[Add/Update Attachment (/\{keyspace}/\{docid}/\{attach})] :rest-api-admin--pfx-attachment: {xref-sgw--xref-admin-api-attachment}[/\{keyspace}/\{docid}/\{attach}] -:xref-sgw--xref-admin-api-document: xref:rest_api_admin.adoc#tag/Document +:xref-sgw--xref-admin-api-document: xref:rest-api:rest_api_admin.adoc#tag/Document :rest-api-admin--pfx-document-get-docid: {xref-sgw--xref-admin-api-document}/operation/get_keyspace-docid[get /\{keyspace}/\{docid}] :rest-api-admin--pfx-document-post-purge: {xref-sgw--xref-admin-api-document}/operation/post_keyspace-_purge[/\{keyspace}/_purge] :rest-api-admin--pfx-document-put-docid: {xref-sgw--xref-admin-api-document}/operation/put_keyspace-docid[put /\{keyspace}/\{docid}] :rest-api-admin--pfx-document: {xref-sgw--xref-admin-api-document} -:xref-sgw--xref-admin-api-replication: xref:rest_api_admin.adoc#tag/Replication +:xref-sgw--xref-admin-api-replication: xref:rest-api:rest_api_admin.adoc#tag/Replication :xref-sgw--xref-admin-api-replication-post: {xref-sgw--xref-admin-api-replication}/operation/post_db-_replication- :rest-api-admin--pfx-replication-delete: {xref-sgw--xref-admin-api-replication}/operation/delete_db-_replication-replicationid[DELETE /\{db}/_replication/\{replicationId}] :rest-api-admin--pfx-replication-post-remote: {xref-sgw--xref-admin-api-replication-post}[remote] @@ -1020,7 +1017,6 @@ endif::xref--pfx-sgw[] // LINKS INTO CONFIGURATION // Replications // tkn-db.replications -//:sgw-pg-icr-running-replications: icr-running-replications.adoc diff --git a/modules/ROOT/pages/_partials/_define_stats_item_names.adoc b/modules/ROOT/partials/_define_stats_item_names.adoc similarity index 100% rename from modules/ROOT/pages/_partials/_define_stats_item_names.adoc rename to modules/ROOT/partials/_define_stats_item_names.adoc diff --git a/modules/ROOT/pages/_partials/_set_page_context.adoc b/modules/ROOT/partials/_set_page_context.adoc similarity index 82% rename from modules/ROOT/pages/_partials/_set_page_context.adoc rename to modules/ROOT/partials/_set_page_context.adoc index 4dc96ca77..bbab81523 100644 --- a/modules/ROOT/pages/_partials/_set_page_context.adoc +++ b/modules/ROOT/partials/_set_page_context.adoc @@ -17,8 +17,8 @@ // END INCLUSION DEFINITION -include::partial$_define_component_attributes.adoc[] -include::partial$_define_page_index.adoc[] -include::partial$_define_glossary_links.adoc[] +include::ROOT:partial$_define_component_attributes.adoc[] +include::ROOT:partial$_define_page_index.adoc[] +include::ROOT:partial$_define_glossary_links.adoc[] // // END -- INCLUSION -- _set_page_context.adoc \ No newline at end of file diff --git a/modules/ROOT/pages/_partials/_show_highlighted_block.adoc b/modules/ROOT/partials/_show_highlighted_block.adoc similarity index 100% rename from modules/ROOT/pages/_partials/_show_highlighted_block.adoc rename to modules/ROOT/partials/_show_highlighted_block.adoc diff --git a/modules/ROOT/pages/_partials/_show_page_header_block.adoc b/modules/ROOT/partials/_show_page_header_block.adoc similarity index 98% rename from modules/ROOT/pages/_partials/_show_page_header_block.adoc rename to modules/ROOT/partials/_show_page_header_block.adoc index f77d9ff5c..dd0aa4171 100644 --- a/modules/ROOT/pages/_partials/_show_page_header_block.adoc +++ b/modules/ROOT/partials/_show_page_header_block.adoc @@ -74,7 +74,7 @@ endif::description[] // BEGIN -- Include topic group links in page header block ifdef::param-topic-group[] -include::partial$topic-group-{param-topic-group}.adoc[] +include::ROOT:partial$topic-group-{param-topic-group}.adoc[] // Include any optional additional non-topic-group links ifdef::param-related[] _Other Topics_: {param-related} diff --git a/modules/ROOT/pages/_partials/_show_related_content_block.adoc b/modules/ROOT/partials/_show_related_content_block.adoc similarity index 76% rename from modules/ROOT/pages/_partials/_show_related_content_block.adoc rename to modules/ROOT/partials/_show_related_content_block.adoc index 728d5f9c0..560d503e4 100644 --- a/modules/ROOT/pages/_partials/_show_related_content_block.adoc +++ b/modules/ROOT/partials/_show_related_content_block.adoc @@ -58,29 +58,29 @@ ifdef::is-initialized[] [.column] ====== {empty} .{param-tab1-title} -include::partial$block_related_content_menulists.adoc[tags={param-how}] -include::partial$block_related_content_menulists.adoc[tags={param-concept}] +include::ROOT:partial$block_related_content_menulists.adoc[tags={param-how}] +include::ROOT:partial$block_related_content_menulists.adoc[tags={param-concept}] .{param-add1-title} -include::partial$block_related_content_menulists.adoc[tags={param-add1-items}] +include::ROOT:partial$block_related_content_menulists.adoc[tags={param-add1-items}] [.column] ====== {empty} .{param-tab2-title} -include::partial$block_related_content_menulists.adoc[tags={param-reference}] +include::ROOT:partial$block_related_content_menulists.adoc[tags={param-reference}] .{param-add2-title} -include::partial$block_related_content_menulists.adoc[tags={param-add2-items}] +include::ROOT:partial$block_related_content_menulists.adoc[tags={param-add2-items}] [.column] // [.content] ====== {empty} .{param-tab3-title} -include::partial$block_related_content_menulists.adoc[tags={param-community}] +include::ROOT:partial$block_related_content_menulists.adoc[tags={param-community}] .{param-add3-title} -include::partial$block_related_content_menulists.adoc[tags={param-add3-items}] +include::ROOT:partial$block_related_content_menulists.adoc[tags={param-add3-items}] endif::is-initialized[] // reset parameter values diff --git a/modules/ROOT/pages/_partials/block-authors-notes.adoc b/modules/ROOT/partials/block-authors-notes.adoc similarity index 100% rename from modules/ROOT/pages/_partials/block-authors-notes.adoc rename to modules/ROOT/partials/block-authors-notes.adoc diff --git a/modules/ROOT/pages/_partials/block-caveats.adoc b/modules/ROOT/partials/block-caveats.adoc similarity index 95% rename from modules/ROOT/pages/_partials/block-caveats.adoc rename to modules/ROOT/partials/block-caveats.adoc index dee552d24..88a83edb4 100644 --- a/modules/ROOT/pages/_partials/block-caveats.adoc +++ b/modules/ROOT/partials/block-caveats.adoc @@ -13,7 +13,7 @@ This content relates only to {enterprise} // NOTE: This feature is available only in {enterprise} :param-edition: {enterprise} :param-intro: Except where otherwise stated, this feature relates only to {enterprise} -include::partial$_show_highlighted_block.adoc[] +include::ROOT:partial$_show_highlighted_block.adoc[] // end::ee-only[] // end::enterprise-only[] @@ -53,7 +53,7 @@ For documentation on pre-2.8 inter-Sync Gateway replication (also known as SG Re // tag::community-only-rep-same-node[] :param-edition: {community} :param-body: Replications always run on the node on which they are configured. Users can only access replications on the node from which they make the request. -include::partial$_show_highlighted_block.adoc[] +include::ROOT:partial$_show_highlighted_block.adoc[] // end::community-only-rep-same-node[] @@ -62,7 +62,7 @@ include::partial$_show_highlighted_block.adoc[] // tag::community-only[] :param-edition: {community} :param-body: Unless otherwise stated this content relates only to {community} -include::partial$_show_highlighted_block.adoc[] +include::ROOT:partial$_show_highlighted_block.adoc[] // end::community-only[] // end::ce-only[] @@ -167,7 +167,7 @@ ifdef::param_type[:type: {param_type}] Couchbase Mobile's API documentation utilizes https://swagger.io/tools/swagger-ui/[Swagger UI] to deliver an interactive and dynamic user experience. -The page will not function correctly if your organization's security policies restricts access to this type of content -- instead see the alternate statics page xref:rest_api_{type}_static.adoc[] +The page will not function correctly if your organization's security policies restricts access to this type of content -- instead see the alternate statics page xref:rest-api:rest_api_{type}_static.adoc[] -- diff --git a/modules/ROOT/pages/_partials/block-prometheus.adoc b/modules/ROOT/partials/block-prometheus.adoc similarity index 100% rename from modules/ROOT/pages/_partials/block-prometheus.adoc rename to modules/ROOT/partials/block-prometheus.adoc diff --git a/modules/ROOT/pages/_partials/block-related-content-api.adoc b/modules/ROOT/partials/block-related-content-api.adoc similarity index 70% rename from modules/ROOT/pages/_partials/block-related-content-api.adoc rename to modules/ROOT/partials/block-related-content-api.adoc index e1a657730..949a18bb6 100644 --- a/modules/ROOT/pages/_partials/block-related-content-api.adoc +++ b/modules/ROOT/partials/block-related-content-api.adoc @@ -3,4 +3,4 @@ :param-tab2-title: Reference :param-concept: reference-api :param-reference: reference-config -include::partial$_show_related_content_block.adoc[] +include::ROOT:partial$_show_related_content_block.adoc[] diff --git a/modules/ROOT/pages/_partials/block-related-content-data.adoc b/modules/ROOT/partials/block-related-content-data.adoc similarity index 63% rename from modules/ROOT/pages/_partials/block-related-content-data.adoc rename to modules/ROOT/partials/block-related-content-data.adoc index 33443590d..1fc5482a1 100644 --- a/modules/ROOT/pages/_partials/block-related-content-data.adoc +++ b/modules/ROOT/partials/block-related-content-data.adoc @@ -2,4 +2,4 @@ :param-how: how-syncfunc :param-concept: concept-data :param-reference: reference-api -include::partial$_show_related_content_block.adoc[] +include::ROOT:partial$_show_related_content_block.adoc[] diff --git a/modules/ROOT/pages/_partials/block-related-content-deploy.adoc b/modules/ROOT/partials/block-related-content-deploy.adoc similarity index 78% rename from modules/ROOT/pages/_partials/block-related-content-deploy.adoc rename to modules/ROOT/partials/block-related-content-deploy.adoc index 3d04a0ecf..351ce2819 100644 --- a/modules/ROOT/pages/_partials/block-related-content-deploy.adoc +++ b/modules/ROOT/partials/block-related-content-deploy.adoc @@ -6,4 +6,4 @@ :param-tab2-title: Product Information :param-how: how-deploy :param-reference: reference-deploy -include::partial$_show_related_content_block.adoc[] +include::ROOT:partial$_show_related_content_block.adoc[] diff --git a/modules/ROOT/pages/_partials/block-related-content-icr.adoc b/modules/ROOT/partials/block-related-content-icr.adoc similarity index 74% rename from modules/ROOT/pages/_partials/block-related-content-icr.adoc rename to modules/ROOT/partials/block-related-content-icr.adoc index 64059cde6..41c30114f 100644 --- a/modules/ROOT/pages/_partials/block-related-content-icr.adoc +++ b/modules/ROOT/partials/block-related-content-icr.adoc @@ -4,4 +4,4 @@ :param-reference: reference-icr :param-add3-title: Conflict Related Blogs :param-add3-items: community-icr -include::partial$_show_related_content_block.adoc[] +include::ROOT:partial$_show_related_content_block.adoc[] diff --git a/modules/ROOT/pages/_partials/block-related-content-k8s.adoc b/modules/ROOT/partials/block-related-content-k8s.adoc similarity index 77% rename from modules/ROOT/pages/_partials/block-related-content-k8s.adoc rename to modules/ROOT/partials/block-related-content-k8s.adoc index 1bbf6afb3..93872c249 100644 --- a/modules/ROOT/pages/_partials/block-related-content-k8s.adoc +++ b/modules/ROOT/partials/block-related-content-k8s.adoc @@ -7,4 +7,4 @@ :param-how: how-k8s :param-reference: reference-k8s :param-add3-items: blog-k8s -include::partial$_show_related_content_block.adoc[] +include::ROOT:partial$_show_related_content_block.adoc[] diff --git a/modules/ROOT/pages/_partials/block-related-content-product.adoc b/modules/ROOT/partials/block-related-content-product.adoc similarity index 70% rename from modules/ROOT/pages/_partials/block-related-content-product.adoc rename to modules/ROOT/partials/block-related-content-product.adoc index e1a657730..949a18bb6 100644 --- a/modules/ROOT/pages/_partials/block-related-content-product.adoc +++ b/modules/ROOT/partials/block-related-content-product.adoc @@ -3,4 +3,4 @@ :param-tab2-title: Reference :param-concept: reference-api :param-reference: reference-config -include::partial$_show_related_content_block.adoc[] +include::ROOT:partial$_show_related_content_block.adoc[] diff --git a/modules/ROOT/pages/_partials/block-related-content-sync.adoc b/modules/ROOT/partials/block-related-content-sync.adoc similarity index 75% rename from modules/ROOT/pages/_partials/block-related-content-sync.adoc rename to modules/ROOT/partials/block-related-content-sync.adoc index e1cc20b99..1a713e1b3 100644 --- a/modules/ROOT/pages/_partials/block-related-content-sync.adoc +++ b/modules/ROOT/partials/block-related-content-sync.adoc @@ -4,4 +4,4 @@ :param-reference: reference-api :param-add3-title: Sync Function Blogs :param-add3-items: community-syncfunc -include::partial$_show_related_content_block.adoc[] +include::ROOT:partial$_show_related_content_block.adoc[] diff --git a/modules/ROOT/pages/_partials/block-standard-footnotes.adoc b/modules/ROOT/partials/block-standard-footnotes.adoc similarity index 100% rename from modules/ROOT/pages/_partials/block-standard-footnotes.adoc rename to modules/ROOT/partials/block-standard-footnotes.adoc diff --git a/modules/ROOT/pages/_partials/block_glossary_terms.adoc b/modules/ROOT/partials/block_glossary_terms.adoc similarity index 100% rename from modules/ROOT/pages/_partials/block_glossary_terms.adoc rename to modules/ROOT/partials/block_glossary_terms.adoc diff --git a/modules/ROOT/pages/_partials/block_related_content_menulists.adoc b/modules/ROOT/partials/block_related_content_menulists.adoc similarity index 77% rename from modules/ROOT/pages/_partials/block_related_content_menulists.adoc rename to modules/ROOT/partials/block_related_content_menulists.adoc index 2576464b5..b328eeff9 100644 --- a/modules/ROOT/pages/_partials/block_related_content_menulists.adoc +++ b/modules/ROOT/partials/block_related_content_menulists.adoc @@ -60,13 +60,13 @@ // tag::reference-icr[] // tag::reference-config[] - * xref:configuration/configuration-schema-bootstrap.adoc[Bootstrap] -* xref:configuration/configuration-schema-database.adoc[Database] -* xref:configuration/configuration-schema-db-security.adoc[Database Security] -* xref:configuration/configuration-schema-access-control.adoc[Access Control] -* xref:configuration/configuration-schema-import-filter.adoc[Import Filter] -* xref:configuration/configuration-schema-isgr.adoc[Inter-Sync{nbsp}Gateway Replication] -* xref:configuration/configuration-properties-legacy.adoc[Legacy Pre-3.0 Configuration] + * xref:configuration:configuration-schema-bootstrap.adoc[Bootstrap] +* xref:configuration:configuration-schema-database.adoc[Database] +* xref:configuration:configuration-schema-db-security.adoc[Database Security] +* xref:configuration:configuration-schema-access-control.adoc[Access Control] +* xref:configuration:configuration-schema-import-filter.adoc[Import Filter] +* xref:configuration:configuration-schema-isgr.adoc[Inter-Sync{nbsp}Gateway Replication] +* xref:configuration:configuration-properties-legacy.adoc[Legacy Pre-3.0 Configuration] // end::reference-config[] @@ -114,9 +114,9 @@ Blog Entries // tag::concept-syncfunc[] - * xref:configuration/configuration-schema-access-control.adoc[Access Control] - * xref:rest_api_admin.adoc#tag/Database-Configuration/operation/put_keyspace-_config-sync[Add/Update Sync Function] - * xref:access-control/sync-function/sync-function-overview.adoc[Sync Function Overview] + * xref:configuration:configuration-schema-access-control.adoc[Access Control] + * xref:rest-api:rest_api_admin.adoc#tag/Database-Configuration/operation/put_keyspace-_config-sync[Add/Update Sync Function] + * xref:access-control:sync-function/sync-function.adoc[Sync Function Overview] // end::concept-syncfunc[] diff --git a/modules/ROOT/pages/_partials/blocklinks-cbl.adoc b/modules/ROOT/partials/blocklinks-cbl.adoc similarity index 100% rename from modules/ROOT/pages/_partials/blocklinks-cbl.adoc rename to modules/ROOT/partials/blocklinks-cbl.adoc diff --git a/modules/ROOT/pages/_partials/common-cfg-ext-javascript.adoc b/modules/ROOT/partials/common-cfg-ext-javascript.adoc similarity index 100% rename from modules/ROOT/pages/_partials/common-cfg-ext-javascript.adoc rename to modules/ROOT/partials/common-cfg-ext-javascript.adoc diff --git a/modules/ROOT/pages/_partials/common-releasenotes.adoc b/modules/ROOT/partials/common-releasenotes.adoc similarity index 99% rename from modules/ROOT/pages/_partials/common-releasenotes.adoc rename to modules/ROOT/partials/common-releasenotes.adoc index 178778f00..01b9eae43 100644 --- a/modules/ROOT/pages/_partials/common-releasenotes.adoc +++ b/modules/ROOT/partials/common-releasenotes.adoc @@ -234,7 +234,7 @@ It makes the switching of the runtime behavior -- for example during development // end::new-300-environment-vars-full[] More:: - xref:configuration/configuration-environment-variables.adoc[Configuration Environment Variables] + xref:configuration:configuration-environment-variables.adoc[Configuration Environment Variables] // end::new-300-environment-vars[] // tag::feature1-300[] diff --git a/modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc b/modules/ROOT/partials/compatibility-cbl-sgw.adoc similarity index 100% rename from modules/ROOT/pages/_partials/compatibility-cbl-sgw.adoc rename to modules/ROOT/partials/compatibility-cbl-sgw.adoc diff --git a/modules/ROOT/pages/_partials/concepts/access-control-model.adoc b/modules/ROOT/partials/concepts/access-control-model.adoc similarity index 98% rename from modules/ROOT/pages/_partials/concepts/access-control-model.adoc rename to modules/ROOT/partials/concepts/access-control-model.adoc index 9b1b3fed4..04b29bfa7 100644 --- a/modules/ROOT/pages/_partials/concepts/access-control-model.adoc +++ b/modules/ROOT/partials/concepts/access-control-model.adoc @@ -1,5 +1,5 @@ // concept -- Access -// include::partial$topic-group-access-control-concepts.adoc[] +// include::ROOT:partial$topic-group-access-control-concepts.adoc[] == Concept // tag::full[] @@ -102,7 +102,7 @@ In this case, the replication from Sync Gateway will only pull documents tagged Client apps can use this ability to intelligently sync with a subset of the available documents from the database. :param-bookmark: channels -include::partial$blocklinks-cbl.adoc[] +include::ROOT:partial$blocklinks-cbl.adoc[] [#lbl-access-revocation] diff --git a/modules/ROOT/pages/_partials/concepts/cc-delta-sync.adoc b/modules/ROOT/partials/concepts/cc-delta-sync.adoc similarity index 100% rename from modules/ROOT/pages/_partials/concepts/cc-delta-sync.adoc rename to modules/ROOT/partials/concepts/cc-delta-sync.adoc diff --git a/modules/ROOT/pages/_partials/concepts/channels.adoc b/modules/ROOT/partials/concepts/channels.adoc similarity index 97% rename from modules/ROOT/pages/_partials/concepts/channels.adoc rename to modules/ROOT/partials/concepts/channels.adoc index d45f90bdc..42219a6d2 100644 --- a/modules/ROOT/pages/_partials/concepts/channels.adoc +++ b/modules/ROOT/partials/concepts/channels.adoc @@ -1,7 +1,7 @@ // -- concept -- Channels // :loc-sync-function--xref: pass:q,a[{sgw--xref}{sync-function--page}[Sync Function]] -// include::partial$topic-group-access-control-concepts.adoc[] +// include::ROOT:partial$topic-group-access-control-concepts.adoc[] == Concept @@ -92,7 +92,7 @@ Version 3.x:: + -- -image::channel-access-grant-3.0.png["Access Control Points 3.x",400] +image::ROOT:channel-access-grant-3.0.png["Access Control Points 3.x",400] <1> Using the Admin REST API: + You can provide the `admin_channels` property within the `collection_access` property using the *Admin REST API* endpoint ({rest-api-admin-user-put--xref}). @@ -108,7 +108,7 @@ legacy:: + -- -image::channel-access-grant-pre3.0.png["Access Control Points pre 3.x",400] +image::ROOT:channel-access-grant-pre3.0.png["Access Control Points pre 3.x",400] <1> Using the Admin REST API : You can provide the `admin_channels` property using the *Admin REST API* endpoint ({rest-api-admin-user-put--xref}). diff --git a/modules/ROOT/pages/_partials/concepts/isgw/concept-isgw-ha-node-dist.adoc b/modules/ROOT/partials/concepts/isgw/concept-isgw-ha-node-dist.adoc similarity index 100% rename from modules/ROOT/pages/_partials/concepts/isgw/concept-isgw-ha-node-dist.adoc rename to modules/ROOT/partials/concepts/isgw/concept-isgw-ha-node-dist.adoc diff --git a/modules/ROOT/pages/_partials/concepts/rep-auto-conflict-resolution-policy.adoc b/modules/ROOT/partials/concepts/rep-auto-conflict-resolution-policy.adoc similarity index 100% rename from modules/ROOT/pages/_partials/concepts/rep-auto-conflict-resolution-policy.adoc rename to modules/ROOT/partials/concepts/rep-auto-conflict-resolution-policy.adoc diff --git a/modules/ROOT/pages/_partials/concepts/rep-auto-conflict-resolution.adoc b/modules/ROOT/partials/concepts/rep-auto-conflict-resolution.adoc similarity index 100% rename from modules/ROOT/pages/_partials/concepts/rep-auto-conflict-resolution.adoc rename to modules/ROOT/partials/concepts/rep-auto-conflict-resolution.adoc diff --git a/modules/ROOT/pages/_partials/concepts/roles.adoc b/modules/ROOT/partials/concepts/roles.adoc similarity index 93% rename from modules/ROOT/pages/_partials/concepts/roles.adoc rename to modules/ROOT/partials/concepts/roles.adoc index 927244c47..8be3fcabb 100644 --- a/modules/ROOT/pages/_partials/concepts/roles.adoc +++ b/modules/ROOT/partials/concepts/roles.adoc @@ -1,5 +1,5 @@ // -- concept -- Roles -// include::partial$topic-group-access-control-concepts.adoc[] +// include::ROOT:partial$topic-group-access-control-concepts.adoc[] == Concept // tag::full[] diff --git a/modules/ROOT/pages/_partials/concepts/sync-function.adoc b/modules/ROOT/partials/concepts/sync-function.adoc similarity index 98% rename from modules/ROOT/pages/_partials/concepts/sync-function.adoc rename to modules/ROOT/partials/concepts/sync-function.adoc index 82272491f..308b44053 100644 --- a/modules/ROOT/pages/_partials/concepts/sync-function.adoc +++ b/modules/ROOT/partials/concepts/sync-function.adoc @@ -1,6 +1,6 @@ // -- concept -- Sync Function // -// include::partial$topic-group-access-control-concepts.adoc[] +// include::ROOT:partial$topic-group-access-control-concepts.adoc[] == Concept @@ -14,7 +14,7 @@ The function executes every time a new revision/update is made to a document. // end::summary[] -image::sync-function-context.png["Sync Function Context",300] +image::ROOT:sync-function-context.png["Sync Function Context",300] The sync function should be a focus of any security review of your application. // end::summary-exp[] @@ -311,4 +311,4 @@ function (doc, oldDoc) { ==== // end::body[] -// end:full[] \ No newline at end of file +// end:full[] diff --git a/modules/ROOT/pages/_partials/concepts/users.adoc b/modules/ROOT/partials/concepts/users.adoc similarity index 100% rename from modules/ROOT/pages/_partials/concepts/users.adoc rename to modules/ROOT/partials/concepts/users.adoc diff --git a/modules/ROOT/pages/_partials/config-changes.adoc b/modules/ROOT/partials/config-changes.adoc similarity index 100% rename from modules/ROOT/pages/_partials/config-changes.adoc rename to modules/ROOT/partials/config-changes.adoc diff --git a/modules/ROOT/pages/_partials/database-config-schema.adoc b/modules/ROOT/partials/database-config-schema.adoc similarity index 100% rename from modules/ROOT/pages/_partials/database-config-schema.adoc rename to modules/ROOT/partials/database-config-schema.adoc diff --git a/modules/ROOT/pages/_partials/feature-catalog.adoc b/modules/ROOT/partials/feature-catalog.adoc similarity index 96% rename from modules/ROOT/pages/_partials/feature-catalog.adoc rename to modules/ROOT/partials/feature-catalog.adoc index 40d49505d..3e48509e3 100644 --- a/modules/ROOT/pages/_partials/feature-catalog.adoc +++ b/modules/ROOT/partials/feature-catalog.adoc @@ -103,8 +103,8 @@ Sync Gateway's _Continuous Logging_ feature delivers flexible log generation and .Mentioned in // tag::logging-usage[] -* xref:concept-logging.adoc[Logging (concept)] -* xref:concept-logging.adoc[Logging (how-to)] +* xref:ROOT:concept-logging.adoc[Logging (concept)] +* xref:ROOT:concept-logging.adoc[Logging (how-to)] // end::logging-usage[] // end::logging[] // LOGGING END @@ -147,7 +147,7 @@ Tombstone revisions are created to allow all devices to see that a document has ---- Mentioned in: * {managing-tombstones--xref} -* xref:shared-bucket-access.adoc#metadata-purge-interval[Metadata Purge Interval] +* xref:ROOT:shared-bucket-access.adoc#metadata-purge-interval[Metadata Purge Interval] * {configuration-schema-database--pfx--db}-enable_shared_bucket_access[$dbname.enable_shared_bucket_access] * xref:server:learn:buckets-memory-and-storage/storage.adoc#tombstones[Server Tombstones] diff --git a/modules/ROOT/pages/_partials/howto/how-to-assign-users-to-roles.adoc b/modules/ROOT/partials/howto/how-to-assign-users-to-roles.adoc similarity index 95% rename from modules/ROOT/pages/_partials/howto/how-to-assign-users-to-roles.adoc rename to modules/ROOT/partials/howto/how-to-assign-users-to-roles.adoc index 84e320b8e..819a6fdb3 100644 --- a/modules/ROOT/pages/_partials/howto/how-to-assign-users-to-roles.adoc +++ b/modules/ROOT/partials/howto/how-to-assign-users-to-roles.adoc @@ -15,7 +15,7 @@ Assign a user to a role via the {rest-api-admin--xref} + Roles can be configured within using the DB section -- see: {configuration-properties-legacy--xref}. + + -include::partial$block-caveats.adoc[tags=disable-persistent-config] +include::ROOT:partial$block-caveats.adoc[tags=disable-persistent-config] * Sync Function + Programmatically assign users to roles. @@ -76,7 +76,7 @@ File-based Configuration Properties:: + -- -include::partial$block-caveats.adoc[tags=disable-persistent-config] +include::ROOT:partial$block-caveats.adoc[tags=disable-persistent-config] Add the role the user is to be assigned to in the configuration file. This method is convenient for testing and to get started. diff --git a/modules/ROOT/pages/_partials/howto/how-to-control-document-access.adoc b/modules/ROOT/partials/howto/how-to-control-document-access.adoc similarity index 100% rename from modules/ROOT/pages/_partials/howto/how-to-control-document-access.adoc rename to modules/ROOT/partials/howto/how-to-control-document-access.adoc diff --git a/modules/ROOT/pages/_partials/howto/how-to-create-roles.adoc b/modules/ROOT/partials/howto/how-to-create-roles.adoc similarity index 94% rename from modules/ROOT/pages/_partials/howto/how-to-create-roles.adoc rename to modules/ROOT/partials/howto/how-to-create-roles.adoc index 14d4c02bf..06a407841 100644 --- a/modules/ROOT/pages/_partials/howto/how-to-create-roles.adoc +++ b/modules/ROOT/partials/howto/how-to-create-roles.adoc @@ -22,7 +22,7 @@ Roles are created via the Sync Gateway Admin REST API -- see: {rest-api-admin--x + *Note* To use this option in v3.x, you must use the `-disable_persistent_config` CLI option. + -Configure roles in the xref:configuration/configuration-properties-legacy.adoc[Legacy Configuration Properties] file. +Configure roles in the xref:configuration:configuration-properties-legacy.adoc[Legacy Configuration Properties] file. *Note* that removing a role effectively revokes access to the channel that role is associated with and may mean users will lose access to required documents. @@ -57,7 +57,7 @@ File-based Configuration Properties:: + -- -include::partial$block-caveats.adoc[tags=disable-persistent-cinfig] +include::ROOT:partial$block-caveats.adoc[tags=disable-persistent-cinfig] Create roles by hardcoding them in the {configuration-properties-legacy--xref}. This method is convenient for testing and to get started. diff --git a/modules/ROOT/pages/_partials/howto/how-to-create-users.adoc b/modules/ROOT/partials/howto/how-to-create-users.adoc similarity index 97% rename from modules/ROOT/pages/_partials/howto/how-to-create-users.adoc rename to modules/ROOT/partials/howto/how-to-create-users.adoc index 03117eb94..e0b3dcd51 100644 --- a/modules/ROOT/pages/_partials/howto/how-to-create-users.adoc +++ b/modules/ROOT/partials/howto/how-to-create-users.adoc @@ -67,7 +67,7 @@ File-based Configuration Properties File:: + -- -include::partial$block-caveats.adoc[tags=disable-persistent-config] +include::ROOT:partial$block-caveats.adoc[tags=disable-persistent-config] Create users by hardcoding their credentials in the Configuration Properties file. diff --git a/modules/ROOT/partials/howto/how-to-sync-function-api.adoc b/modules/ROOT/partials/howto/how-to-sync-function-api.adoc new file mode 100644 index 000000000..fba6f2062 --- /dev/null +++ b/modules/ROOT/partials/howto/how-to-sync-function-api.adoc @@ -0,0 +1,60 @@ +// BEGIN how-to -- CONTROL DOCUMENT ACCESS +// Parameters -- use-topic-header -- to show the topic heading (optional) + +:ouroffset: +1 + +[#lbl-access] +== access() + +include::ROOT:partial$sync-api/sync-function-api-access.adoc[leveloffset={ouroffset}] + +[#lbl-channel] +== channel() + +include::ROOT:partial$sync-api/sync-function-api-channel.adoc[leveloffset={ouroffset}] + + +[#lbl-expiry] +== expiry() + +include::ROOT:partial$sync-api/sync-function-api-expiry.adoc[leveloffset={ouroffset}] + + +[#lbl-require-access] +== requireAccess() + +include::ROOT:partial$sync-api/sync-function-api-require-access.adoc[leveloffset={ouroffset}] + + +[#lbl-require-admin] +== requireAdmin() + +include::ROOT:partial$sync-api/sync-function-api-require-admin.adoc[leveloffset={ouroffset}] + + +[#lbl-require-role] +== requireRole() + +include::ROOT:partial$sync-api/sync-function-api-require-role.adoc[leveloffset={ouroffset}] + + +[#lbl-require-user] +== requireUser() + +include::ROOT:partial$sync-api/sync-function-api-require-user.adoc[leveloffset={ouroffset}] + + +[#lbl-role] +== role() + +include::ROOT:partial$sync-api/sync-function-api-role.adoc[leveloffset={ouroffset}] + + +[#lbl-throw] +== throw() + +include::ROOT:partial$sync-api/sync-function-api-throw.adoc[leveloffset={ouroffset}] + + + +// END how-to -- ALLOW ACCESS diff --git a/modules/ROOT/pages/_partials/howto/how-to-use-xattrs-for-access-grants.adoc b/modules/ROOT/partials/howto/how-to-use-xattrs-for-access-grants.adoc similarity index 100% rename from modules/ROOT/pages/_partials/howto/how-to-use-xattrs-for-access-grants.adoc rename to modules/ROOT/partials/howto/how-to-use-xattrs-for-access-grants.adoc diff --git a/modules/ROOT/pages/_partials/howto/how-to-verify-access.adoc b/modules/ROOT/partials/howto/how-to-verify-access.adoc similarity index 100% rename from modules/ROOT/pages/_partials/howto/how-to-verify-access.adoc rename to modules/ROOT/partials/howto/how-to-verify-access.adoc diff --git a/modules/ROOT/pages/_partials/icr-api-expvar-GET.adoc b/modules/ROOT/partials/icr-api-expvar-GET.adoc similarity index 91% rename from modules/ROOT/pages/_partials/icr-api-expvar-GET.adoc rename to modules/ROOT/partials/icr-api-expvar-GET.adoc index 83fbbf0f1..1e1373981 100644 --- a/modules/ROOT/pages/_partials/icr-api-expvar-GET.adoc +++ b/modules/ROOT/partials/icr-api-expvar-GET.adoc @@ -1,4 +1,4 @@ -include::partial$_stats-item-names.adoc[] +include::ROOT:partial$_define_stats_item_names.adoc[] // tag::stats[] Use the `_expvar` Admin REST API to access Sync Gateway stats shown in <>. @@ -15,7 +15,7 @@ You can find further details on the statistics here -- {xref-sgw-pg-stats-monito [source,json,subs="normal, attributes"] ---- -include::partial$stats-schema-per-replication.adoc-[] +include::ROOT:partial$stats-schema-per-replication.adoc-[] ---- ==== diff --git a/modules/ROOT/pages/_partials/icr-replicationStatus-GET.adoc b/modules/ROOT/partials/icr-replicationStatus-GET.adoc similarity index 97% rename from modules/ROOT/pages/_partials/icr-replicationStatus-GET.adoc rename to modules/ROOT/partials/icr-replicationStatus-GET.adoc index 877a6c86b..5487c4236 100644 --- a/modules/ROOT/pages/_partials/icr-replicationStatus-GET.adoc +++ b/modules/ROOT/partials/icr-replicationStatus-GET.adoc @@ -5,7 +5,7 @@ Sync Gateway provides easy access to replication status data through the Admin R You can obtain the replication status details for a specific replication, or for all replications across all nodes. This option can be useful, for example, to find any auto-generated replication_id details needed to enable further replication management activities. -include::partial$block-caveats.adoc[tags=community-only-rep-same-node] +include::ROOT:partial$block-caveats.adoc[tags=community-only-rep-same-node] // end::overview[] === All Replications diff --git a/modules/ROOT/pages/_partials/incpg-icr-admin.adoc b/modules/ROOT/partials/incpg-icr-admin.adoc similarity index 97% rename from modules/ROOT/pages/_partials/incpg-icr-admin.adoc rename to modules/ROOT/partials/incpg-icr-admin.adoc index 5068b2c10..fc6e44e89 100644 --- a/modules/ROOT/pages/_partials/incpg-icr-admin.adoc +++ b/modules/ROOT/partials/incpg-icr-admin.adoc @@ -18,7 +18,7 @@ The available endpoints used for admin tasks are: -- Retrieve, Update or Remove a __replication definition__ * `_replicationStatus` -- Stop, Start or Reset a replication -include::partial$block-caveats.adoc[tags=community-only-rep-same-node] +include::ROOT:partial$block-caveats.adoc[tags=community-only-rep-same-node] // end::overview[] @@ -181,7 +181,7 @@ See: {rest-api-admin--xref} | Endpoint {rest-api-admin--pfx-replication-delete == Getting Replication Status Data -include::partial$icr-replicationStatus-GET.adoc[tag=overview] +include::ROOT:partial$icr-replicationStatus-GET.adoc[tag=overview] For more information on monitoring see: {sync-inter-syncgateway-monitor--xref} @@ -192,7 +192,7 @@ This example targets a known `replication-id` and returns its status data. [{tabs}] ==== -include::partial$icr-replicationStatus-GET.adoc[tag=example-specific] +include::ROOT:partial$icr-replicationStatus-GET.adoc[tag=example-specific] ==== ===== @@ -207,7 +207,7 @@ It filters the results using a query string -- see: [{tabs}] ==== -include::partial$icr-replicationStatus-GET.adoc[tag=example-all] +include::ROOT:partial$icr-replicationStatus-GET.adoc[tag=example-all] ==== ===== diff --git a/modules/ROOT/pages/_partials/incpg-icr-availability.adoc b/modules/ROOT/partials/incpg-icr-availability.adoc similarity index 96% rename from modules/ROOT/pages/_partials/incpg-icr-availability.adoc rename to modules/ROOT/partials/incpg-icr-availability.adoc index 60fd22aa0..e246c8515 100644 --- a/modules/ROOT/pages/_partials/incpg-icr-availability.adoc +++ b/modules/ROOT/partials/incpg-icr-availability.adoc @@ -7,7 +7,7 @@ ifndef::is_deep_toc[*_In this section_*: <> | <> below. -// include::partial$_show_highlighted_block.adoc[] +// include::ROOT:partial$_show_highlighted_block.adoc[] -- ==== @@ -64,7 +64,7 @@ Node distribution will automatically elect an appropriate node to run them on an // :param-intro: Even though automatic node-distribution is not available, you can make your replications more highly-available. // :param-body: Just define the same replication on multiple nodes. They will then run on each of those nodes. This redundancy provides some resiliency as, if a node fails, the duplicate replication(s) running on the other nodes may be able to continue. + // {empty} -// include::partial$_show_highlighted_block.adoc[] +// include::ROOT:partial$_show_highlighted_block.adoc[] _Related configuration elements_`: {configuration-properties-legacy--xref} | {rest-api-admin--xref} @@ -75,10 +75,10 @@ If a node fails, then Sync Gateway will take any replications configured on mult Node distribution will continually seek to maintain an optimal distribution of replications across available nodes. // :param-msg: No automatic distribution of replications is done. If the replication is running on multiple nodes then it will continue running on any surviving nodes. -// include::partial$block-caveats.adoc[tags=ce-only] +// include::ROOT:partial$block-caveats.adoc[tags=ce-only] // :param-edition: {community} // :param-body: No automatic distribution of replications is done. If the replication is running on multiple nodes then it will continue running on any surviving nodes. -// include::partial$_show_highlighted_block.adoc[] +// include::ROOT:partial$_show_highlighted_block.adoc[] === Examples of Expected behavior diff --git a/modules/ROOT/pages/_partials/incpg-icr-conflict.adoc b/modules/ROOT/partials/incpg-icr-conflict.adoc similarity index 98% rename from modules/ROOT/pages/_partials/incpg-icr-conflict.adoc rename to modules/ROOT/partials/incpg-icr-conflict.adoc index b97101bae..f06d2c1af 100644 --- a/modules/ROOT/pages/_partials/incpg-icr-conflict.adoc +++ b/modules/ROOT/partials/incpg-icr-conflict.adoc @@ -147,7 +147,7 @@ remoteWins:: // tag::in-this-section[] ifndef::is_deep_toc[_In this section_: <> | <> | <> | <>] -include::partial$block-caveats.adoc[tags=ee-only-feature] +include::ROOT:partial$block-caveats.adoc[tags=ee-only-feature] // end::in-this-section[] @@ -210,12 +210,12 @@ This triggers a pull replication and subsequent conflict resolution. === Conflict Resolver Structure -include::partial$common-cfg-ext-javascript.adoc[tag=intro] +include::ROOT:partial$common-cfg-ext-javascript.adoc[tag=intro] You can provide your conflict resolver as either an inline or external Javascript function. You can learn more about the ($db.custom_conflict_resolver) property in the Configuration Schema Reference -- see: {configuration-schema-database--xref--db-rep-resolver}. -include::partial$common-cfg-ext-javascript.adoc[tag=config-full] +include::ROOT:partial$common-cfg-ext-javascript.adoc[tag=config-full] The following example shows the basic structure of the conflict resolver function as it would be defined in the configuration file. diff --git a/modules/ROOT/pages/_partials/incpg-icr-initialization.adoc b/modules/ROOT/partials/incpg-icr-initialization.adoc similarity index 98% rename from modules/ROOT/pages/_partials/incpg-icr-initialization.adoc rename to modules/ROOT/partials/incpg-icr-initialization.adoc index 16ef86254..c27722b24 100644 --- a/modules/ROOT/pages/_partials/incpg-icr-initialization.adoc +++ b/modules/ROOT/partials/incpg-icr-initialization.adoc @@ -125,7 +125,7 @@ A number of database-level options are also especially relevant to Inter-Sync{nb This table summarizes all the available configurable items. .Summary of Parameters -include::partial$static_restapi/admin/index.adoc[tags=User_configurable_replication_properties] +include::ROOT:partial$static_restapi/admin/index.adoc[tags=User_configurable_replication_properties] [[replication-properties]] .Replication Definition @@ -193,7 +193,7 @@ However, you should avoid initializing identical pre-2.8 (SG Replicate) and 2.8+ == Running Configured Replications Replications in the configuration file start automatically whenever Sync Gateway is (re)started. -Unless you inhibit this by adding an `"initial_state": "stopped"` parameter to the replication definition -- see: xref:configuration/configuration-schema-database.adoc#replications-replication_id-initial_state[initial_state]. +Unless you inhibit this by adding an `"initial_state": "stopped"` parameter to the replication definition -- see: xref:configuration:configuration-schema-database.adoc#replications-replication_id-initial_state[initial_state]. You can manually start 'stopped' replication using {sync-inter-syncgateway-manage--xref-start}. .Configured Replications -- Continuous and One-shot diff --git a/modules/ROOT/pages/_partials/incpg-icr-monitoring.adoc b/modules/ROOT/partials/incpg-icr-monitoring.adoc similarity index 86% rename from modules/ROOT/pages/_partials/incpg-icr-monitoring.adoc rename to modules/ROOT/partials/incpg-icr-monitoring.adoc index 2717dafb2..f9d10027c 100644 --- a/modules/ROOT/pages/_partials/incpg-icr-monitoring.adoc +++ b/modules/ROOT/partials/incpg-icr-monitoring.adoc @@ -1,5 +1,5 @@ // = Replication Monitoring and Statistics -include::partial$_stats-item-names.adoc[] +include::ROOT:partial$_define_stats_item_names.adoc[] // tag::in-this-section[] ifndef::is_deep_toc[*_In this Section_*: <> | <>] // end::in-this-section[] @@ -27,16 +27,16 @@ You can access these statistics using the `_expvar` endpoint. == Retrieving Replication Status Data // <> | <> -include::partial$icr-replicationStatus-GET.adoc[tags=overview] +include::ROOT:partial$icr-replicationStatus-GET.adoc[tags=overview] === Retrieving Status Data for a Specific Replication -include::partial$icr-replicationStatus-GET.adoc[tags=rep-status-specific] +include::ROOT:partial$icr-replicationStatus-GET.adoc[tags=rep-status-specific] === Retrieving Status Data for All Replications -include::partial$icr-replicationStatus-GET.adoc[tags=rep-status-all] +include::ROOT:partial$icr-replicationStatus-GET.adoc[tags=rep-status-all] == Retrieving Sync Gateway Statistics diff --git a/modules/ROOT/pages/_partials/json_ui_listing.hbs b/modules/ROOT/partials/json_ui_listing.hbs similarity index 100% rename from modules/ROOT/pages/_partials/json_ui_listing.hbs rename to modules/ROOT/partials/json_ui_listing.hbs diff --git a/modules/ROOT/pages/_partials/metrics.hbs b/modules/ROOT/partials/metrics.hbs similarity index 100% rename from modules/ROOT/pages/_partials/metrics.hbs rename to modules/ROOT/partials/metrics.hbs diff --git a/modules/ROOT/pages/_partials/pn-change-log-content.adoc b/modules/ROOT/partials/pn-change-log-content.adoc similarity index 100% rename from modules/ROOT/pages/_partials/pn-change-log-content.adoc rename to modules/ROOT/partials/pn-change-log-content.adoc diff --git a/modules/ROOT/pages/_partials/pn-issues-list.adoc b/modules/ROOT/partials/pn-issues-list.adoc similarity index 100% rename from modules/ROOT/pages/_partials/pn-issues-list.adoc rename to modules/ROOT/partials/pn-issues-list.adoc diff --git a/modules/ROOT/pages/_partials/prometheus-activation.adoc b/modules/ROOT/partials/prometheus-activation.adoc similarity index 100% rename from modules/ROOT/pages/_partials/prometheus-activation.adoc rename to modules/ROOT/partials/prometheus-activation.adoc diff --git a/modules/ROOT/pages/_partials/prometheus-config.yaml b/modules/ROOT/partials/prometheus-config.yaml similarity index 100% rename from modules/ROOT/pages/_partials/prometheus-config.yaml rename to modules/ROOT/partials/prometheus-config.yaml diff --git a/modules/ROOT/pages/_partials/prometheus-sync-gateway-rules.yaml b/modules/ROOT/partials/prometheus-sync-gateway-rules.yaml similarity index 100% rename from modules/ROOT/pages/_partials/prometheus-sync-gateway-rules.yaml rename to modules/ROOT/partials/prometheus-sync-gateway-rules.yaml diff --git a/modules/ROOT/pages/_partials/release_notes/sync-gateway-3-3-0-release-note.adoc b/modules/ROOT/partials/release_notes/sync-gateway-3-3-0-release-note.adoc similarity index 96% rename from modules/ROOT/pages/_partials/release_notes/sync-gateway-3-3-0-release-note.adoc rename to modules/ROOT/partials/release_notes/sync-gateway-3-3-0-release-note.adoc index e2bada889..53decfffe 100644 --- a/modules/ROOT/pages/_partials/release_notes/sync-gateway-3-3-0-release-note.adoc +++ b/modules/ROOT/partials/release_notes/sync-gateway-3-3-0-release-note.adoc @@ -1,6 +1,6 @@ == 3.3.0 -- August 2025 -include::partial$block-caveats.adoc[tags=eventing-mixed-mode] +include::ROOT:partial$block-caveats.adoc[tags=eventing-mixed-mode] === Partitioned Indexes @@ -9,7 +9,7 @@ Partitioned indexes offer horizontal scalability for large deployments by shardi === Disable the Public All Docs Endpoint -Sync Gateway 3.3 introduces an option to disable the xref:rest_api_public.adoc#tag/Document/operation/get_keyspace-_all_docs[`GET /{keyspace}/_all_docs`] operation in the Public REST API. +Sync Gateway 3.3 introduces an option to disable the xref:rest-api:rest_api_public.adoc#tag/Document/operation/get_keyspace-_all_docs[`GET /{keyspace}/_all_docs`] operation in the Public REST API. === Interactive Admin Credentials for SG Collect Info @@ -19,7 +19,7 @@ In Sync Gateway 3.3 and later, the `sgcollect_info` tool provides an interactive Sync Gateway 3.3 includes several performance enhancements for larger deployments. -For more information on new features and enhancements in this release, see xref:whatsnew.adoc[]. +For more information on new features and enhancements in this release, see xref:ROOT:whatsnew.adoc[]. Version 3.3.0 of Sync Gateway also delivers the following features and enhancements. @@ -182,4 +182,4 @@ None for this release. * https://jira.issues.couchbase.com/browse/CBG-4617[CBG-4617 -- Allow public /_all_docs endpoint to be disabled] -NOTE: For an overview of the latest features offered in Sync Gateway 3.3, see xref:whatsnew.adoc[]. +NOTE: For an overview of the latest features offered in Sync Gateway 3.3, see xref:ROOT:whatsnew.adoc[]. diff --git a/modules/ROOT/pages/_partials/rest-api-changes.adoc b/modules/ROOT/partials/rest-api-changes.adoc similarity index 100% rename from modules/ROOT/pages/_partials/rest-api-changes.adoc rename to modules/ROOT/partials/rest-api-changes.adoc diff --git a/modules/ROOT/pages/_partials/rest-api-explorer.adoc b/modules/ROOT/partials/rest-api-explorer.adoc similarity index 100% rename from modules/ROOT/pages/_partials/rest-api-explorer.adoc rename to modules/ROOT/partials/rest-api-explorer.adoc diff --git a/modules/ROOT/pages/_partials/server-integration-scenario-table.adoc b/modules/ROOT/partials/server-integration-scenario-table.adoc similarity index 100% rename from modules/ROOT/pages/_partials/server-integration-scenario-table.adoc rename to modules/ROOT/partials/server-integration-scenario-table.adoc diff --git a/modules/ROOT/pages/_partials/sgw-network-port-reqs.adoc b/modules/ROOT/partials/sgw-network-port-reqs.adoc similarity index 100% rename from modules/ROOT/pages/_partials/sgw-network-port-reqs.adoc rename to modules/ROOT/partials/sgw-network-port-reqs.adoc diff --git a/modules/ROOT/pages/_partials/sgw-supported-os.adoc b/modules/ROOT/partials/sgw-supported-os.adoc similarity index 100% rename from modules/ROOT/pages/_partials/sgw-supported-os.adoc rename to modules/ROOT/partials/sgw-supported-os.adoc diff --git a/modules/ROOT/pages/_partials/sgw-svr-compatibility.adoc b/modules/ROOT/partials/sgw-svr-compatibility.adoc similarity index 97% rename from modules/ROOT/pages/_partials/sgw-svr-compatibility.adoc rename to modules/ROOT/partials/sgw-svr-compatibility.adoc index 615af1731..ecd627470 100644 --- a/modules/ROOT/pages/_partials/sgw-svr-compatibility.adoc +++ b/modules/ROOT/partials/sgw-svr-compatibility.adoc @@ -53,7 +53,7 @@ endif::[] :fnref3-0: footnote:3-0[] -include::partial$block-caveats.adoc[tags="cbs6.0ke-xattrs"] +include::ROOT:partial$block-caveats.adoc[tags="cbs6.0ke-xattrs"] .Sync Gateway/Couchbase Server Compatibility Matrix @@ -264,7 +264,7 @@ Starting from CBS 7.0, the `use_views` feature is deprecated. ==== -include::partial$block-caveats.adoc[tags="ephemeral-buckets"] +include::ROOT:partial$block-caveats.adoc[tags="ephemeral-buckets"] // For all of the above, the Couchbase Server xref:server:learn:buckets-memory-and-storage/buckets.adoc[bucket type] must be *Couchbase*. // Usage of *Ephemeral* and *Memcached* buckets with Couchbase Mobile is not supported. diff --git a/modules/ROOT/pages/_partials/sgw-svr-ports.adoc b/modules/ROOT/partials/sgw-svr-ports.adoc similarity index 100% rename from modules/ROOT/pages/_partials/sgw-svr-ports.adoc rename to modules/ROOT/partials/sgw-svr-ports.adoc diff --git a/modules/ROOT/pages/_partials/static_restapi/admin/index.adoc b/modules/ROOT/partials/static_restapi/admin/index.adoc similarity index 100% rename from modules/ROOT/pages/_partials/static_restapi/admin/index.adoc rename to modules/ROOT/partials/static_restapi/admin/index.adoc diff --git a/modules/ROOT/pages/_partials/static_restapi/css.adoc b/modules/ROOT/partials/static_restapi/css.adoc similarity index 100% rename from modules/ROOT/pages/_partials/static_restapi/css.adoc rename to modules/ROOT/partials/static_restapi/css.adoc diff --git a/modules/ROOT/pages/_partials/static_restapi/metric/index.adoc b/modules/ROOT/partials/static_restapi/metric/index.adoc similarity index 100% rename from modules/ROOT/pages/_partials/static_restapi/metric/index.adoc rename to modules/ROOT/partials/static_restapi/metric/index.adoc diff --git a/modules/ROOT/pages/_partials/static_restapi/public/index.adoc b/modules/ROOT/partials/static_restapi/public/index.adoc similarity index 100% rename from modules/ROOT/pages/_partials/static_restapi/public/index.adoc rename to modules/ROOT/partials/static_restapi/public/index.adoc diff --git a/modules/ROOT/pages/_partials/static_restapi/templates/index.mustache b/modules/ROOT/partials/static_restapi/templates/index.mustache similarity index 100% rename from modules/ROOT/pages/_partials/static_restapi/templates/index.mustache rename to modules/ROOT/partials/static_restapi/templates/index.mustache diff --git a/modules/ROOT/pages/_partials/static_restapi/templates/model.mustache b/modules/ROOT/partials/static_restapi/templates/model.mustache similarity index 100% rename from modules/ROOT/pages/_partials/static_restapi/templates/model.mustache rename to modules/ROOT/partials/static_restapi/templates/model.mustache diff --git a/modules/ROOT/pages/_partials/static_restapi/templates/models.mustache b/modules/ROOT/partials/static_restapi/templates/models.mustache similarity index 100% rename from modules/ROOT/pages/_partials/static_restapi/templates/models.mustache rename to modules/ROOT/partials/static_restapi/templates/models.mustache diff --git a/modules/ROOT/pages/_partials/static_restapi/templates/param.mustache b/modules/ROOT/partials/static_restapi/templates/param.mustache similarity index 100% rename from modules/ROOT/pages/_partials/static_restapi/templates/param.mustache rename to modules/ROOT/partials/static_restapi/templates/param.mustache diff --git a/modules/ROOT/pages/_partials/static_restapi/templates/params.mustache b/modules/ROOT/partials/static_restapi/templates/params.mustache similarity index 100% rename from modules/ROOT/pages/_partials/static_restapi/templates/params.mustache rename to modules/ROOT/partials/static_restapi/templates/params.mustache diff --git a/modules/ROOT/pages/_partials/static_restapi/templates/property.mustache b/modules/ROOT/partials/static_restapi/templates/property.mustache similarity index 100% rename from modules/ROOT/pages/_partials/static_restapi/templates/property.mustache rename to modules/ROOT/partials/static_restapi/templates/property.mustache diff --git a/modules/ROOT/pages/_partials/static_restapi/templates/schema.mustache b/modules/ROOT/partials/static_restapi/templates/schema.mustache similarity index 100% rename from modules/ROOT/pages/_partials/static_restapi/templates/schema.mustache rename to modules/ROOT/partials/static_restapi/templates/schema.mustache diff --git a/modules/ROOT/pages/_partials/static_restapi/templates/schemas.mustache b/modules/ROOT/partials/static_restapi/templates/schemas.mustache similarity index 100% rename from modules/ROOT/pages/_partials/static_restapi/templates/schemas.mustache rename to modules/ROOT/partials/static_restapi/templates/schemas.mustache diff --git a/modules/ROOT/pages/_partials/static_restapi/templates/stubs/empty.adoc b/modules/ROOT/partials/static_restapi/templates/stubs/empty.adoc similarity index 100% rename from modules/ROOT/pages/_partials/static_restapi/templates/stubs/empty.adoc rename to modules/ROOT/partials/static_restapi/templates/stubs/empty.adoc diff --git a/modules/ROOT/pages/_partials/stats-schema-descriptions.adoc b/modules/ROOT/partials/stats-schema-descriptions.adoc similarity index 100% rename from modules/ROOT/pages/_partials/stats-schema-descriptions.adoc rename to modules/ROOT/partials/stats-schema-descriptions.adoc diff --git a/modules/ROOT/pages/_partials/stats-schema-global.adoc b/modules/ROOT/partials/stats-schema-global.adoc similarity index 100% rename from modules/ROOT/pages/_partials/stats-schema-global.adoc rename to modules/ROOT/partials/stats-schema-global.adoc diff --git a/modules/ROOT/pages/_partials/stats-schema-per-db.adoc b/modules/ROOT/partials/stats-schema-per-db.adoc similarity index 100% rename from modules/ROOT/pages/_partials/stats-schema-per-db.adoc rename to modules/ROOT/partials/stats-schema-per-db.adoc diff --git a/modules/ROOT/pages/_partials/stats-schema-per-replication-sgr1.adoc b/modules/ROOT/partials/stats-schema-per-replication-sgr1.adoc similarity index 100% rename from modules/ROOT/pages/_partials/stats-schema-per-replication-sgr1.adoc rename to modules/ROOT/partials/stats-schema-per-replication-sgr1.adoc diff --git a/modules/ROOT/partials/stats-schema.adoc b/modules/ROOT/partials/stats-schema.adoc new file mode 100644 index 000000000..0546d36ce --- /dev/null +++ b/modules/ROOT/partials/stats-schema.adoc @@ -0,0 +1,5 @@ +"{syncgateway}": { +include::ROOT:partial$stats-schema-global.adoc[indent=2] +include::ROOT:partial$stats-schema-per-db.adoc[indent=2] +include::ROOT:partial$stats-schema-per-replication-sgr1.adoc[indent=2] +} \ No newline at end of file diff --git a/modules/ROOT/pages/_partials/sync-api/sync-function-api-access.adoc b/modules/ROOT/partials/sync-api/sync-function-api-access.adoc similarity index 96% rename from modules/ROOT/pages/_partials/sync-api/sync-function-api-access.adoc rename to modules/ROOT/partials/sync-api/sync-function-api-access.adoc index d444bfb3f..dc7b9b599 100644 --- a/modules/ROOT/pages/_partials/sync-api/sync-function-api-access.adoc +++ b/modules/ROOT/partials/sync-api/sync-function-api-access.adoc @@ -17,7 +17,7 @@ Use the `access()` function to grant a user access to a channel. == Arguments -include::partial$sync-api/syncargs.adoc[tags=args;args-user;args-channel] +include::ROOT:partial$sync-api/syncargs.adoc[tags=args;args-user;args-channel] NOTE: As a convenience, the resolved value of either argument may be `null` or `undefined`, in which case nothing happens. diff --git a/modules/ROOT/pages/_partials/sync-api/sync-function-api-channel.adoc b/modules/ROOT/partials/sync-api/sync-function-api-channel.adoc similarity index 97% rename from modules/ROOT/pages/_partials/sync-api/sync-function-api-channel.adoc rename to modules/ROOT/partials/sync-api/sync-function-api-channel.adoc index 9c2b82153..fcf2e54ca 100644 --- a/modules/ROOT/pages/_partials/sync-api/sync-function-api-channel.adoc +++ b/modules/ROOT/partials/sync-api/sync-function-api-channel.adoc @@ -17,7 +17,7 @@ Use the `channel()` function to route the document to the named channel(s). == Arguments -include::partial$sync-api/syncargs.adoc[tags=args;args-channel] +include::ROOT:partial$sync-api/syncargs.adoc[tags=args;args-channel] // [args,cols="^1m,4",options="header"] // |=== diff --git a/modules/ROOT/pages/_partials/sync-api/sync-function-api-expiry.adoc b/modules/ROOT/partials/sync-api/sync-function-api-expiry.adoc similarity index 87% rename from modules/ROOT/pages/_partials/sync-api/sync-function-api-expiry.adoc rename to modules/ROOT/partials/sync-api/sync-function-api-expiry.adoc index d5d472877..91a325a46 100644 --- a/modules/ROOT/pages/_partials/sync-api/sync-function-api-expiry.adoc +++ b/modules/ROOT/partials/sync-api/sync-function-api-expiry.adoc @@ -17,7 +17,7 @@ Use `expiry(value)` to set the expiry value (TTL) on the document. == Arguments -include::partial$sync-api/syncargs.adoc[tags=args;args-expiry] +include::ROOT:partial$sync-api/syncargs.adoc[tags=args;args-expiry] // [args,cols="^1m,4", options="header"] @@ -69,14 +69,14 @@ This expiration time is not propagated when the document is replicated. The purge of the document does not cause it to be deleted on any other database. === Inspect a Document Expiry Value -You can retrieve a document's expiration time, as it is returned in the response of GET xref:rest_api_public.adoc#tag/Document/operation/get_keyspace-docid[+/{keyspace}/{docid}+] using `show_exp=true` as the querystring. +You can retrieve a document's expiration time, as it is returned in the response of GET xref:rest-api:rest_api_public.adoc#tag/Document/operation/get_keyspace-docid[+/{keyspace}/{docid}+] using `show_exp=true` as the querystring. [source, bash] ---- curl -X GET "http://localhost:4985/ourdb/ourdoc?show_exp=true" -H "accept: application/json" ---- -// include::partial$sync-api/sync-function-api-expiry.adoc[levelofset={ouroffset}] +// include::ROOT:partial$sync-api/sync-function-api-expiry.adoc[levelofset={ouroffset}] diff --git a/modules/ROOT/pages/_partials/sync-api/sync-function-api-require-access.adoc b/modules/ROOT/partials/sync-api/sync-function-api-require-access.adoc similarity index 95% rename from modules/ROOT/pages/_partials/sync-api/sync-function-api-require-access.adoc rename to modules/ROOT/partials/sync-api/sync-function-api-require-access.adoc index 04490d2ae..8abd3b204 100644 --- a/modules/ROOT/pages/_partials/sync-api/sync-function-api-require-access.adoc +++ b/modules/ROOT/partials/sync-api/sync-function-api-require-access.adoc @@ -19,7 +19,7 @@ Use the `requireAccess()` function to reject document updates that are not made == Arguments -include::partial$sync-api/syncargs.adoc[tags=args;args-channel] +include::ROOT:partial$sync-api/syncargs.adoc[tags=args;args-channel] == Context diff --git a/modules/ROOT/pages/_partials/sync-api/sync-function-api-require-admin.adoc b/modules/ROOT/partials/sync-api/sync-function-api-require-admin.adoc similarity index 100% rename from modules/ROOT/pages/_partials/sync-api/sync-function-api-require-admin.adoc rename to modules/ROOT/partials/sync-api/sync-function-api-require-admin.adoc diff --git a/modules/ROOT/pages/_partials/sync-api/sync-function-api-require-role.adoc b/modules/ROOT/partials/sync-api/sync-function-api-require-role.adoc similarity index 94% rename from modules/ROOT/pages/_partials/sync-api/sync-function-api-require-role.adoc rename to modules/ROOT/partials/sync-api/sync-function-api-require-role.adoc index 29797f131..67b3ca6cf 100644 --- a/modules/ROOT/pages/_partials/sync-api/sync-function-api-require-role.adoc +++ b/modules/ROOT/partials/sync-api/sync-function-api-require-role.adoc @@ -20,7 +20,7 @@ Use the `requireRole()` function to reject document updates that are not made by == Arguments -include::partial$sync-api/syncargs.adoc[tags=args;args-role] +include::ROOT:partial$sync-api/syncargs.adoc[tags=args;args-role] == Context diff --git a/modules/ROOT/pages/_partials/sync-api/sync-function-api-require-user.adoc b/modules/ROOT/partials/sync-api/sync-function-api-require-user.adoc similarity index 95% rename from modules/ROOT/pages/_partials/sync-api/sync-function-api-require-user.adoc rename to modules/ROOT/partials/sync-api/sync-function-api-require-user.adoc index 8a04592f4..eab423ccc 100644 --- a/modules/ROOT/pages/_partials/sync-api/sync-function-api-require-user.adoc +++ b/modules/ROOT/partials/sync-api/sync-function-api-require-user.adoc @@ -20,7 +20,7 @@ Use the `requireUser()` function to reject document updates that are not made by == Arguments -include::partial$sync-api/syncargs.adoc[tags=args;args-user] +include::ROOT:partial$sync-api/syncargs.adoc[tags=args;args-user] == Context diff --git a/modules/ROOT/pages/_partials/sync-api/sync-function-api-role.adoc b/modules/ROOT/partials/sync-api/sync-function-api-role.adoc similarity index 94% rename from modules/ROOT/pages/_partials/sync-api/sync-function-api-role.adoc rename to modules/ROOT/partials/sync-api/sync-function-api-role.adoc index 3b12fd9fb..ccaf0c1d9 100644 --- a/modules/ROOT/pages/_partials/sync-api/sync-function-api-role.adoc +++ b/modules/ROOT/partials/sync-api/sync-function-api-role.adoc @@ -21,7 +21,7 @@ NOTE: Roles, like users, have to be explicitly created by an administrator. == Arguments -include::partial$sync-api/syncargs.adoc[tags=args;args-user;args-role] +include::ROOT:partial$sync-api/syncargs.adoc[tags=args;args-user;args-role] == Context diff --git a/modules/ROOT/pages/_partials/sync-api/sync-function-api-throw.adoc b/modules/ROOT/partials/sync-api/sync-function-api-throw.adoc similarity index 100% rename from modules/ROOT/pages/_partials/sync-api/sync-function-api-throw.adoc rename to modules/ROOT/partials/sync-api/sync-function-api-throw.adoc diff --git a/modules/ROOT/pages/_partials/sync-api/syncargs.adoc b/modules/ROOT/partials/sync-api/syncargs.adoc similarity index 95% rename from modules/ROOT/pages/_partials/sync-api/syncargs.adoc rename to modules/ROOT/partials/sync-api/syncargs.adoc index 4c07cca13..20a2efde9 100644 --- a/modules/ROOT/pages/_partials/sync-api/syncargs.adoc +++ b/modules/ROOT/partials/sync-api/syncargs.adoc @@ -1,5 +1,5 @@ // Inclusion used by sync-api/sync-function-api-*.adoc topics -// EG include::partial$sync-api/syncargs.adoc[tags=args;args-channel] +// EG include::ROOT:partial$sync-api/syncargs.adoc[tags=args;args-channel] // tag::args[] [args,cols="1m,4",options="header"] diff --git a/modules/ROOT/pages/_partials/sync-function-code.adoc b/modules/ROOT/partials/sync-function-code.adoc similarity index 100% rename from modules/ROOT/pages/_partials/sync-function-code.adoc rename to modules/ROOT/partials/sync-function-code.adoc diff --git a/modules/ROOT/pages/_partials/topic-group-access-control-concepts.adoc b/modules/ROOT/partials/topic-group-access-control-concepts.adoc similarity index 100% rename from modules/ROOT/pages/_partials/topic-group-access-control-concepts.adoc rename to modules/ROOT/partials/topic-group-access-control-concepts.adoc diff --git a/modules/ROOT/pages/_partials/topic-group-access-control-how.adoc b/modules/ROOT/partials/topic-group-access-control-how.adoc similarity index 100% rename from modules/ROOT/pages/_partials/topic-group-access-control-how.adoc rename to modules/ROOT/partials/topic-group-access-control-how.adoc diff --git a/modules/ROOT/pages/_partials/topic-group-access-control.adoc b/modules/ROOT/partials/topic-group-access-control.adoc similarity index 100% rename from modules/ROOT/pages/_partials/topic-group-access-control.adoc rename to modules/ROOT/partials/topic-group-access-control.adoc diff --git a/modules/ROOT/pages/_partials/topic-group-compatibility.adoc b/modules/ROOT/partials/topic-group-compatibility.adoc similarity index 100% rename from modules/ROOT/pages/_partials/topic-group-compatibility.adoc rename to modules/ROOT/partials/topic-group-compatibility.adoc diff --git a/modules/ROOT/pages/_partials/topic-group-concepts.adoc b/modules/ROOT/partials/topic-group-concepts.adoc similarity index 100% rename from modules/ROOT/pages/_partials/topic-group-concepts.adoc rename to modules/ROOT/partials/topic-group-concepts.adoc diff --git a/modules/ROOT/pages/_partials/topic-group-configuration.adoc b/modules/ROOT/partials/topic-group-configuration.adoc similarity index 95% rename from modules/ROOT/pages/_partials/topic-group-configuration.adoc rename to modules/ROOT/partials/topic-group-configuration.adoc index 609d9b357..dca1b5e1c 100644 --- a/modules/ROOT/pages/_partials/topic-group-configuration.adoc +++ b/modules/ROOT/partials/topic-group-configuration.adoc @@ -20,7 +20,7 @@ ifdef::param-title[:this-title: {param-title}] :topic-1: {configuration-overview--page} :topic-2: {configuration-schema-bootstrap--page} :topic-3: {configuration-schema-database--page} -:topic-4: configuration-schema-db-security--page} +:topic-4: {configuration-schema-db-security--page} :topic-5: {configuration-schema-access-control--page} :topic-6: {configuration-schema-import-filter--page} :topic-7: {configuration-schema-isgr--page} @@ -101,4 +101,4 @@ _Related {this-title} topics_: {topic-1--xref} | {topic-2--xref} | {topic-3 :topic-7--xref!: // End -- Tidy-up -// END -- inclusion -- content-group-configuration.adoc \ No newline at end of file +// END -- inclusion -- content-group-configuration.adoc diff --git a/modules/ROOT/pages/_partials/topic-group-file-based-configuration.adoc b/modules/ROOT/partials/topic-group-file-based-configuration.adoc similarity index 100% rename from modules/ROOT/pages/_partials/topic-group-file-based-configuration.adoc rename to modules/ROOT/partials/topic-group-file-based-configuration.adoc diff --git a/modules/ROOT/pages/_partials/topic-group-get-started.adoc b/modules/ROOT/partials/topic-group-get-started.adoc similarity index 100% rename from modules/ROOT/pages/_partials/topic-group-get-started.adoc rename to modules/ROOT/partials/topic-group-get-started.adoc diff --git a/modules/ROOT/pages/_partials/topic-group-inter-syncgateway.adoc b/modules/ROOT/partials/topic-group-inter-syncgateway.adoc similarity index 100% rename from modules/ROOT/pages/_partials/topic-group-inter-syncgateway.adoc rename to modules/ROOT/partials/topic-group-inter-syncgateway.adoc diff --git a/modules/ROOT/pages/_partials/topic-group-persistent-configuration.adoc b/modules/ROOT/partials/topic-group-persistent-configuration.adoc similarity index 100% rename from modules/ROOT/pages/_partials/topic-group-persistent-configuration.adoc rename to modules/ROOT/partials/topic-group-persistent-configuration.adoc diff --git a/modules/ROOT/pages/_partials/topic-group-start-here.adoc b/modules/ROOT/partials/topic-group-start-here.adoc similarity index 100% rename from modules/ROOT/pages/_partials/topic-group-start-here.adoc rename to modules/ROOT/partials/topic-group-start-here.adoc diff --git a/modules/ROOT/pages/_partials/topic-group-sync-function-api.adoc b/modules/ROOT/partials/topic-group-sync-function-api.adoc similarity index 100% rename from modules/ROOT/pages/_partials/topic-group-sync-function-api.adoc rename to modules/ROOT/partials/topic-group-sync-function-api.adoc diff --git a/modules/ROOT/pages/_partials/winstall-sgw.adoc b/modules/ROOT/partials/winstall-sgw.adoc similarity index 100% rename from modules/ROOT/pages/_partials/winstall-sgw.adoc rename to modules/ROOT/partials/winstall-sgw.adoc diff --git a/modules/ROOT/pages/access-control/access-control-concepts.adoc b/modules/access-control/pages/access-control-concepts.adoc similarity index 90% rename from modules/ROOT/pages/access-control/access-control-concepts.adoc rename to modules/access-control/pages/access-control-concepts.adoc index 1648ebe21..9fdb02b71 100644 --- a/modules/ROOT/pages/access-control/access-control-concepts.adoc +++ b/modules/access-control/pages/access-control-concepts.adoc @@ -1,5 +1,5 @@ = Access Control Concepts -:page-aliases: access-control-concepts.adoc +:page-aliases: ROOT:access-control-concepts.adoc // BEGIN -- PAGE -- access-control-model.adoc // BEGIN PAGE DEFINITION // LOCATION modules/ROOT/pages/ @@ -24,7 +24,7 @@ ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: An introduction to the key concepts behind the provision of effective access control in Sync Gateway -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -41,7 +41,7 @@ include::partial$_set_page_context.adoc[] :param-topic-group: access-control-concepts :param-abstract: pass:q[The sync function API provides several methods that you can use to validate and control user access to databases and documents.] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] [#lbl-access] @@ -72,6 +72,6 @@ include::{concepts}roles.adoc[leveloffset={ouroffset}] // include::{concepts}sync-function.adoc[leveloffset={ouroffset}] -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- PAGE -- access-control-model.adoc diff --git a/modules/ROOT/pages/access-control/access-control-how-assign-users-to-roles.adoc b/modules/access-control/pages/access-control-how-assign-users-to-roles.adoc similarity index 81% rename from modules/ROOT/pages/access-control/access-control-how-assign-users-to-roles.adoc rename to modules/access-control/pages/access-control-how-assign-users-to-roles.adoc index 1cc679a23..bd972a706 100644 --- a/modules/ROOT/pages/access-control/access-control-how-assign-users-to-roles.adoc +++ b/modules/access-control/pages/access-control-how-assign-users-to-roles.adoc @@ -1,5 +1,5 @@ = How to Assign Users to Roles -:page-aliases: access-control-how-assign-users-to-roles.adoc +:page-aliases: ROOT:access-control-how-assign-users-to-roles.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: pass:q[How to assign a Sync Gateway _User_ one or more roles for secure access control in cloud-to-edge enterprise data synchronization.] @@ -9,7 +9,7 @@ ifdef::prerelease[:page-status: {prerelease}] :keywords: access control, document routing, sync -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Local Attributes @@ -20,7 +20,7 @@ include::partial$_set_page_context.adoc[] // BEGIN -- Page Heading :param-topic-group: access-control-how :param-abstract: pass:q[Sync Gateway _Users_ and _Roles_ are a key part of a flexible approach to data routing and access control.] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading :SGW: pass:q[_Sync Gateway_] @@ -36,5 +36,5 @@ include::{howto}assign-users-to-roles.adoc[leveloffset=+0] // BEGIN -- Page Footer -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/access-control/access-control-how-control-document-access.adoc b/modules/access-control/pages/access-control-how-control-document-access.adoc similarity index 80% rename from modules/ROOT/pages/access-control/access-control-how-control-document-access.adoc rename to modules/access-control/pages/access-control-how-control-document-access.adoc index 2f0196bbc..12d9eafbc 100644 --- a/modules/ROOT/pages/access-control/access-control-how-control-document-access.adoc +++ b/modules/access-control/pages/access-control-how-control-document-access.adoc @@ -1,5 +1,5 @@ = Control Document Access -:page-aliases: access-control-how-control-document-access.adoc +:page-aliases: ROOT:access-control-how-control-document-access.adoc, ROOT:write-access.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: pass:q[How to control read/write/delete access using Sync Gateway's Sync Function API to ensure secure access to data in cloud-to-edge enterprise data synchronization.] @@ -7,10 +7,9 @@ ifdef::prerelease[:page-status: {prerelease}] :idseparator: - :url-httpie: https://github.com/jakubroztocil/httpie :keywords: access control, document routing, sync -:page-aliases: write-access.adoc -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Local Attributes @@ -30,7 +29,7 @@ include::partial$_set_page_context.adoc[] :param-topic-group: access-control-how :param-abstract!: // pass:q[Sync Gateway _users_ are a key part of a flexible approach to data routing and access control.] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -38,5 +37,5 @@ include::{howto}control-document-access.adoc[leveloffset=+0] // BEGIN -- Page Footer -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/access-control/access-control-how-create-roles.adoc b/modules/access-control/pages/access-control-how-create-roles.adoc similarity index 82% rename from modules/ROOT/pages/access-control/access-control-how-create-roles.adoc rename to modules/access-control/pages/access-control-how-create-roles.adoc index 1c7c7cd16..fcf491a01 100644 --- a/modules/ROOT/pages/access-control/access-control-how-create-roles.adoc +++ b/modules/access-control/pages/access-control-how-create-roles.adoc @@ -1,5 +1,5 @@ = How to Create a Role -:page-aliases: access-control-how-create-roles.adoc +:page-aliases: ROOT:access-control-how-create-roles.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: pass:q[How to create a Sync Gateway _Role_ for secure access control in cloud-to-edge enterprise data synchronization.] @@ -9,7 +9,7 @@ ifdef::prerelease[:page-status: {prerelease}] :keywords: access control, document routing, sync -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Local Attributes @@ -27,7 +27,7 @@ include::partial$_set_page_context.adoc[] // BEGIN -- Page Heading :param-topic-group: access-control-how :param-abstract: pass:q[Sync Gateway _Roles_ are a key part of a flexible approach to data routing and access control.] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading :include-related: @@ -35,5 +35,5 @@ include::{howto}create-roles.adoc[leveloffset=+0] :include-related! // BEGIN -- Page Footer -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/access-control/access-control-how-create-users.adoc b/modules/access-control/pages/access-control-how-create-users.adoc similarity index 81% rename from modules/ROOT/pages/access-control/access-control-how-create-users.adoc rename to modules/access-control/pages/access-control-how-create-users.adoc index 49fd91531..8dce4e0d2 100644 --- a/modules/ROOT/pages/access-control/access-control-how-create-users.adoc +++ b/modules/access-control/pages/access-control-how-create-users.adoc @@ -1,5 +1,5 @@ = How to Create a User -:page-aliases: access-control-how-create-users.adoc +:page-aliases: ROOT:access-control-how-create-users.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: pass:q[How to create a Sync Gateway user for secure access control in cloud-to-edge enterprise data synchronization.] @@ -10,7 +10,7 @@ ifdef::prerelease[:page-status: {prerelease}] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Local Attributes @@ -29,7 +29,7 @@ include::partial$_set_page_context.adoc[] // BEGIN -- Page Heading :param-topic-group: access-control-how :param-abstract: pass:q[Sync Gateway _users_ are a key part of a flexible approach to data routing and access control.] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -37,5 +37,5 @@ include::{howto}create-users.adoc[leveloffset=+0] // BEGIN -- Page Footer -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/access-control/access-control-how-use-xattrs-for-access-grants.adoc b/modules/access-control/pages/access-control-how-use-xattrs-for-access-grants.adoc similarity index 76% rename from modules/ROOT/pages/access-control/access-control-how-use-xattrs-for-access-grants.adoc rename to modules/access-control/pages/access-control-how-use-xattrs-for-access-grants.adoc index 8bde3e95b..f8ff489f2 100644 --- a/modules/ROOT/pages/access-control/access-control-how-use-xattrs-for-access-grants.adoc +++ b/modules/access-control/pages/access-control-how-use-xattrs-for-access-grants.adoc @@ -1,11 +1,11 @@ = Use Extended Attributes (XATTRs) for Access Grants -:page-aliases: access-control-how-use-xattrs-for-access-grants.adoc +:page-aliases: ROOT:access-control-how-use-xattrs-for-access-grants.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: pass:q[How to set access grants using extended attributes (xattrs).] :keywords: access control, document routing, sync -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes :our-offset: +0 @@ -15,7 +15,7 @@ include::partial$_set_page_context.adoc[] // BEGIN -- Page Heading :param-topic-group: access-control :param-abstract: pass:q[Here we introduce the concept of _XATTRS_ for access grants and their role in assuring secure access control within _Sync Gateway_.] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading :is_fullpage: true @@ -24,5 +24,5 @@ include::{howto}use-xattrs-for-access-grants.adoc[leveloffset={our-offset}] // BEGIN -- Page Footer -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/access-control/access-control-how-verify-access.adoc b/modules/access-control/pages/access-control-how-verify-access.adoc similarity index 77% rename from modules/ROOT/pages/access-control/access-control-how-verify-access.adoc rename to modules/access-control/pages/access-control-how-verify-access.adoc index 6eb1a45e0..004f2d854 100644 --- a/modules/ROOT/pages/access-control/access-control-how-verify-access.adoc +++ b/modules/access-control/pages/access-control-how-verify-access.adoc @@ -1,5 +1,5 @@ = How to Verify Access -:page-aliases: access-control-how-verify-access.adoc +:page-aliases: ROOT:access-control-how-verify-access.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: pass:q[How to verify Sync Gateway access to data in cloud-to-edge enterprise data synchronization.] @@ -9,7 +9,7 @@ ifdef::prerelease[:page-status: {prerelease}] :keywords: access control, document routing, sync -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Local Attributes @@ -21,7 +21,7 @@ include::partial$_set_page_context.adoc[] :param-topic-group: access-control-how :param-abstract!: // pass:q[Sync Gateway _users_ are a key part of a flexible approach to data routing and access control.] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -29,5 +29,5 @@ include::{howto}verify-access.adoc[leveloffset=+0] // BEGIN -- Page Footer -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/access-control/access-control-how.adoc b/modules/access-control/pages/access-control-how.adoc similarity index 90% rename from modules/ROOT/pages/access-control/access-control-how.adoc rename to modules/access-control/pages/access-control-how.adoc index 61919e144..29051db15 100644 --- a/modules/ROOT/pages/access-control/access-control-how.adoc +++ b/modules/access-control/pages/access-control-how.adoc @@ -1,5 +1,5 @@ = Access Control How-To -:page-aliases: access-control-how.adoc +:page-aliases: ROOT:access-control-how.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] // BEGIN -- PAGE -- access-control-model.adoc @@ -23,7 +23,7 @@ ifdef::prerelease[:page-status: {prerelease}] // END PAGE DEFINITION :description: How to implement Sync Gateway access controls using Configuration File, Admin REST API and-or the Sync Function to manage documents, users, roles and channels -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes :our-offset: +1 @@ -40,7 +40,7 @@ include::partial$_set_page_context.adoc[] :param-topic-group: access-control :param-abstract: pass:q[The sync function API provides several methods that you can use to validate and control user access to databases and documents.] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == Introduction @@ -55,7 +55,7 @@ There are a number of ways in which you can control document distribution and us [#lst1] .Ways to configure access -* Legacy Pre 3.0: Use the xref:configuration/configuration-properties-legacy.adoc[Legacy Configuration Properties] file's xref:configuration/configuration-properties-legacy.adoc#databases-user-admin-channels[admin_user_channels] +* Legacy Pre 3.0: Use the xref:configuration:configuration-properties-legacy.adoc[Legacy Configuration Properties] file's xref:configuration:configuration-properties-legacy.adoc#databases-user-admin-channels[admin_user_channels] * Dynamically ** At the time of user creation with Admin REST Endpoint {rest-api-admin-user-post--xref} using `admin_channel` ** Using the Sync Function's {sync-function-api-access-cmd--xref}. @@ -63,7 +63,7 @@ There are a number of ways in which you can control document distribution and us .Control Points [#img-channel-access] ==== -image::channel-access-grant-all.png[,400] +image::ROOT:channel-access-grant-all.png[,400] <.> Documents are assigned to channel using the Sync Function's {sync-function-api-channel-cmd--xref} API. @@ -113,6 +113,6 @@ include::{howto}verify-access.adoc[leveloffset={our-offset}] include::{howto}use-xattrs-for-access-grants.adoc[leveloffset={our-offset}] -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- PAGE -- access-control-model.adoc diff --git a/modules/ROOT/pages/access-control/access-control-model.adoc b/modules/access-control/pages/access-control-model.adoc similarity index 74% rename from modules/ROOT/pages/access-control/access-control-model.adoc rename to modules/access-control/pages/access-control-model.adoc index 43bb34f49..4b625673b 100644 --- a/modules/ROOT/pages/access-control/access-control-model.adoc +++ b/modules/access-control/pages/access-control-model.adoc @@ -1,11 +1,11 @@ = Access Control Model -:page-aliases: access-control-model.adoc +:page-aliases: ROOT:access-control-model.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: pass:q[An introduction to access control in Sync Gateway] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -18,11 +18,11 @@ include::partial$_set_page_context.adoc[] :param-abstract!: // pass:q[Here we introduce the concept of _users_ and their role in assuring secure access control within _Sync Gateway_.] :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading include::{concepts}access-control-model.adoc[levelofset=+0] -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] diff --git a/modules/ROOT/pages/access-control/auto-purge-channel-access-revocation.adoc b/modules/access-control/pages/auto-purge-channel-access-revocation.adoc similarity index 96% rename from modules/ROOT/pages/access-control/auto-purge-channel-access-revocation.adoc rename to modules/access-control/pages/auto-purge-channel-access-revocation.adoc index bdd61c8d6..50f24f3ab 100644 --- a/modules/ROOT/pages/access-control/auto-purge-channel-access-revocation.adoc +++ b/modules/access-control/pages/auto-purge-channel-access-revocation.adoc @@ -1,11 +1,11 @@ = Auto-Purge on Channel Access Revocation -:page-aliases: anchor-auto-purge-channel-access-revocation, auto-purge-channel-access-revocation.adoc +:page-aliases: anchor-auto-purge-channel-access-revocation, ROOT:auto-purge-channel-access-revocation.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: pass:q[Auto-purge behavior on loss of access to document channels] :keywords: access control, document routing, sync, auto-purge -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -17,7 +17,7 @@ include::partial$_set_page_context.adoc[] :param-topic-group: access-control :param-abstract!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading == Overview @@ -29,7 +29,7 @@ include::partial$_show_page_header_block.adoc[] // :param-page: replication // :param-bookmark: replication-events -// include::partial$blocklinks-cbl.adoc[] +// include::ROOT:partial$blocklinks-cbl.adoc[] // [#lbl-access-revocation] @@ -132,7 +132,7 @@ NOTE: This behavior is the *reverse* of that between {sgw-t} and Couchbase Lite By default, documents are *not* auto purged on the active sync gateway even if the user on the passive sync gateway loses channel access. -You can opt-in to auto-purge behavior using the replicator level option `purge_on_removal` in the REST API -- see: xref:configuration/configuration-schema-isgr.adoc#replication-purge_on_removal[replication-purge_on_removal]. +You can opt-in to auto-purge behavior using the replicator level option `purge_on_removal` in the REST API -- see: xref:configuration:configuration-schema-isgr.adoc#replication-purge_on_removal[replication-purge_on_removal]. Documents will then *be* auto-purged -- on active Sync Gateway nodes that have opted-in -- if they do not belong to *any* of the replicating user’s footnote:[pass:q,a[The _replicating user_ is the user on the _passive_ sync gateway cluster; the user specified in the replication definition.]] channels -- see: <>. @@ -291,6 +291,6 @@ Here is the default Sync Function when you have upgraded; it remains the same as ==== // BEGIN -- Page Footer -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/access-control/channels.adoc b/modules/access-control/pages/channels.adoc similarity index 68% rename from modules/ROOT/pages/access-control/channels.adoc rename to modules/access-control/pages/channels.adoc index 08a0d7c64..a4ffcc39a 100644 --- a/modules/ROOT/pages/access-control/channels.adoc +++ b/modules/access-control/pages/channels.adoc @@ -1,11 +1,11 @@ = Channels -:page-aliases: data-routing.adoc, learn/sync-gateway-channels.adoc, sync-gateway-channels.adoc, channels.adoc +:page-aliases: ROOT:data-routing.adoc, ROOT:learn/sync-gateway-channels.adoc, ROOT:sync-gateway-channels.adoc, ROOT:channels.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: pass:q[About Sync Gateway _Channels_ and their part in data routing and access control for secure cloud-to-edge enterprise data synchronization.] :keywords: access control, document routing, sync -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -17,7 +17,7 @@ include::partial$_set_page_context.adoc[] :param-topic-group: access-control-concepts :param-abstract!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -25,6 +25,6 @@ include::{concepts}channels.adoc[] // BEGIN -- Page Footer -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/access-control/roles.adoc b/modules/access-control/pages/roles.adoc similarity index 76% rename from modules/ROOT/pages/access-control/roles.adoc rename to modules/access-control/pages/roles.adoc index 48abd2bd4..928ca2498 100644 --- a/modules/ROOT/pages/access-control/roles.adoc +++ b/modules/access-control/pages/roles.adoc @@ -1,5 +1,5 @@ = Roles -:page-aliases: learn/roles.adoc, roles.adoc +:page-aliases: ROOT:learn/roles.adoc, ROOT:roles.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -7,13 +7,13 @@ ifdef::prerelease[:page-status: {prerelease}] :description: pass:q[About Sync Gateway _Roles_ and their part in secure cloud-to-edge enterprise data synchronization.] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Heading :param-topic-group: access-control-concepts :param-abstract: pass:q[Here we introduce the concept of _Roles_ and the part they play in assuring secure access control within _Sync Gateway_.] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -25,4 +25,4 @@ include::{concepts}roles.adoc[leveloffset=+0] include::{howto}create-roles.adoc[leveloffset=+0] -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] diff --git a/modules/ROOT/pages/access-control/sync-function/sync-function-api-access-cmd.adoc b/modules/access-control/pages/sync-function/sync-function-api-access-cmd.adoc similarity index 57% rename from modules/ROOT/pages/access-control/sync-function/sync-function-api-access-cmd.adoc rename to modules/access-control/pages/sync-function/sync-function-api-access-cmd.adoc index 15fc2fa32..f32a9ffb1 100644 --- a/modules/ROOT/pages/access-control/sync-function/sync-function-api-access-cmd.adoc +++ b/modules/access-control/pages/sync-function/sync-function-api-access-cmd.adoc @@ -1,11 +1,11 @@ = Access() -:page-aliases: sync-function-api-access-cmd.adoc +:page-aliases: ROOT:sync-function-api-access-cmd.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: pass:q[Enabling Sync Gateway data access] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes :SGW: pass:q[_Sync Gateway_] @@ -16,11 +16,11 @@ include::partial$_set_page_context.adoc[] :param-topic-group: sync-function-api :param-abstract!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading -include::partial$sync-api/sync-function-api-access.adoc[levelofset=+0] +include::ROOT:partial$sync-api/sync-function-api-access.adoc[levelofset=+0] -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] diff --git a/modules/ROOT/pages/access-control/sync-function/sync-function-api-channel-cmd.adoc b/modules/access-control/pages/sync-function/sync-function-api-channel-cmd.adoc similarity index 57% rename from modules/ROOT/pages/access-control/sync-function/sync-function-api-channel-cmd.adoc rename to modules/access-control/pages/sync-function/sync-function-api-channel-cmd.adoc index 34f1a090e..58840e7ca 100644 --- a/modules/ROOT/pages/access-control/sync-function/sync-function-api-channel-cmd.adoc +++ b/modules/access-control/pages/sync-function/sync-function-api-channel-cmd.adoc @@ -1,11 +1,11 @@ = channel() -:page-aliases: sync-function-api-channel-cmd.adoc +:page-aliases: ROOT:sync-function-api-channel-cmd.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: pass:q[Assigning Sync Gateway _channels_] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -17,12 +17,12 @@ include::partial$_set_page_context.adoc[] :param-topic-group: sync-function-api :param-abstract!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading -include::partial$sync-api/sync-function-api-channel.adoc[levelofset=+0] +include::ROOT:partial$sync-api/sync-function-api-channel.adoc[levelofset=+0] -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] diff --git a/modules/ROOT/pages/access-control/sync-function/sync-function-api-expiry-cmd.adoc b/modules/access-control/pages/sync-function/sync-function-api-expiry-cmd.adoc similarity index 58% rename from modules/ROOT/pages/access-control/sync-function/sync-function-api-expiry-cmd.adoc rename to modules/access-control/pages/sync-function/sync-function-api-expiry-cmd.adoc index 040be1ef8..6ec0ef925 100644 --- a/modules/ROOT/pages/access-control/sync-function/sync-function-api-expiry-cmd.adoc +++ b/modules/access-control/pages/sync-function/sync-function-api-expiry-cmd.adoc @@ -1,11 +1,11 @@ = expiry() -:page-aliases: sync-function-api-expiry-cmd.adoc +:page-aliases: ROOT:sync-function-api-expiry-cmd.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: pass:q[Setting an expiry value on a document in a local database] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes :SGW: pass:q[_Sync Gateway_] @@ -16,11 +16,11 @@ include::partial$_set_page_context.adoc[] :param-topic-group: sync-function-api :param-abstract!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading -include::partial$sync-api/sync-function-api-expiry.adoc[levelofset=+0] +include::ROOT:partial$sync-api/sync-function-api-expiry.adoc[levelofset=+0] -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] diff --git a/modules/ROOT/pages/access-control/sync-function/sync-function-api-require-access-cmd.adoc b/modules/access-control/pages/sync-function/sync-function-api-require-access-cmd.adoc similarity index 56% rename from modules/ROOT/pages/access-control/sync-function/sync-function-api-require-access-cmd.adoc rename to modules/access-control/pages/sync-function/sync-function-api-require-access-cmd.adoc index b43a421fb..c43f97b3b 100644 --- a/modules/ROOT/pages/access-control/sync-function/sync-function-api-require-access-cmd.adoc +++ b/modules/access-control/pages/sync-function/sync-function-api-require-access-cmd.adoc @@ -1,11 +1,11 @@ = requireAccess() -:page-aliases: sync-function-api-require-access-cmd.adoc +:page-aliases: ROOT:sync-function-api-require-access-cmd.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: pass:q[Enabling Sync Gateway data access] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes :SGW: pass:q[_Sync Gateway_] @@ -16,11 +16,11 @@ include::partial$_set_page_context.adoc[] :param-topic-group: sync-function-api :param-abstract!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading -include::partial$sync-api/sync-function-api-require-access.adoc[levelofset=+0] +include::ROOT:partial$sync-api/sync-function-api-require-access.adoc[levelofset=+0] -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] diff --git a/modules/ROOT/pages/access-control/sync-function/sync-function-api-require-admin-cmd.adoc b/modules/access-control/pages/sync-function/sync-function-api-require-admin-cmd.adoc similarity index 56% rename from modules/ROOT/pages/access-control/sync-function/sync-function-api-require-admin-cmd.adoc rename to modules/access-control/pages/sync-function/sync-function-api-require-admin-cmd.adoc index f97fb15e4..bf3c6e8ed 100644 --- a/modules/ROOT/pages/access-control/sync-function/sync-function-api-require-admin-cmd.adoc +++ b/modules/access-control/pages/sync-function/sync-function-api-require-admin-cmd.adoc @@ -1,11 +1,11 @@ = requireAdmin() -:page-aliases: sync-function-api-require-admin-cmd.adoc +:page-aliases: ROOT:sync-function-api-require-admin-cmd.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: pass:q[Requiring Sync Gateway admin user] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes :SGW: pass:q[_Sync Gateway_] @@ -16,11 +16,11 @@ include::partial$_set_page_context.adoc[] :param-topic-group: sync-function-api :param-abstract!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading -include::partial$sync-api/sync-function-api-require-admin.adoc[levelofset=+0] +include::ROOT:partial$sync-api/sync-function-api-require-admin.adoc[levelofset=+0] -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] diff --git a/modules/ROOT/pages/access-control/sync-function/sync-function-api-require-role-cmd.adoc b/modules/access-control/pages/sync-function/sync-function-api-require-role-cmd.adoc similarity index 56% rename from modules/ROOT/pages/access-control/sync-function/sync-function-api-require-role-cmd.adoc rename to modules/access-control/pages/sync-function/sync-function-api-require-role-cmd.adoc index 8514c951f..a5f8598bc 100644 --- a/modules/ROOT/pages/access-control/sync-function/sync-function-api-require-role-cmd.adoc +++ b/modules/access-control/pages/sync-function/sync-function-api-require-role-cmd.adoc @@ -1,11 +1,11 @@ = requireRole() -:page-aliases: sync-function-api-require-role-cmd.adoc +:page-aliases: ROOT:sync-function-api-require-role-cmd.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: pass:q[Requiring Sync Gateway role] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes :SGW: pass:q[_Sync Gateway_] @@ -16,11 +16,11 @@ include::partial$_set_page_context.adoc[] :param-topic-group: sync-function-api :param-abstract!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading -include::partial$sync-api/sync-function-api-require-role.adoc[levelofset=+0] +include::ROOT:partial$sync-api/sync-function-api-require-role.adoc[levelofset=+0] -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] diff --git a/modules/ROOT/pages/access-control/sync-function/sync-function-api-require-user-cmd.adoc b/modules/access-control/pages/sync-function/sync-function-api-require-user-cmd.adoc similarity index 56% rename from modules/ROOT/pages/access-control/sync-function/sync-function-api-require-user-cmd.adoc rename to modules/access-control/pages/sync-function/sync-function-api-require-user-cmd.adoc index 5795a3d7a..76b7e327f 100644 --- a/modules/ROOT/pages/access-control/sync-function/sync-function-api-require-user-cmd.adoc +++ b/modules/access-control/pages/sync-function/sync-function-api-require-user-cmd.adoc @@ -1,11 +1,11 @@ = requireUser() -:page-aliases: sync-function-api-require-user-cmd.adoc +:page-aliases: ROOT:sync-function-api-require-user-cmd.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: pass:q[Requiring Sync Gateway user] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes :SGW: pass:q[_Sync Gateway_] @@ -16,11 +16,11 @@ include::partial$_set_page_context.adoc[] :param-topic-group: sync-function-api :param-abstract!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading -include::partial$sync-api/sync-function-api-require-user.adoc[levelofset=+0] +include::ROOT:partial$sync-api/sync-function-api-require-user.adoc[levelofset=+0] -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] diff --git a/modules/ROOT/pages/access-control/sync-function/sync-function-api-role-cmd.adoc b/modules/access-control/pages/sync-function/sync-function-api-role-cmd.adoc similarity index 57% rename from modules/ROOT/pages/access-control/sync-function/sync-function-api-role-cmd.adoc rename to modules/access-control/pages/sync-function/sync-function-api-role-cmd.adoc index fab78a727..b1b1b3af4 100644 --- a/modules/ROOT/pages/access-control/sync-function/sync-function-api-role-cmd.adoc +++ b/modules/access-control/pages/sync-function/sync-function-api-role-cmd.adoc @@ -1,11 +1,11 @@ = role() -:page-aliases: sync-function-api-role-cmd.adoc +:page-aliases: ROOT:sync-function-api-role-cmd.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: pass:q[Assigning Sync Gateway _roles_] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -17,12 +17,12 @@ include::partial$_set_page_context.adoc[] :param-topic-group: sync-function-api :param-abstract!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading -include::partial$sync-api/sync-function-api-role.adoc[levelofset=+0] +include::ROOT:partial$sync-api/sync-function-api-role.adoc[levelofset=+0] -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] diff --git a/modules/ROOT/pages/access-control/sync-function/sync-function-api-throw-cmd.adoc b/modules/access-control/pages/sync-function/sync-function-api-throw-cmd.adoc similarity index 58% rename from modules/ROOT/pages/access-control/sync-function/sync-function-api-throw-cmd.adoc rename to modules/access-control/pages/sync-function/sync-function-api-throw-cmd.adoc index 619308a68..86aab0266 100644 --- a/modules/ROOT/pages/access-control/sync-function/sync-function-api-throw-cmd.adoc +++ b/modules/access-control/pages/sync-function/sync-function-api-throw-cmd.adoc @@ -1,11 +1,11 @@ = throw() -:page-aliases: sync-function-api-throw-cmd.adoc +:page-aliases: ROOT:sync-function-api-throw-cmd.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: pass:q[Rejecting a document change in Sync Gateway] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes :SGW: pass:q[_Sync Gateway_] @@ -16,11 +16,11 @@ include::partial$_set_page_context.adoc[] :param-topic-group: sync-function-api :param-abstract!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading -include::partial$sync-api/sync-function-api-throw.adoc[levelofset=+0] +include::ROOT:partial$sync-api/sync-function-api-throw.adoc[levelofset=+0] -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] diff --git a/modules/ROOT/pages/access-control/sync-function/sync-function-api.adoc b/modules/access-control/pages/sync-function/sync-function-api.adoc similarity index 89% rename from modules/ROOT/pages/access-control/sync-function/sync-function-api.adoc rename to modules/access-control/pages/sync-function/sync-function-api.adoc index 55968d515..6de372b96 100644 --- a/modules/ROOT/pages/access-control/sync-function/sync-function-api.adoc +++ b/modules/access-control/pages/sync-function/sync-function-api.adoc @@ -21,7 +21,7 @@ // INCLUSION USAGE // END PAGE DEFINITION = Sync Function API Reference -:page-aliases: advance/adv-sgw-cfg-sync-function.adoc, sync-function-api.adoc +:page-aliases: ROOT:advance/adv-sgw-cfg-sync-function.adoc, ROOT:sync-function-api.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -31,7 +31,7 @@ ifdef::prerelease[:page-status: {prerelease}] :idseparator: - -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN - page attributes @@ -43,7 +43,7 @@ include::partial$_set_page_context.adoc[] :param-topic-group: access-control :param-abstract: pass:q[The Sync Function is crucial to the security of data sync and replication. It is in charge of data validation, access control and routing. This topic provides a reference resource on Sync and its helper functions.] :param-related: {sync-function-overview--xref} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading NOTE: The Sync Function uses the https://ecma-international.org/wp-content/uploads/ECMA-262_5.1_edition_june_2011.pdf[ES5 standard] of JavaScript syntax. @@ -51,7 +51,7 @@ NOTE: The Sync Function uses the https://ecma-international.org/wp-content/uploa include::{howto}sync-function-api.adoc[leveloffset={ouroffset}] // BEGIN -- Page Footer -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/access-control/sync-function/sync-function.adoc b/modules/access-control/pages/sync-function/sync-function.adoc similarity index 87% rename from modules/ROOT/pages/access-control/sync-function/sync-function.adoc rename to modules/access-control/pages/sync-function/sync-function.adoc index 0e547dbb3..f6709637b 100644 --- a/modules/ROOT/pages/access-control/sync-function/sync-function.adoc +++ b/modules/access-control/pages/sync-function/sync-function.adoc @@ -1,5 +1,6 @@ = Sync Function -:page-aliases: sync-function.adoc +:page-aliases: ROOT:sync-function.adoc +:page-aliases: ROOT:sync-function.adoc, ROOT:sync-function-overview.adoc, sync-function-overview.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -8,13 +9,13 @@ ifdef::prerelease[:page-status: {prerelease}] :ouroffset: +0 -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Heading :param-topic-group: access-control :param-abstract: pass:q[Here we introduce the concept of _Roles_ and the part they play in assuring secure access control within _Sync Gateway_.] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -26,7 +27,7 @@ include::{concepts}sync-function.adoc[leveloffset={ouroffset}] include::{howto}sync-function-api.adoc[leveloffset={ouroffset}] -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/access-control/users.adoc b/modules/access-control/pages/users.adoc similarity index 74% rename from modules/ROOT/pages/access-control/users.adoc rename to modules/access-control/pages/users.adoc index 038e9d1ae..e04fa7e92 100644 --- a/modules/ROOT/pages/access-control/users.adoc +++ b/modules/access-control/pages/users.adoc @@ -1,11 +1,11 @@ = Users -:page-aliases: learn/users-and-roles.adoc, users-and-roles.adoc, users.adoc +:page-aliases: ROOT:learn/users-and-roles.adoc, ROOT:users-and-roles.adoc, ROOT:users.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: pass:q[About Sync Gateway _users_ and their role in secure cloud-to-edge enterprise data synchronization.] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -17,7 +17,7 @@ include::partial$_set_page_context.adoc[] :param-topic-group: access-control-concepts :param-abstract: pass:q[Here we introduce the concept of _users_ and their role in assuring secure access control within _Sync Gateway_.] :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading include::{concepts}users.adoc[levelofset=+0] @@ -28,4 +28,4 @@ include::{concepts}users.adoc[levelofset=+0] include::{howto}create-users.adoc[leveloffset=+0] -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] diff --git a/modules/ROOT/pages/configuration/configuration-environment-variables.adoc b/modules/configuration/pages/configuration-environment-variables.adoc similarity index 95% rename from modules/ROOT/pages/configuration/configuration-environment-variables.adoc rename to modules/configuration/pages/configuration-environment-variables.adoc index 5f1110a87..5c49da57c 100644 --- a/modules/ROOT/pages/configuration/configuration-environment-variables.adoc +++ b/modules/configuration/pages/configuration-environment-variables.adoc @@ -1,5 +1,5 @@ = Configuration Environment Variables -:page-aliases: configuration-environment-variables.adoc +:page-aliases: ROOT:configuration-environment-variables.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -7,7 +7,7 @@ ifdef::prerelease[:page-status: {prerelease}] :description: Using environment variables in the configuration of Sync Gateway :keywords: sync, data replication, cloud-to-edge, configuration, variables -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // Begin -- declare page attributes :double-dollar: $$ @@ -22,12 +22,12 @@ include::partial$_set_page_context.adoc[] :param-abstract!: :param-related!: // {configuration-overview--xref} | {configuration-javascript-functions--xref} | {configuration-schema-bootstrap--xref} | {configuration-rest-api--xref} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == Introduction -include::partial$feature-catalog.adoc[tags=config-env-vars-def] +include::ROOT:partial$feature-catalog.adoc[tags=config-env-vars-def] The use of environment variables within the configuration file increases the flexibility of the configuration process. It makes the switching of the runtime behavior -- for example during development, experimentation or testing -- much easier. @@ -186,4 +186,4 @@ $ENV:PASSWORD='pa{double-dollar}word' // <.> ===== -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/configuration/configuration-javascript-functions.adoc b/modules/configuration/pages/configuration-javascript-functions.adoc similarity index 71% rename from modules/ROOT/pages/configuration/configuration-javascript-functions.adoc rename to modules/configuration/pages/configuration-javascript-functions.adoc index 4e2d3605a..63da3a585 100644 --- a/modules/ROOT/pages/configuration/configuration-javascript-functions.adoc +++ b/modules/configuration/pages/configuration-javascript-functions.adoc @@ -1,6 +1,6 @@ // BEGIN -- PAGE -- config-external-javascript-functions.adoc = Using External Javascript Functions -:page-aliases: configuration-javascript-functions.adoc +:page-aliases: ROOT:configuration-javascript-functions.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -13,10 +13,10 @@ include::ROOT:partial$_set_page_context.adoc[] :param-abstract!: :param-topic-group: file-based-configuration :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] -include::partial$common-cfg-ext-javascript.adoc[] +include::ROOT:partial$common-cfg-ext-javascript.adoc[] -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- PAGE -- config-external-javascript-functions.adoc diff --git a/modules/ROOT/pages/configuration/configuration-overview.adoc b/modules/configuration/pages/configuration-overview.adoc similarity index 95% rename from modules/ROOT/pages/configuration/configuration-overview.adoc rename to modules/configuration/pages/configuration-overview.adoc index 8964d11ed..35eaf243a 100644 --- a/modules/ROOT/pages/configuration/configuration-overview.adoc +++ b/modules/configuration/pages/configuration-overview.adoc @@ -1,5 +1,5 @@ = Configuration Overview -:page-aliases: configuration-overview.adoc +:page-aliases: ROOT:configuration-overview.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-content: conceptual @@ -7,12 +7,12 @@ ifdef::prerelease[:page-status: {prerelease}] :keywords: sync, data replication, cloud-to-edge, configuration // BEGIN -- DO NOT EDIT -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-abstract!: :param-topic-group: configuration :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- DO NOT EDIT @@ -56,7 +56,7 @@ Your existing legacy Pre-3.0 configuration files will (optionally) be automatica In the {ec-te} ecosphere you provide a minimal bootstrap configuration to get Sync Gateway started, then add users, roles, database and replications using the REST API. .Configuration Workflow -image::persistent-config.png[,750] +image::ROOT:persistent-config.png[,750] . Set up a user for the Admin REST API on Couchbase Server + Alternatively, you can disable authentication of REST API user(s) -- for test purposes *only* @@ -86,7 +86,7 @@ Use the {sgw--xref}{configuration-schema--isgr--page}[inter-{sgw} replication] e === Opt-out :no-admonition: -include::partial$block-caveats.adoc[tags=disable-persistent-config] +include::ROOT:partial$block-caveats.adoc[tags=disable-persistent-config] This ensures you can use the {configuration-properties-legacy--xref}. Note that no Admin REST API changes are persisted across {sgw} restarts. @@ -197,4 +197,4 @@ If you move a {sgw} node to a new group, it will inherit the configuration assoc This applies also if you move a group (back) into the `default` group. -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/configuration/configuration-properties-legacy.adoc b/modules/configuration/pages/configuration-properties-legacy.adoc similarity index 88% rename from modules/ROOT/pages/configuration/configuration-properties-legacy.adoc rename to modules/configuration/pages/configuration-properties-legacy.adoc index 245c7d2d2..304e2332c 100644 --- a/modules/ROOT/pages/configuration/configuration-properties-legacy.adoc +++ b/modules/configuration/pages/configuration-properties-legacy.adoc @@ -1,5 +1,5 @@ = Legacy Pre-3.0 Configuration -:page-aliases: configuration-properties.adoc, refer/config-properties.adoc, config-properties.adoc, configuration-properties-legacy.adoc +:page-aliases: ROOT:configuration-properties.adoc, ROOT:refer/config-properties.adoc, ROOT:config-properties.adoc, ROOT:configuration-properties-legacy.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-status: Legacy Content @@ -10,14 +10,14 @@ ifdef::prerelease[:page-status: {prerelease}] // BEGIN -- DO NOT EDIT -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // :topic-group: configuration :param-topic-group: file-based-configuration :param-abstract!: // :param-related: {get-started-verify-install--xref} | {rest-api-admin--xref} | {rest-api--xref} | {rest-api-client-app--xref} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- DO NOT EDIT @@ -30,7 +30,7 @@ For current configuration details, see: {configuration-overview--xref} and-or {c This page describes Sync Gateway's legacy Pre-3.0 configuration method. It uses a centralized configuration file to hold all configuration settings in JSON form -- see:<> for the file contents. -include::partial$block-caveats.adoc[tags=disable-persistent-config] +include::ROOT:partial$block-caveats.adoc[tags=disable-persistent-config] Many configuration settings can be changed using the {rest-api-admin--xref} *but these are not persisted beyond a Sync Gateway restart*. To make persistent changes you must edit the central Configuration Properties file -- or switch to the 3.x persistent configuration -- see: {configuration-overview--xref} @@ -96,5 +96,5 @@ include::{example-cfg}[tags=icr-sample-sync-gateway-config, indent=0] // BEGIN -- Page Footer -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/configuration/configuration-rest-api.adoc b/modules/configuration/pages/configuration-rest-api.adoc similarity index 67% rename from modules/ROOT/pages/configuration/configuration-rest-api.adoc rename to modules/configuration/pages/configuration-rest-api.adoc index c22d14ab9..1d45eb874 100644 --- a/modules/ROOT/pages/configuration/configuration-rest-api.adoc +++ b/modules/configuration/pages/configuration-rest-api.adoc @@ -1,5 +1,5 @@ = Configuration Rest API -:page-aliases: configuration-rest-api.adoc +:page-aliases: ROOT:configuration-rest-api.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -7,16 +7,16 @@ ifdef::prerelease[:page-status: {prerelease}] :description: How to use the Config REST API to configure Sync Gateway for secure cloud-to-edge data sync :keywords: sync, data replication, cloud-to-edge, -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-abstract!: :param-topic-group: configuration :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == Introduction Sync Gateway ... -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/configuration/configuration-schema-access-control.adoc b/modules/configuration/pages/configuration-schema-access-control.adoc similarity index 53% rename from modules/ROOT/pages/configuration/configuration-schema-access-control.adoc rename to modules/configuration/pages/configuration-schema-access-control.adoc index 8a5a05d52..c20f337d2 100644 --- a/modules/ROOT/pages/configuration/configuration-schema-access-control.adoc +++ b/modules/configuration/pages/configuration-schema-access-control.adoc @@ -1,14 +1,14 @@ = Access Control Configuration -:page-aliases: configuration-schema-access-control.adoc +:page-aliases: ROOT:configuration-schema-access-control.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: Using Sync Gateway's Admin REST API and the Sync function to configure access -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] -include::partial$static_restapi/css.adoc[] +include::ROOT:partial$static_restapi/css.adoc[] -include::partial$block-caveats.adoc[tags="legacy-config-equivalents"] +include::ROOT:partial$block-caveats.adoc[tags="legacy-config-equivalents"] == Introduction @@ -16,16 +16,16 @@ include::{concepts}sync-function.adoc[tags=summary] For more on the Sync Function and access control see: {sync-function-overview--xref} -include::partial$static_restapi/admin/index.adoc[tags=put_keyspace-_config-sync,leveloffset=+1] +include::ROOT:partial$static_restapi/admin/index.adoc[tags=put_keyspace-_config-sync,leveloffset=+1] [#HTTP_Error] == Errors This section shows possible error responses returned by the Admin REST API. -include::partial$static_restapi/admin/index.adoc[tags=HTTP_Error] +include::ROOT:partial$static_restapi/admin/index.adoc[tags=HTTP_Error] // BEGIN -- DO NOT EDIT -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] // END -- DO NOT EDIT diff --git a/modules/ROOT/pages/configuration/configuration-schema-bootstrap.adoc b/modules/configuration/pages/configuration-schema-bootstrap.adoc similarity index 83% rename from modules/ROOT/pages/configuration/configuration-schema-bootstrap.adoc rename to modules/configuration/pages/configuration-schema-bootstrap.adoc index b184cef2b..3ee752146 100644 --- a/modules/ROOT/pages/configuration/configuration-schema-bootstrap.adoc +++ b/modules/configuration/pages/configuration-schema-bootstrap.adoc @@ -1,6 +1,6 @@ = Bootstrap Configuration -:page-aliases: configuration-schema-bootstrap.adoc +:page-aliases: ROOT:configuration-schema-bootstrap.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -10,17 +10,17 @@ ifdef::prerelease[:page-status: {prerelease}] // BEGIN -- DO NOT EDIT -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-abstract!: :param-related!: :param-topic-group: configuration -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- DO NOT EDIT -include::partial$block-caveats.adoc[tags="legacy-config-equivalents"] +include::ROOT:partial$block-caveats.adoc[tags="legacy-config-equivalents"] == Introduction @@ -55,6 +55,6 @@ This schema identifies all the configurable properties. -- // BEGIN -- DO NOT EDIT -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] // END -- DO NOT EDIT diff --git a/modules/ROOT/pages/configuration/configuration-schema-database.adoc b/modules/configuration/pages/configuration-schema-database.adoc similarity index 85% rename from modules/ROOT/pages/configuration/configuration-schema-database.adoc rename to modules/configuration/pages/configuration-schema-database.adoc index 60b8e329e..4aee0fb29 100644 --- a/modules/ROOT/pages/configuration/configuration-schema-database.adoc +++ b/modules/configuration/pages/configuration-schema-database.adoc @@ -1,23 +1,23 @@ = Database Configuration -:page-aliases: configuration-schema-database.adoc +:page-aliases: ROOT:configuration-schema-database.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: Using Sync Gateway's Admin REST API to configure and manage databases // BEGIN -- DO NOT EDIT -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-abstract!: :param-related!: :param-topic-group: configuration -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- DO NOT EDIT -include::partial$static_restapi/css.adoc[] +include::ROOT:partial$static_restapi/css.adoc[] -include::partial$block-caveats.adoc[tags="legacy-config-equivalents"] +include::ROOT:partial$block-caveats.adoc[tags="legacy-config-equivalents"] == Introduction @@ -28,7 +28,7 @@ NOTE: You can define 1 custom scope per database with up to 1000 custom collecti If you don't specify a custom scope and collection, any documents you create will be saved in the default scope and collection. [#lbl-create-db] -include::partial$static_restapi/admin/index.adoc[tags="put_db-",leveloffset=+1] +include::ROOT:partial$static_restapi/admin/index.adoc[tags="put_db-",leveloffset=+1] === Example @@ -86,7 +86,7 @@ Content-Length: 44 [#lbl-configure-db] -include::partial$static_restapi/admin/index.adoc[tags="post_db-_config",leveloffset=+1] +include::ROOT:partial$static_restapi/admin/index.adoc[tags="post_db-_config",leveloffset=+1] === Example @@ -161,9 +161,9 @@ The configuration settings described here are provisioned through the {rest-api- This section shows possible error responses returned by the Admin REST API. -include::partial$static_restapi/admin/index.adoc[tags=HTTP_Error] +include::ROOT:partial$static_restapi/admin/index.adoc[tags=HTTP_Error] // BEGIN -- DO NOT EDIT -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] // END -- DO NOT EDIT diff --git a/modules/ROOT/pages/configuration/configuration-schema-db-security.adoc b/modules/configuration/pages/configuration-schema-db-security.adoc similarity index 84% rename from modules/ROOT/pages/configuration/configuration-schema-db-security.adoc rename to modules/configuration/pages/configuration-schema-db-security.adoc index d6e3ab3c1..83668aec5 100644 --- a/modules/ROOT/pages/configuration/configuration-schema-db-security.adoc +++ b/modules/configuration/pages/configuration-schema-db-security.adoc @@ -1,5 +1,5 @@ = Database Security -:page-aliases: configuration-schema-db-security.adoc +:page-aliases: ROOT:configuration-schema-db-security.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-content: Reference @@ -8,19 +8,19 @@ ifdef::prerelease[:page-status: {prerelease}] :ouroffsetlevel: +1 // BEGIN -- DO NOT EDIT -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-abstract!: Introducing the use of user and role endpoints for the administration of Sync Gateway users. :param-related!: :param-topic-group: configuration -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- DO NOT EDIT -include::partial$static_restapi/css.adoc[] +include::ROOT:partial$static_restapi/css.adoc[] -include::partial$block-caveats.adoc[tags="legacy-config-equivalents"] +include::ROOT:partial$block-caveats.adoc[tags="legacy-config-equivalents"] == Introduction @@ -30,7 +30,7 @@ This page introduces the <> and <> -include::partial$static_restapi/admin/index.adoc[tags=put_db-_role-name,leveloffset=+1] +include::ROOT:partial$static_restapi/admin/index.adoc[tags=put_db-_role-name,leveloffset=+1] === Example @@ -89,7 +89,7 @@ Content-Length: 67 -include::partial$static_restapi/admin/index.adoc[tags=put_db-_user-name,leveloffset=+1] +include::ROOT:partial$static_restapi/admin/index.adoc[tags=put_db-_user-name,leveloffset=+1] === Example @@ -175,9 +175,9 @@ The configuration settings described here are provisioned through the Admin REST This section shows possible error responses returned by the Admin REST API. -include::partial$static_restapi/admin/index.adoc[tags=HTTP_Error] +include::ROOT:partial$static_restapi/admin/index.adoc[tags=HTTP_Error] // BEGIN -- DO NOT EDIT -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] // END -- DO NOT EDIT diff --git a/modules/ROOT/pages/configuration/configuration-schema-import-filter.adoc b/modules/configuration/pages/configuration-schema-import-filter.adoc similarity index 83% rename from modules/ROOT/pages/configuration/configuration-schema-import-filter.adoc rename to modules/configuration/pages/configuration-schema-import-filter.adoc index 90d530f10..92ac25907 100644 --- a/modules/ROOT/pages/configuration/configuration-schema-import-filter.adoc +++ b/modules/configuration/pages/configuration-schema-import-filter.adoc @@ -1,16 +1,16 @@ = Import Filter Configuration -:page-aliases: configuration-schema-import-filter.adoc +:page-aliases: ROOT:configuration-schema-import-filter.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: Using Sync Gateway's Admin REST API and the Import Filter function to configure access :ouroffsetlevel: +1 -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] -include::partial$static_restapi/css.adoc[] +include::ROOT:partial$static_restapi/css.adoc[] -include::partial$block-caveats.adoc[tags="legacy-config-equivalents"] +include::ROOT:partial$block-caveats.adoc[tags="legacy-config-equivalents"] == Introduction @@ -27,7 +27,7 @@ See: {import-filter--xref} for more. == Function Provision -Use the {rest-api-admin--xref--database-configuration} Admin Rest API endpoint xref:rest_api_admin.adoc#tag/Database-Configuration/operation/post_db-_config[POST /{db}/_config] to provision an import filter for a database using the `application/javascript` mime type. +Use the {rest-api-admin--xref--database-configuration} Admin Rest API endpoint xref:rest-api:rest_api_admin.adoc#tag/Database-Configuration/operation/post_db-_config[POST /{db}/_config] to provision an import filter for a database using the `application/javascript` mime type. If you are using legacy configuration, you need to include it in your configuration file. See: {configuration-properties-legacy--xref--databases-import-filter}. @@ -38,7 +38,7 @@ NOTE: You need Couchbase Lite 3.1+ and Sync Gateway 3.1+ to use `custom` Scopes If you're using Capella App Services or Sync Gateway releases that are older than version 3.1, you won't be able to access `custom` Scopes and Collections. To use Couchbase Lite 3.1+ with these older versions, you can use the `default` Collection as a backup option. -The configuration settings described here are provisioned through the xref:rest-api/rest-api-admin.adoc[Database Configuration] endpoints. +The configuration settings described here are provisioned through the xref:rest-api:rest-api-admin.adoc[Database Configuration] endpoints. [source,JSON] ---- @@ -56,7 +56,7 @@ The configuration settings described here are provisioned through the xref:rest- } ---- -For more information, see xref:configuration/configuration-schema-database.adoc#DatabaseConfig[Sync Gateway Configuration Schema]. +For more information, see xref:configuration:configuration-schema-database.adoc#DatabaseConfig[Sync Gateway Configuration Schema]. [cols="2", options="header"] |=== @@ -106,7 +106,7 @@ include::{example-cfg}[tag="import-filter-config-legacy"] ===== ==== -include::partial$static_restapi/admin/index.adoc[tags=put_keyspace-_config-import_filter,leveloffset=+1] +include::ROOT:partial$static_restapi/admin/index.adoc[tags=put_keyspace-_config-import_filter,leveloffset=+1] [#_Import_filter] == Schema @@ -135,10 +135,10 @@ __Type__ : string This section shows possible error responses returned by the Admin REST API. -include::partial$static_restapi/admin/index.adoc[tags=HTTP_Error] +include::ROOT:partial$static_restapi/admin/index.adoc[tags=HTTP_Error] // BEGIN -- DO NOT EDIT -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] // END -- DO NOT EDIT diff --git a/modules/ROOT/pages/configuration/configuration-schema-isgr.adoc b/modules/configuration/pages/configuration-schema-isgr.adoc similarity index 84% rename from modules/ROOT/pages/configuration/configuration-schema-isgr.adoc rename to modules/configuration/pages/configuration-schema-isgr.adoc index 2a631fe31..86ddc6c72 100644 --- a/modules/ROOT/pages/configuration/configuration-schema-isgr.adoc +++ b/modules/configuration/pages/configuration-schema-isgr.adoc @@ -1,5 +1,5 @@ = Inter-Sync{nbsp}Gateway Replication Configuration -:page-aliases: configuration-schema-isgr.adoc +:page-aliases: ROOT:configuration-schema-isgr.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -7,18 +7,18 @@ ifdef::prerelease[:page-status: {prerelease}] :description: Using Sync Gateway's Admin REST API to configure and manage inter-Sync{nbsp}Gateway replications -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-abstract!: :param-related!: :param-topic-group: configuration -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- DO NOT EDIT -include::partial$static_restapi/css.adoc[] +include::ROOT:partial$static_restapi/css.adoc[] -include::partial$block-caveats.adoc[tags="legacy-config-equivalents"] +include::ROOT:partial$block-caveats.adoc[tags="legacy-config-equivalents"] == Introduction @@ -40,7 +40,7 @@ For Windows-based systems, add CA certificate files to the system root certifica **** -include::partial$static_restapi/admin/index.adoc[tags=put_db-_replication-replicationid,leveloffset=+1] +include::ROOT:partial$static_restapi/admin/index.adoc[tags=put_db-_replication-replicationid,leveloffset=+1] == Example @@ -123,9 +123,9 @@ The configuration settings described here are provisioned through the {rest-api- This section shows possible error responses returned by the Admin REST API. -include::partial$static_restapi/admin/index.adoc[tags=HTTP_Error] +include::ROOT:partial$static_restapi/admin/index.adoc[tags=HTTP_Error] // BEGIN -- DO NOT EDIT -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] // END -- DO NOT EDIT diff --git a/modules/ROOT/pages/configuration/scopes-and-collections-config.adoc b/modules/configuration/pages/scopes-and-collections-config.adoc similarity index 95% rename from modules/ROOT/pages/configuration/scopes-and-collections-config.adoc rename to modules/configuration/pages/scopes-and-collections-config.adoc index 636ae309a..f8da85a0b 100644 --- a/modules/ROOT/pages/configuration/scopes-and-collections-config.adoc +++ b/modules/configuration/pages/scopes-and-collections-config.adoc @@ -1,5 +1,5 @@ = Scopes and Collections Configuration for Sync Gateway -:page-aliases: learn/scopes-and-collections-config.adoc, scopes-and-collections-config.adoc +:page-aliases: ROOT:learn/scopes-and-collections-config.adoc, ROOT:scopes-and-collections-config.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -98,19 +98,19 @@ This example covers a configuration with 1 custom Scope and 2 custom Collections | | | collection1 | The name of the first collection within `scope1`. | sync | The sync function associated with `collection1`. This function is triggered when a document is created or updated in the collection. This code example illustrates a specific use case for sync functions. -For more information, see xref:access-control/sync-function/sync-function.adoc[Sync Functions]. +For more information, see xref:access-control:sync-function/sync-function.adoc[Sync Functions]. | | The sync function checks if the `type` field of the document is not `default`. If it's not, it throws a `forbidden` error, rejecting the document. | | After the rejection, it sends a message to the `legacy` channel. | import_filter | The import filter function associated with `collection1`. This function is used when importing documents into the collection. -For more information, see xref:import-filter.adoc[Import Filters]. +For more information, see xref:ROOT:import-filter.adoc[Import Filters]. | | The import filter checks if the `type` field of the document is `mobile`. If it is, the document will be imported; otherwise, it will be skipped. | | | collection2 | The name of the second collection within `scope1`. | sync | The sync function associated with `collection2`. This function is triggered when a document is created or updated in the collection. -For more information, see xref:access-control/sync-function/sync-function.adoc[Sync Functions]. +For more information, see xref:access-control:sync-function/sync-function.adoc[Sync Functions]. | | The sync function sends a message to the `collection1` channel. | import_filter | The import filter function associated with `collection2`. This function is used when importing documents into the collection. -For more information, see xref:import-filter.adoc[Import Filters]. +For more information, see xref:ROOT:import-filter.adoc[Import Filters]. | | The import filter checks if the `type` field of the document is `mobile`. If it is, the document will be imported; otherwise, it will be skipped. | | | index.num_replicas | The number of index replicas. In this case, it is set to 0, meaning no replicas of indexes will be created for this database. diff --git a/modules/ROOT/pages/deploy/changes-feed.adoc b/modules/deploy/pages/changes-feed.adoc similarity index 92% rename from modules/ROOT/pages/deploy/changes-feed.adoc rename to modules/deploy/pages/changes-feed.adoc index 78245c07f..3add01eea 100644 --- a/modules/ROOT/pages/deploy/changes-feed.adoc +++ b/modules/deploy/pages/changes-feed.adoc @@ -1,18 +1,18 @@ = Changes Feed -:page-aliases: server-integration.adoc, changes-feed.adoc +:page-aliases: ROOT:server-integration.adoc, ROOT:changes-feed.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: Integrating Sync Gateway with other servers :idprefix: :idseparator: - -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: integration :param-related: {webhooks--xref} | {xref-sgw-pg-stats-prometheus} // :param-related: {webhooks--xref} | {sgw--xref}{integrating-external-stores--page}[External Stores] | {xref-sgw-pg-stats-prometheus} :param-abstract: This content describes how to use the changes feed to integrate Sync Gateway with other servers to build services that react to document changes. -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] :url-couchdb: http://guide.couchdb.org/draft/notifications.html @@ -25,7 +25,7 @@ include::partial$_show_page_header_block.adoc[] For example, you can initiate the sending of notifications, or specialist audit processes, when certain document changes are detected. This can be done using either the changes feed or {webhooks--xref}-- see <> for a comparison of these scenarios. -include::partial$server-integration-scenario-table.adoc[] +include::ROOT:partial$server-integration-scenario-table.adoc[] == Changes Feed @@ -41,7 +41,7 @@ For instance, if you have a channel called 'needs-email', you could have a bot t == Endpoint -The changes feed API is a REST API endpoint (xref:rest_api_public.adoc#tag/Database-Management/operation/get_keyspace-_changes[`+/{keyspace}/_changes+`]) that returns a sorted list of changes made to documents in the database. +The changes feed API is a REST API endpoint (xref:rest-api:rest_api_public.adoc#tag/Database-Management/operation/get_keyspace-_changes[`+/{keyspace}/_changes+`]) that returns a sorted list of changes made to documents in the database. It permits applications to implement business logic that reacts to changes in documents. @@ -137,5 +137,5 @@ They cannot be decompressed individually! Instead, the client should open a gzip decompression session when the feed opens, and write each binary message to it as input as it arrives. The output from the decompressor consists of a sequence of JSON arrays, each of which has the same interpretation as a text message (above). -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] diff --git a/modules/ROOT/pages/deploy/command-line-options.adoc b/modules/deploy/pages/command-line-options.adoc similarity index 98% rename from modules/ROOT/pages/deploy/command-line-options.adoc rename to modules/deploy/pages/command-line-options.adoc index 7f391d7c3..829cb9889 100644 --- a/modules/ROOT/pages/deploy/command-line-options.adoc +++ b/modules/deploy/pages/command-line-options.adoc @@ -1,17 +1,17 @@ = Using the Command Line -:page-aliases: command-line-options.adoc +:page-aliases: ROOT:command-line-options.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :Description: Start a Sync Gateway instance using command line options and securely sync enterprise data from cloud to edge // BEGIN -- DO NOT EDIT -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: Deploy :param-related: {deployment--xref} | {rest-api-access--xref} | {configuration-schema-bootstrap--xref} :param-abstract: Introduces the options available when running Sync Gateway from the command line -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- DO NOT EDIT @@ -521,4 +521,4 @@ m|DefaultServer |=== -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/deploy/deployment.adoc b/modules/deploy/pages/deployment.adoc similarity index 93% rename from modules/ROOT/pages/deploy/deployment.adoc rename to modules/deploy/pages/deployment.adoc index 2c280b9a5..b1228383e 100644 --- a/modules/ROOT/pages/deploy/deployment.adoc +++ b/modules/deploy/pages/deployment.adoc @@ -1,16 +1,16 @@ = Deployment -:page-aliases: deployment.adoc +:page-aliases: ROOT:deployment.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: When deploying your application for production use you will need to use Sync Gateway and Couchbase Server. -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // :topic-group: Deploy // :param-related: {authentication-users--xref} | {xref-sgw-pg-sync-function} | {import-filter--xref} | {read-access--xref} | {xref-sgw-pg-write-access} :param-abstract: This article covers different aspects of using Sync Gateway and Couchbase Server during production. -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == Where to Host @@ -49,7 +49,7 @@ Replicator node:: If you are using inter-Sync Gateway replication then you will have a designated replicator node whose configuration is different than the rest of the nodes -- see {sync-inter-syncgateway-overview--xref}. Sync Gateway nodes are "shared-nothing," so they don’t need to coordinate any state or even know about each other. -With multiple Sync Gateways, we recommend placing this cluster behind a load balancer server to coordinate connection requests in clients (see the xref:deploy/load-balancer.adoc[Load Balancer] guide). +With multiple Sync Gateways, we recommend placing this cluster behind a load balancer server to coordinate connection requests in clients (see the xref:deploy:load-balancer.adoc[Load Balancer] guide). == Channel and Revision Caches .Enterprise Edition only @@ -81,8 +81,8 @@ Therefore, adding more CPU cores to a Sync Gateway node can speed it up. - As is typical with databases, writes are going to put a greater load on the system than reads. In particular, every write operation gets processed by the {sync-function--xref} and triggers notifications to other clients with read access, who then perform reads to get the new data. - Each client running a continuous replication has an open socket to be notified of changes. These sockets remain idle most of the time (unless documents are modified at a very high rate), so the actual data traffic is low — the issue is just managing that many sockets. -We recommend developers to optimize how many connections they need to open to the sync tier (see the xref:deploy/os-level-tuning.adoc[OS Level Tuning] guide). -- In a Sync Gateway deployment with xref:deploy/indexing.adoc[GSI/{sqlpp} indexing], the resources allocated to the Couchbase Server index node must be sufficient to support Sync Gateway operations. +We recommend developers to optimize how many connections they need to open to the sync tier (see the xref:deploy:os-level-tuning.adoc[OS Level Tuning] guide). +- In a Sync Gateway deployment with xref:deploy:indexing.adoc[GSI/{sqlpp} indexing], the resources allocated to the Couchbase Server index node must be sufficient to support Sync Gateway operations. - As Sync Gateway is optimized to use RAM, performance can be gained (or at minimum not lost) by changing the Linux swappiness value to 0 (see the xref:server:install:install-swap-space.adoc[Swap Space and Kernel Swappiness] guide). -include::partial$block-related-content-deploy.adoc[] +include::ROOT:partial$block-related-content-deploy.adoc[] diff --git a/modules/ROOT/pages/deploy/index-partitions.adoc b/modules/deploy/pages/index-partitions.adoc similarity index 70% rename from modules/ROOT/pages/deploy/index-partitions.adoc rename to modules/deploy/pages/index-partitions.adoc index d6d52af3a..420f1d79c 100644 --- a/modules/ROOT/pages/deploy/index-partitions.adoc +++ b/modules/deploy/pages/index-partitions.adoc @@ -1,16 +1,16 @@ = Partitioned Indexes -:page-aliases: index-partitions.adoc +:page-aliases: ROOT:index-partitions.adoc ifdef::show_edition[:page-edition: {release}] :page-status: Sync Gateway 3.3 :page-role: :Description: Partitioning a large index across multiple nodes -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: Deploy :param-related: {deployment--xref} | {rest-api-access--xref} | {configuration-properties-legacy--xref} :param-abstract: Explains how to use partitioned indexes in Sync Gateway -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == Overview @@ -80,18 +80,18 @@ The advantage is no downtime; the disadvantage is temporarily higher resource us .Procedure . Spin up a new Sync Gateway instance. -. Run xref:rest_api_admin_static.adoc#tag/Database-Management/operation/post_db-_index_init[`POST /{db}/_index_init`] on the new instance with `num_partitions` set to the required number of partitions. +. Run xref:ROOT:rest_api_admin_static.adoc#tag/Database-Management/operation/post_db-_index_init[`POST /{db}/_index_init`] on the new instance with `num_partitions` set to the required number of partitions. -. Wait for completion via xref:rest_api_admin_static.adoc#tag/Database-Management/operation/get_db-_index_init[`GET /{db}/_index_init`]. +. Wait for completion via xref:ROOT:rest_api_admin_static.adoc#tag/Database-Management/operation/get_db-_index_init[`GET /{db}/_index_init`]. -. Run xref:rest_api_admin_static.adoc#tag/Database-Configuration/operation/post_db-_config[`POST /{db}/_config`] with `index.num_partitions` updated in the configuration to use new indexes. +. Run xref:ROOT:rest_api_admin_static.adoc#tag/Database-Configuration/operation/post_db-_config[`POST /{db}/_config`] with `index.num_partitions` updated in the configuration to use new indexes. -. Run xref:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`] to remove old indexes. +. Run xref:ROOT:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`] to remove old indexes. . Optionally, rebalance index nodes using Couchbase Server. For details, see xref:server:learn:clusters-and-availability/rebalance.adoc#index-redistribution[Index Redistribution] in the Couchbase Server documentation. -WARNING: If you are using xref:configuration/configuration-overview.adoc#lbl-config-grp[configuration groups] running on a different index configuration, calling xref:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`] can delete indexes out from under a running database. +WARNING: If you are using xref:configuration:configuration-overview.adoc#lbl-config-grp[configuration groups] running on a different index configuration, calling xref:ROOT:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`] can delete indexes out from under a running database. Please ensure that all configuration groups have consistent index configuration. For details, see <>. @@ -102,11 +102,11 @@ This option requires no extra resources, but involves planned downtime. It involves lower intermittent hardware requirements. .Procedure -. Take the database offline via xref:rest_api_admin_static.adoc#tag/Database-Configuration/operation/post_db-_config[`POST /{db}/_config`] with `offline` set to `true`. +. Take the database offline via xref:ROOT:rest_api_admin_static.adoc#tag/Database-Configuration/operation/post_db-_config[`POST /{db}/_config`] with `offline` set to `true`. . Manually delete old Sync Gateway indexes. -. Bring the database online using xref:rest_api_admin_static.adoc#tag/Database-Configuration/operation/post_db-_config[`POST /{db}/_config`] with `index.num_partitions` set to the required number of partitions. +. Bring the database online using xref:ROOT:rest_api_admin_static.adoc#tag/Database-Configuration/operation/post_db-_config[`POST /{db}/_config`] with `index.num_partitions` set to the required number of partitions. . Run integration and performance testing. @@ -133,17 +133,17 @@ Changing the number of partitions "just to test it" may permanently increase ind [#config-groups] == Configuration Group Considerations -If your deployment uses xref:configuration/configuration-overview.adoc#lbl-config-grp[Configuration Groups], ensure that: +If your deployment uses xref:configuration:configuration-overview.adoc#lbl-config-grp[Configuration Groups], ensure that: -* All nodes are updated with the new config before running xref:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`]. +* All nodes are updated with the new config before running xref:ROOT:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`]. * Import and sync workloads are not unintentionally unbalanced across partitions. -Misalignment between config groups can lead to unexpected deletion of active indexes if xref:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`] is run. +Misalignment between config groups can lead to unexpected deletion of active indexes if xref:ROOT:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`] is run. This will result in: * Couchbase Server (version 7.6 and later) falling back on a sequential scan of the Query nodes, which will seriously degrade Query performance. -* Recreating indexes that were deleted by another config when a node is rebooted with a different `index.num_partitions`, even after xref:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`] is run. +* Recreating indexes that were deleted by another config when a node is rebooted with a different `index.num_partitions`, even after xref:ROOT:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`] is run. [#supportability] == Supportability @@ -153,19 +153,19 @@ This will result in: To identify the current index configuration, you can: -* Use xref:rest_api_admin_static.adoc#tag/Database-Configuration/operation/get_db-_config[`GET /{db}/_config`] to check the active configuration in `index.num_partitions`. +* Use xref:ROOT:rest_api_admin_static.adoc#tag/Database-Configuration/operation/get_db-_config[`GET /{db}/_config`] to check the active configuration in `index.num_partitions`. -* Use xref:rest_api_admin_static.adoc#tag/Database-Management/operation/get_db-_index_init[`GET /{db}/_index_init`] to see if there is an index creation in progress. +* Use xref:ROOT:rest_api_admin_static.adoc#tag/Database-Management/operation/get_db-_index_init[`GET /{db}/_index_init`] to see if there is an index creation in progress. [#failures] === Identify Failures To troubleshoot problems with index configurations, note the following. -* The status returned by xref:rest_api_admin_static.adoc#tag/Database-Management/operation/get_db-_index_init[`GET /{db}/_index_init`] includes `last_error`. +* The status returned by xref:ROOT:rest_api_admin_static.adoc#tag/Database-Management/operation/get_db-_index_init[`GET /{db}/_index_init`] includes `last_error`. * Partial updates across nodes using Configuration Groups may result in mixed indexing behavior. -* If indexes are not removed post-upgrade, xref:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`] may return a failure or partial success. +* If indexes are not removed post-upgrade, xref:ROOT:rest_api_admin_static.adoc#tag/Server/operation/post__post_upgrade[`POST /_post_upgrade`] may return a failure or partial success. -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/deploy/indexing.adoc b/modules/deploy/pages/indexing.adoc similarity index 88% rename from modules/ROOT/pages/deploy/indexing.adoc rename to modules/deploy/pages/indexing.adoc index dd9562dd0..3b1f9cce9 100644 --- a/modules/ROOT/pages/deploy/indexing.adoc +++ b/modules/deploy/pages/indexing.adoc @@ -1,16 +1,16 @@ = Indexing -:page-aliases: indexing.adoc +:page-aliases: ROOT:indexing.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :Description: Using Indexes to minimize system downtime in Sync Gateway -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: Deploy :param-related: {deployment--xref} | {rest-api-access--xref} | {configuration-properties-legacy--xref} :param-abstract: Explains the use of Global Secondary Indexes -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == Overview Sync Gateway uses GSI (Global Secondary Indexes) and {sqlpp} to perform a variety of internal operations, including authentication and replication. @@ -20,7 +20,7 @@ It also improves overall query performance. Sync Gateway 3.3 supports partitioned indexes. This enables you to divide and spread a large index across multiple nodes. -For details, see xref:deploy/index-partitions.adoc[]. +For details, see xref:deploy:index-partitions.adoc[]. == Configuration This capability is enabled by default and is supported by two properties in the configuration file which can be adjusted: @@ -36,4 +36,4 @@ However, users can run with a single Index Service node by setting Sync Gateway' Doing so may result in increased downtime in the event of an index node failure. -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/deploy/load-balancer.adoc b/modules/deploy/pages/load-balancer.adoc similarity index 97% rename from modules/ROOT/pages/deploy/load-balancer.adoc rename to modules/deploy/pages/load-balancer.adoc index a6f16c642..e09734829 100644 --- a/modules/ROOT/pages/deploy/load-balancer.adoc +++ b/modules/deploy/pages/load-balancer.adoc @@ -1,18 +1,18 @@ = Load Balancer -:page-aliases: load-balancer.adoc +:page-aliases: ROOT:load-balancer.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-toclevels: 1@ :description: Load balancing replications :keywords: sync, load-balance, proxy, nginx -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: deployment :param-abstract: Considerations on using proxies and load balancers with Sync Gateway replications to manage secure SSL Cloud-to-Edge synchronization :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] :fn-2-8: footnote:fn28[Commencing with release 2.8.4 of Couchbase Lite] :fnref-2-8: footnote:fn28[] @@ -52,7 +52,7 @@ Or alternatively, by configuring the replicator heartbeat interval using Couchba :param-page: replication :param-bookmark: lbl-cfg-keep-alive -include::partial$blocklinks-cbl.adoc[] +include::ROOT:partial$blocklinks-cbl.adoc[] == NGINX @@ -307,4 +307,4 @@ Since Sync Gateway and Couchbase Lite can have long running connections for chan See the https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html[ELB instructions] for more information on how to change this setting. -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/deploy/os-level-tuning.adoc b/modules/deploy/pages/os-level-tuning.adoc similarity index 96% rename from modules/ROOT/pages/deploy/os-level-tuning.adoc rename to modules/deploy/pages/os-level-tuning.adoc index e083cdd14..7ac64d515 100644 --- a/modules/ROOT/pages/deploy/os-level-tuning.adoc +++ b/modules/deploy/pages/os-level-tuning.adoc @@ -1,12 +1,12 @@ = OS Level Tuning -:page-aliases: os-level-tuning.adoc +:page-aliases: ROOT:os-level-tuning.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-toclevels: 1@ :description: pass:q[OS level parameters you can use to tune _Couchbase Sync Gateway] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -17,7 +17,7 @@ include::partial$_set_page_context.adoc[] // BEGIN -- Page Heading :param-abstract!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -201,5 +201,5 @@ See {url-keepalive}/usingkeepalive.html[Using TCP keepalive under Linux] for mor // BEGIN -- Page Footer -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/deploy/setting-up-dr-cluster.adoc b/modules/deploy/pages/setting-up-dr-cluster.adoc similarity index 91% rename from modules/ROOT/pages/deploy/setting-up-dr-cluster.adoc rename to modules/deploy/pages/setting-up-dr-cluster.adoc index d77424522..752ccef99 100644 --- a/modules/ROOT/pages/deploy/setting-up-dr-cluster.adoc +++ b/modules/deploy/pages/setting-up-dr-cluster.adoc @@ -1,6 +1,6 @@ = Setting up Disaster Recovery :page-layout: article -:page-aliases: setting-up-dr-cluster.adoc +:page-aliases: ROOT:setting-up-dr-cluster.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -9,7 +9,7 @@ ifdef::prerelease[:page-status: {prerelease}] :description: How to set up a Sync Gateway mobile cluster for Disaster Recovery (DR) using Couchbase Server's Cross Data Center Replication (XDCR) :keywords: high-availability, disaster recovery, sync, replicate, edge, cloud, dr, ha, sync gateway cluster, mobile cluster, data migration -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN Page Attributes // tag::page-attributes[] @@ -27,7 +27,7 @@ include::partial$_set_page_context.adoc[] // BEGIN Page Header :topic-group!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END Page Header @@ -57,7 +57,7 @@ If you skip this test, you will incur latency when Sync Gateway is switched to t [#fig-dr-same-regn] .DR Cluster Setup (Clusters in Same Regions) -image::{image-sgw-xdcr-dr-same-regn-setup}[,{std-image-size}] +image::ROOT:{image-sgw-xdcr-dr-same-regn-setup}[,{std-image-size}] .Activation When you are ready to switch to Disaster Recovery operations: @@ -71,7 +71,7 @@ This maintains the deployment of Sync Gateway at only one end of the XDCR replic [#fig-dr-same-regn-in-recovery] .DR Cluster In-recovery (Clusters in Same Regions) -image::{image-sgw-xdcr-dr-same-regn-in-recovery}[,{std-image-size}] +image::ROOT:{image-sgw-xdcr-dr-same-regn-in-recovery}[,{std-image-size}] // end::clusters-in-same-region[] @@ -95,7 +95,7 @@ If you skip this test, you will incur latency when Sync Gateway is switched to t [#fig-dr-diff-regn-setup] .DR Cluster Setup (Clusters in Different Regions) -image::{image-sgw-xdcr-dr-diff-regn-setup}[,{std-image-size}] +image::ROOT:{image-sgw-xdcr-dr-diff-regn-setup}[,{std-image-size}] .Activation @@ -111,9 +111,9 @@ When you are ready to switch to Disaster Recovery operations -- see: <>. @@ -226,4 +226,4 @@ You can configure the console logging of events using the configuration file and The `log_key` you need to include is `Event`; or `Events+` for more verbose output. -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/manage/database-offline.adoc b/modules/manage/pages/database-offline.adoc similarity index 84% rename from modules/ROOT/pages/manage/database-offline.adoc rename to modules/manage/pages/database-offline.adoc index e28c4ff03..f47970651 100644 --- a/modules/ROOT/pages/manage/database-offline.adoc +++ b/modules/manage/pages/database-offline.adoc @@ -1,5 +1,5 @@ = Take Database Offline/Online -:page-aliases: database-offline.adoc +:page-aliases: ROOT:database-offline.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -7,12 +7,12 @@ ifdef::prerelease[:page-status: {prerelease}] :description: pass:q[How to take a _Sync Gateway_ database offline and bring back online.] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Heading :param-abstract!: :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -41,8 +41,8 @@ Specific uses for the database offline/online functionality include: == Actions -* Taking a database offline: xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_offline[POST /+{db}+/_offline] -* Taking a database online: xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_online[POST /+{db}+/_online] +* Taking a database offline: xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_offline[POST /+{db}+/_offline] +* Taking a database online: xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_online[POST /+{db}+/_online] By default, when Sync Gateway starts, it brings all databases that are defined in the configuration file online. To keep a database offline when Sync Gateway starts, you can add the `offline` configuration property to the database configuration properties -- see {rest-api-admin--xref--database-configuration}. @@ -64,7 +64,7 @@ The state diagram represents the states for Sync Gateway and the connection betw [#fig-state-diag] .State Change Diagram -image::state-diagram-offline-12.png[] +image::ROOT:state-diagram-offline-12.png[] In the state diagram (fig-state-diag): @@ -74,5 +74,5 @@ For example, two databases could be online, while a third database could be take // BEGIN -- Page Footer -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/manage/logging.adoc b/modules/manage/pages/logging.adoc similarity index 97% rename from modules/ROOT/pages/manage/logging.adoc rename to modules/manage/pages/logging.adoc index 9f3fce00b..5a4e505a4 100644 --- a/modules/ROOT/pages/manage/logging.adoc +++ b/modules/manage/pages/logging.adoc @@ -18,31 +18,31 @@ // INCLUSION USAGE // END PAGE DEFINITION = Logging -:page-aliases: advance/logging.adoc, logging.adoc +:page-aliases: ROOT:advance/logging.adoc, ROOT:logging.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: Introducing Couchbase Sync Gateway's logging functionality -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-related: {configuration-schema-bootstrap--xref} | {rest-api-admin--xref} | {sgcollect-info--xref} :param-abstract: Sync Gateway's _Continuous Logging_ feature delivers flexible log generation and retention, without compromising the availability of diagnostic information necessary to provide effective support and maintenance. -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // BEGIN Local attributes // :fn-clog: footnote:fn-clog[Introduced in Sync Gateway version 2.1] // :fn-dep-cfg: footnote:fn-dep-cfg[The pre-2.1 logging configuration method, using 'logging.default` is deprecated. If upgrading from a pre2.1 Sync Gateway version, then you will observe warnings on startup stating what is required to update your configuration -- see also: {legacy-logging-pre2-1--xref} ] -:fn-legacy-text: pass:q,a[For legacy Pre-3.0 see xref:configuration/configuration-properties-legacy.adoc[legacy Pre-3.0 configuration]] +:fn-legacy-text: pass:q,a[For legacy Pre-3.0 see xref:configuration:configuration-properties-legacy.adoc[legacy Pre-3.0 configuration]] :fn-legacy-pre-3-0: footnote:fnleg3-0[{fn-legacy-text}] :fnref-legacy-pre-3-0: footnote:fnleg3-0[] // END Local attributes -include::partial$block-caveats.adoc[tags=logfilefolderuse] +include::ROOT:partial$block-caveats.adoc[tags=logfilefolderuse] // BEGIN Content @@ -443,6 +443,6 @@ Configure log rotation using the {bootstrap-schema--xref--logging-console-rotati For pre-2.1 log rotation -- see: xref:2.0@sync-gateway::logging.adoc[Pre 2.1 Log Rotation] -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] // END -- PAGE -- logging.adoc diff --git a/modules/ROOT/pages/manage/managing-tombstones.adoc b/modules/manage/pages/managing-tombstones.adoc similarity index 88% rename from modules/ROOT/pages/manage/managing-tombstones.adoc rename to modules/manage/pages/managing-tombstones.adoc index a92ad30c7..f9b1aa01a 100644 --- a/modules/ROOT/pages/manage/managing-tombstones.adoc +++ b/modules/manage/pages/managing-tombstones.adoc @@ -1,5 +1,5 @@ = Tombstones -:page-aliases: learn/concept-tombstones.adoc, learn/concept-fundamentals-data-tombstones.adoc, learn/what-are-tombstones.adoc, what-are-tombstones.adoc, managing-tombstones.adoc +:page-aliases: ROOT:learn/concept-tombstones.adoc, ROOT:learn/concept-fundamentals-data-tombstones.adoc, ROOT:learn/what-are-tombstones.adoc, ROOT:what-are-tombstones.adoc, ROOT:managing-tombstones.adoc :description: pass:q[Sync Gateway's _Tombstones_ are the means by which mobile clients are notified that a document has been deleted.] ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] @@ -8,7 +8,7 @@ ifdef::prerelease[:page-status: {prerelease}] :page-content: conceptual -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :fn-211: footnote:fn-211[Commencing with release 2.1.1] @@ -17,7 +17,7 @@ include::partial$_set_page_context.adoc[] // BEGIN -- Page Heading :param-abstract: pass:q[Here we introduce the concept of _Tombstones_ and their role in the _Sync Gateway_ revision process.] :param-related!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -163,8 +163,8 @@ Set the expiry time to be sufficient to allow for all other devices to sync and |Tombstones are automatically purged from the bucket based on the server's metadata purge interval. |Manual -|Tombstones can be manually removed via Sync Gateway's xref:rest_api_admin.adoc#tag/Document/operation/post_keyspace-_purge[+/{keyspace}/_purge+] endpoint, or deleting documents directly in the bucket. -|Tombstones can be manually removed via Sync Gateway's xref:rest_api_admin.adoc#tag/Document/operation/post_keyspace-_purge[+/{keyspace}/_purge+] endpoint. +|Tombstones can be manually removed via Sync Gateway's xref:rest-api:rest_api_admin.adoc#tag/Document/operation/post_keyspace-_purge[+/{keyspace}/_purge+] endpoint, or deleting documents directly in the bucket. +|Tombstones can be manually removed via Sync Gateway's xref:rest-api:rest_api_admin.adoc#tag/Document/operation/post_keyspace-_purge[+/{keyspace}/_purge+] endpoint. |=== Purging of tombstones is also required on Couchbase Lite. @@ -193,7 +193,7 @@ Purged On | Couchbase Server | Restarting Sync Gateway will flush the cache | * Restarting Sync Gateway will flush the cache -* Running the xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_compact[+/{db}/_compact+] endpoint will remove purged tombstones from the channel cache {fn-211} +* Running the xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_compact[+/{db}/_compact+] endpoint will remove purged tombstones from the channel cache {fn-211} | Sync Gateway a| * Restarting Sync Gateway will flush the cache. @@ -203,5 +203,5 @@ a| * Restarting Sync Gateway will flush the cache. |=== -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/manage/resync.adoc b/modules/manage/pages/resync.adoc similarity index 83% rename from modules/ROOT/pages/manage/resync.adoc rename to modules/manage/pages/resync.adoc index bfe3780a2..eb0ab5f94 100644 --- a/modules/ROOT/pages/manage/resync.adoc +++ b/modules/manage/pages/resync.adoc @@ -1,5 +1,5 @@ = Resync -:page-aliases: resync.adoc +:page-aliases: ROOT:resync.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -7,15 +7,15 @@ ifdef::prerelease[:page-status: {prerelease}] :idprefix: :idseparator: - -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: sync :param-related: {rest-api-admin--xref} | {configuration-schema-database--xref} | {configuration-schema-database--xref--sync} | {configuration-properties-legacy--xref} :param-abstract: This content explains the resync feature -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] -:resync_api_post: xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_resync[POST /{db}/_resync] -:resync_api_get: xref:rest_api_admin.adoc#tag/Database-Management/operation/get_db-_resync[GET /{db}/_resync] +:resync_api_post: xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_resync[POST /{db}/_resync] +:resync_api_get: xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/get_db-_resync[GET /{db}/_resync] == Introduction @@ -65,7 +65,7 @@ You won't need to run the resync operation, if either: . Restart Sync Gateway. . Take the database offline. Use this Admin REST API endpoint: -xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_offline[+/{db}/_offline+] +xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_offline[+/{db}/_offline+] . Resync the database. Use this Admin REST API endpoint: {resync_api_post} . Monitor the resync status using {resync_api_get} to see when it completes. @@ -73,7 +73,7 @@ Use this Admin REST API endpoint: {resync_api_post} The message body of the response contains the number of changes that were made as a result of calling resync. . Bring the database back online. Use this Admin REST API endpoint: -xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_online[+/{db}/_online+] +xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_online[+/{db}/_online+] == Running Resync @@ -82,7 +82,7 @@ xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_online[+/{db Resync is run asynchronously. Its status can be monitored using {resync_api_get}. -Be sure to take the database offline using xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_offline[+/{db}/_offline+]. +Be sure to take the database offline using xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_offline[+/{db}/_offline+]. === Resync Context @@ -105,12 +105,12 @@ Once you detect the resync is complete, switch back to the main Sync Gateway and === Updating Clusters In a clustered environment with multiple Sync Gateway instances sharing the load, all the instances need to share the same configuration. -To ensure this happens, you must taken all instances offline using the xref:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_offline[+/{db}/_offline+] endpoint. +To ensure this happens, you must taken all instances offline using the xref:rest-api:rest_api_admin.adoc#tag/Database-Management/operation/post_db-_offline[+/{db}/_offline+] endpoint. After the configuration is updated, *one* instance should be brought up so it can update the database--if more than one is running at this time, they'll conflict with each other. After the first instance finishes opening the database, the others can be started. -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] diff --git a/modules/ROOT/pages/manage/revisions.adoc b/modules/manage/pages/revisions.adoc similarity index 94% rename from modules/ROOT/pages/manage/revisions.adoc rename to modules/manage/pages/revisions.adoc index 42478696f..9be09edd4 100644 --- a/modules/ROOT/pages/manage/revisions.adoc +++ b/modules/manage/pages/revisions.adoc @@ -1,5 +1,5 @@ = Revisions -:page-aliases: revisions.adoc +:page-aliases: ROOT:revisions.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-toclevels: 2@ @@ -8,13 +8,13 @@ ifdef::prerelease[:page-status: {prerelease}] :description: About Sync Gateway's use of Revisions, Revision Trees and Revision Caches. -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Heading :param-abstract: pass:q[Revisions are at the heart of Couchbase Mobile's ability to respond flexibly and securely to changing data from server to edge.] :param-related: {url-blog-dbsizemng-pruning} | {url-blog-doc-conflicts-repl-protocol-revisions} | {url-blog-doc-conflicts-demystifying-mvcc}] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -106,7 +106,7 @@ This setting may affect the conflict resolution process, as insufficient revisio -- The default and minimum values of `revs_limit` are dependent on whether -xref:configuration/configuration-schema-database.html#database-allow_conflicts[allow conflicts] +xref:configuration:configuration-schema-database.html#database-allow_conflicts[allow conflicts] is set True or False -- see <>. The process to remove obsolete revisions is called pruning and runs automatically every time a revision is added. @@ -197,7 +197,7 @@ Whenever a document is accessed its revision tree (or at least some portion of i === Control You can control the size of the revision cache using the {configuration-schema-database--xref--cache--rev-cache} settings within the configuration file, specifically: -* xref:configuration/configuration-schema-database.adoc#cache-rev_cache-max_memory_count_mb[rev_cache.max_memory_count_mb] +* xref:configuration:configuration-schema-database.adoc#cache-rev_cache-max_memory_count_mb[rev_cache.max_memory_count_mb] * {configuration-schema-database--xref--cache--rev-cache--shard-count} @@ -206,7 +206,7 @@ You can control the size of the revision cache using the {configuration-schema-d [#lbl-cache-limit-config] === Cache Limit Configuration -There are two ways to configure the size of the revision cache: set a memory limit in MB using xref:configuration/configuration-schema-database.adoc#cache-rev_cache-max_memory_count_mb[`rev_cache.max_memory_count_mb`], or set the maximum number of document revisions in cache xref:configuration/configuration-schema-database.adoc#cache-rev_cache_size[`rev_cache.size`]. +There are two ways to configure the size of the revision cache: set a memory limit in MB using xref:configuration:configuration-schema-database.adoc#cache-rev_cache-max_memory_count_mb[`rev_cache.max_memory_count_mb`], or set the maximum number of document revisions in cache xref:configuration:configuration-schema-database.adoc#cache-rev_cache_size[`rev_cache.size`]. These configurations allow you to configure both limits to the number of documents and the maximum memory usage within the rev cache to reduce the risk of Out of Memory (OOM) issues. If both configs are set, this results in eviction behavior of the rev cache based on both the memory footprint and number of items in the cache. If any of these limits are reached, cache eviction will be performed. @@ -221,14 +221,14 @@ This can be useful when working on servers with limited memory and in cases when ==== Cache Maximum Memory -You can use the xref:configuration/configuration-schema-database.adoc#cache-rev_cache-max_memory_count_mb[`rev_cache.max_memory_count_mb`] setting to specify the maximum amount of memory the revision cache should take up in MB. +You can use the xref:configuration:configuration-schema-database.adoc#cache-rev_cache-max_memory_count_mb[`rev_cache.max_memory_count_mb`] setting to specify the maximum amount of memory the revision cache should take up in MB. Setting the value to `0` will disable any eviction based on memory at rev cache. IMPORTANT: `rev_cache.max_memory_count_mb` is an Enterprise only setting. [#lbl-sharding] === Sharding -include::partial$block-caveats.adoc[tags=ee-only-feature] +include::ROOT:partial$block-caveats.adoc[tags=ee-only-feature] The *Community Edition* is configured with the default value and ignores any {configuration-schema-database--xref--cache--rev-cache--shard-count} value in the configuration file. @@ -237,11 +237,11 @@ You can control the number of shards into which Sync Gateway will split its revi More shards means lower cache contention when accessing distinct revisions, at the cost of some memory overhead per-shard. -IMPORTANT: Do not change the default xref:configuration/configuration-schema-database.adoc#database-cache-rev_cache-shard_count[database.cache.rev_cache.shard_count] unless advised to do so by Couchbase Support -- see: {url-cb-support-policy}. +IMPORTANT: Do not change the default xref:configuration:configuration-schema-database.adoc#database-cache-rev_cache-shard_count[database.cache.rev_cache.shard_count] unless advised to do so by Couchbase Support -- see: {url-cb-support-policy}. [#lbl-deltasync] === Delta Sync -include::partial$block-caveats.adoc[tags=ee-only-feature] +include::ROOT:partial$block-caveats.adoc[tags=ee-only-feature] When executing a write operation with delta_sync enabled the revision body is backed up in the bucket and retained for {configuration-schema-database--xref--delta-sync-max-age}, during which time it is available for the calculation of future revision deltas. @@ -268,7 +268,7 @@ Setting {configuration-schema-database--xref--delta-sync-max-age} to zero will g [#lbl-disable] === Disabling the Cache -include::partial$block-caveats.adoc[tags=ee-only-feature] +include::ROOT:partial$block-caveats.adoc[tags=ee-only-feature] Disabling the revision cache can be useful when there are very large documents or if you expect a very low cache hit rate. Otherwise it can negatively impact the latency of replications. @@ -298,4 +298,4 @@ See the REST API call endpoint {rest-api-admin--xref--database-management--compa -include::partial$block-related-content-data.adoc[] \ No newline at end of file +include::ROOT:partial$block-related-content-data.adoc[] \ No newline at end of file diff --git a/modules/ROOT/pages/manage/sgcollect-info.adoc b/modules/manage/pages/sgcollect-info.adoc similarity index 94% rename from modules/ROOT/pages/manage/sgcollect-info.adoc rename to modules/manage/pages/sgcollect-info.adoc index 7a047ecf6..ff5c73520 100644 --- a/modules/ROOT/pages/manage/sgcollect-info.adoc +++ b/modules/manage/pages/sgcollect-info.adoc @@ -1,22 +1,22 @@ = SG Collect Info -:page-aliases: sgcollect-info.adoc +:page-aliases: ROOT:sgcollect-info.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: pass:q[Using _sgcollect_info_ to gather system information, diagnostics and metrics] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Header :topic-group: monitor :param-abstract: pass:q[This topic describes the command line utility, _sgcollect_info_, its use and the output it collates.] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Header -include::partial$block-caveats.adoc[tags=logfilefolderuse] +include::ROOT:partial$block-caveats.adoc[tags=logfilefolderuse] == Introduction @@ -97,7 +97,7 @@ When prompted, enter the password. == REST Endpoint -You can also run `sgcollect_info` from the Admin REST API using the xref:rest_api_admin.adoc#tag/Server/operation/post__sgcollect_info[_sgcollect_info] endpoint. +You can also run `sgcollect_info` from the Admin REST API using the xref:rest-api:rest_api_admin.adoc#tag/Server/operation/post__sgcollect_info[_sgcollect_info] endpoint. == Zipfile Contents @@ -202,5 +202,5 @@ Zipfile built: sgout.zip // BEGIN -- Page Footer -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/manage/stats-monitoring-json.adoc b/modules/manage/pages/stats-monitoring-json.adoc similarity index 94% rename from modules/ROOT/pages/manage/stats-monitoring-json.adoc rename to modules/manage/pages/stats-monitoring-json.adoc index b8efd8ae4..1d49c465d 100644 --- a/modules/ROOT/pages/manage/stats-monitoring-json.adoc +++ b/modules/manage/pages/stats-monitoring-json.adoc @@ -1,5 +1,5 @@ = JSON Metrics -:page-aliases: stats-monitoring-json.adoc +:page-aliases: ROOT:stats-monitoring-json.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -9,15 +9,15 @@ ifdef::prerelease[:page-status: {prerelease}] :gotoIndex: <> -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: inter-syncgateway :param-related: {configuration-properties-legacy--xref} | {rest-api-metrics--xref} | {xref-sgw-pg-stats-prometheus} :param-abstract: Sync Gateway's statistics and metrics provide under-the-hood data on the performance, resource utilization and health of it nodes. This is increasingly important as deployments scale to support a large numbers of connected mobile and edge components. -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // include name attributes for stats -include::partial$_define_stats_item_names.adoc[] +include::ROOT:partial$_define_stats_item_names.adoc[] == JSON format Use the `_expvar` endpoint to request these metrics: @@ -40,12 +40,12 @@ TIP: Use the click-through links to find out more about each item. [source,json,subs="normal, attributes"] ---- -include::partial$stats-schema.adoc[] +include::ROOT:partial$stats-schema.adoc[] ---- == Global stats -include::partial$stats-schema-descriptions.adoc[] +include::ROOT:partial$stats-schema-descriptions.adoc[] == Alphabetic Index @@ -247,4 +247,4 @@ include::partial$stats-schema-descriptions.adoc[] {gotoIndex} -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/manage/stats-monitoring-prometheus.adoc b/modules/manage/pages/stats-monitoring-prometheus.adoc similarity index 78% rename from modules/ROOT/pages/manage/stats-monitoring-prometheus.adoc rename to modules/manage/pages/stats-monitoring-prometheus.adoc index fc67316bc..237dd7b10 100644 --- a/modules/ROOT/pages/manage/stats-monitoring-prometheus.adoc +++ b/modules/manage/pages/stats-monitoring-prometheus.adoc @@ -1,5 +1,5 @@ = Prometheus Metrics -:page-aliases: stats-monitoring-prometheus.adoc +:page-aliases: ROOT:stats-monitoring-prometheus.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -9,19 +9,19 @@ ifdef::prerelease[:page-status: {prerelease}] :gotoIndex: <> -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: inter-syncgateway :param-related: {configuration-properties-legacy--xref} | {rest-api-metrics--xref} | {xref-sgw-pg-stats-prometheus} :param-abstract: Sync Gateway's statistics and metrics provide under-the-hood data on the performance, resource utilization and health of it nodes. This is increasingly important as deployments scale to support a large numbers of connected mobile and edge components. -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // include name attributes for stats -include::partial$_define_stats_item_names.adoc[] +include::ROOT:partial$_define_stats_item_names.adoc[] == Prometheus format -Like other Couchbase services, Sync Gateway offers xref:deploy/stats-prometheus.adoc[Prometheus-compatible metrics] in a flat JSON format. +Like other Couchbase services, Sync Gateway offers xref:deploy:stats-prometheus.adoc[Prometheus-compatible metrics] in a flat JSON format. Use the `metrics` endpoint to request these metrics: @@ -34,13 +34,13 @@ curl -X GET "http://localhost:4986/metrics" -H "accept: application/json" ---- ==== -This endpoint's data will be scraped at configurable interval, when the `metricsInterface` is activated and Sync Gateway integrated with Prometheus -- see: xref:deploy/stats-prometheus.adoc[] and our blog entry {url-blog-prometheus}. +This endpoint's data will be scraped at configurable interval, when the `metricsInterface` is activated and Sync Gateway integrated with Prometheus -- see: xref:deploy:stats-prometheus.adoc[] and our blog entry {url-blog-prometheus}. The response in Prometheus format is defined as follows: [template,attachment$metrics_metadata.json] -- -include::partial$metrics.hbs[] +include::ROOT:partial$metrics.hbs[] -- diff --git a/modules/ROOT/pages/manage/stats-monitoring.adoc b/modules/manage/pages/stats-monitoring.adoc similarity index 81% rename from modules/ROOT/pages/manage/stats-monitoring.adoc rename to modules/manage/pages/stats-monitoring.adoc index 71de9a78d..89030253d 100644 --- a/modules/ROOT/pages/manage/stats-monitoring.adoc +++ b/modules/manage/pages/stats-monitoring.adoc @@ -1,5 +1,5 @@ = View Statistics and Metrics -:page-aliases: stats-monitoring.adoc +:page-aliases: ROOT:stats-monitoring.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -9,15 +9,15 @@ ifdef::prerelease[:page-status: {prerelease}] :gotoIndex: <> -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: inter-syncgateway :param-related: {configuration-properties-legacy--xref} | {rest-api-metrics--xref} | {xref-sgw-pg-stats-prometheus} :param-abstract: Sync Gateway's statistics and metrics provide under-the-hood data on the performance, resource utilization and health of it nodes. This is increasingly important as deployments scale to support a large numbers of connected mobile and edge components. -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // include name attributes for stats -include::partial$_define_stats_item_names.adoc[] +include::ROOT:partial$_define_stats_item_names.adoc[] == Introduction @@ -32,14 +32,14 @@ Sync Gateway's Metrics REST API_ facilitates the process of gathering this essen It also provides for integration with Prometheus. -Use the Metrics REST API to request the statistics in either xref:manage/stats-monitoring-json.adoc[JSON] or xref:manage/stats-monitoring-prometheus.adoc[Prometheus] format. +Use the Metrics REST API to request the statistics in either xref:manage:stats-monitoring-json.adoc[JSON] or xref:manage:stats-monitoring-prometheus.adoc[Prometheus] format. == Advantages of JSON format -The custom xref:manage/stats-monitoring-json.adoc[JSON] format was created specifically to describe Sync Gateway metrics, and provides rich, nested data. +The custom xref:manage:stats-monitoring-json.adoc[JSON] format was created specifically to describe Sync Gateway metrics, and provides rich, nested data. == Advantages of Prometheus format -As with all Couchbase services, Sync Gateway exposes a xref:manage/stats-monitoring-prometheus.adoc[Prometheus]-compatible format in flat JSON. +As with all Couchbase services, Sync Gateway exposes a xref:manage:stats-monitoring-prometheus.adoc[Prometheus]-compatible format in flat JSON. This familiar and consistent format is simple yet attractive for powerful comparisons using Prometheus, potentially across multiple services. diff --git a/modules/ROOT/pages/product-notes/compatibility.adoc b/modules/product-notes/pages/compatibility.adoc similarity index 72% rename from modules/ROOT/pages/product-notes/compatibility.adoc rename to modules/product-notes/pages/compatibility.adoc index 591093a4e..bea7ac0fb 100644 --- a/modules/ROOT/pages/product-notes/compatibility.adoc +++ b/modules/product-notes/pages/compatibility.adoc @@ -1,5 +1,5 @@ = Compatibility -:page-aliases: prodnotes/pn-compatibility.adoc +:page-aliases: ROOT:prodnotes/pn-compatibility.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -13,18 +13,18 @@ include::ROOT:partial$_set_page_context.adoc[] :param-abstract: Covers Couchbase Sync Gateway's compatibility with Couchbase Server and Couchbase Lite :param-related: {xref-sgw-pg-whatsnew} | {supported-environments--xref} | {xref-sgw-pg-release-notes} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] -// include::partial$compatibility-matrix.adoc[] +// include::ROOT:partial$compatibility-matrix.adoc[] == Sync Gateway and Couchbase Server -include::partial$sgw-svr-compatibility.adoc[] +include::ROOT:partial$sgw-svr-compatibility.adoc[] == Sync Gateway and Couchbase Lite // include::couchbase-lite:ROOT:partial$compatibility-cbl-sgw.adoc[] -include::partial$compatibility-cbl-sgw.adoc[] +include::ROOT:partial$compatibility-cbl-sgw.adoc[] -include::partial$block-related-content-product.adoc[] +include::ROOT:partial$block-related-content-product.adoc[] diff --git a/modules/ROOT/pages/product-notes/release-notes.adoc b/modules/product-notes/pages/release-notes.adoc similarity index 81% rename from modules/ROOT/pages/product-notes/release-notes.adoc rename to modules/product-notes/pages/release-notes.adoc index f7506dabf..3739b61fc 100644 --- a/modules/ROOT/pages/product-notes/release-notes.adoc +++ b/modules/product-notes/pages/release-notes.adoc @@ -1,12 +1,12 @@ = Release Notes -:page-aliases: prodnotes/pn-releasenotes.adoc, prodnotes/pn-release-notes.adoc, releasenotes.adoc, pn-release-notes.adoc +:page-aliases: ROOT:prodnotes/pn-releasenotes.adoc, ROOT:prodnotes/pn-release-notes.adoc, ROOT:releasenotes.adoc, ROOT:pn-release-notes.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: Couchbase Sync Gateway :keywords: edge nosql api synchronization replication // End of Page Attribute Statements -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :ns-this: {ns} for this release :fn-icr: footnote:icr[As of Sync Gateway version 2.8] @@ -25,7 +25,7 @@ https://docs-archive.couchbase.com/home/index.html[Archived documentation] // DO NOT EDIT -- Header Content Block :param-abstract: This content describes the key features and changes implemented by release {version-full} of Couchbase Sync{nbsp}Gateway :param-related: {whatsnew--xref} | {compatibility--xref} | {supported-environments--xref} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // DO NOT EDIT -- Header Content Block @@ -44,14 +44,14 @@ The migration to 3.x configuration is a ONE WAY process -- see: {upgrading--xref :param-release-tag: -1 [#maint-latest] -include::partial$release_notes/sync-gateway-3-3-0-release-note.adoc[] +include::ROOT:partial$release_notes/sync-gateway-3-3-0-release-note.adoc[] == Upgrading For more on upgrading -- see: {upgrading--xref} // DO NOT EDIT -- Footer Related Content Block -include::partial$block-related-content-product.adoc[] +include::ROOT:partial$block-related-content-product.adoc[] // DO NOT EDIT -- Footer Related Content Block // END -- PAGE -- modules/ROOT/pages/release-notes.adoc diff --git a/modules/ROOT/pages/product-notes/supported-environments.adoc b/modules/product-notes/pages/supported-environments.adoc similarity index 87% rename from modules/ROOT/pages/product-notes/supported-environments.adoc rename to modules/product-notes/pages/supported-environments.adoc index ce946bc55..8e67dfefe 100644 --- a/modules/ROOT/pages/product-notes/supported-environments.adoc +++ b/modules/product-notes/pages/supported-environments.adoc @@ -17,7 +17,7 @@ // INCLUSION USAGE // END PAGE DEFINITION = Supported Environments -:page-aliases: official-support, supported-os, prodnotes/pn-supported-os.adoc +:page-aliases: official-support, supported-os, ROOT:prodnotes/pn-supported-os.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -28,7 +28,7 @@ include::ROOT:partial$_set_page_context.adoc[] :param-abstract: Sync Gateway is supported on several popular operating systems and virtual environments. :param-related: {xref-sgw-pg-whatsnew} | {compatibility--xref} | {xref-sgw-pg-release-notes} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == Supported Versions @@ -40,7 +40,7 @@ See the <> section for information about platform support c IMPORTANT: {sgw} clusters on mixed platforms are not supported. Nodes in a {sgw} cluster should all be running on the same OS, and every effort should be made to apply the same OS patches across the entire cluster. -include::partial$sgw-supported-os.adoc[tag=supported] +include::ROOT:partial$sgw-supported-os.adoc[tag=supported] == Deprecated Versions @@ -48,11 +48,11 @@ include::partial$sgw-supported-os.adoc[tag=supported] Deprecated versions will be removed in a future release and we recommend that you plan to migrate away from the deprecated OS versions. -include::partial$sgw-supported-os.adoc[tags=deprecated] +include::ROOT:partial$sgw-supported-os.adoc[tags=deprecated] -include::partial$block-related-content-product.adoc[] +include::ROOT:partial$block-related-content-product.adoc[] // END -- PAGE -- supported-environments.adoc diff --git a/modules/ROOT/pages/rest-api/rest-api-access-rbac-roles.adoc b/modules/rest-api/pages/rest-api-access-rbac-roles.adoc similarity index 98% rename from modules/ROOT/pages/rest-api/rest-api-access-rbac-roles.adoc rename to modules/rest-api/pages/rest-api-access-rbac-roles.adoc index cf0b64835..01e5e32ba 100644 --- a/modules/ROOT/pages/rest-api/rest-api-access-rbac-roles.adoc +++ b/modules/rest-api/pages/rest-api-access-rbac-roles.adoc @@ -1,17 +1,17 @@ = RBAC Role -- Endpoint Cross-reference :page-partials: -:page-aliases: rest-api-access-rbac-roles.adoc +:page-aliases: ROOT:rest-api-access-rbac-roles.adoc :page-edition: {release} :page-role: :page-content: Reference :description: Server RBAC Role -- Rest API endpoint cross reference tabley -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-abstract!: Shows how to access Sync Gateway APIs :param-related: {rest-api--xref} | {rest-api-admin--xref} | {rest-api-metrics--xref} :topic-group: REST API -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] :xref--pfx: {sgw--xref}: :tls-encryption--xref: {sgw--xref}{secure-sgw-access--page}[enforcing TLS encryption] @@ -950,4 +950,4 @@ External Stats Reader |=== -include::partial$block-related-content-api.adoc[] \ No newline at end of file +include::ROOT:partial$block-related-content-api.adoc[] \ No newline at end of file diff --git a/modules/ROOT/pages/rest-api/rest-api-access.adoc b/modules/rest-api/pages/rest-api-access.adoc similarity index 88% rename from modules/ROOT/pages/rest-api/rest-api-access.adoc rename to modules/rest-api/pages/rest-api-access.adoc index c2bc79e07..c8ad7d599 100644 --- a/modules/ROOT/pages/rest-api/rest-api-access.adoc +++ b/modules/rest-api/pages/rest-api-access.adoc @@ -1,5 +1,5 @@ = Secure API Access -:page-aliases: start/rest-api-access.adoc, start/get-started-access-rest-api.adoc, get-started-access-rest-api.adoc, rest-api-access.adoc +:page-aliases: ROOT:start/rest-api-access.adoc, ROOT:start/get-started-access-rest-api.adoc, ROOT:get-started-access-rest-api.adoc, ROOT:rest-api-access.adoc :page-partials: ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] @@ -7,12 +7,12 @@ ifdef::prerelease[:page-status: {prerelease}] :page-content: Reference :description: Sync Gateway REST API Access -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-abstract: Shows how to access Sync Gateway APIs :param-related: {rest-api--xref} | {rest-api-admin--xref} | {rest-api-metrics--xref} :topic-group: REST API -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] :xref--pfx: {sgw--xref}: :tls-encryption--xref: {sgw--xref}{secure-sgw-access--page}[enforcing TLS encryption] @@ -92,58 +92,58 @@ h| 6.1 - 7.0 h| Sync Gateway Architect | Can manage Sync Gateway databases and users, and access Sync Gateway's metrics endpoint. This user cannot read application data. -| image:yes.png[] -| image:yes.png[] -| image:no.png[] +| image:ROOT:yes.png[] +| image:ROOT:yes.png[] +| image:ROOT:no.png[] h| Sync Gateway Application | Can manage Sync Gateway users and roles, and read and write application data through Sync Gateway. -| image:yes.png[] -| image:yes.png[] -| image:no.png[] +| image:ROOT:yes.png[] +| image:ROOT:yes.png[] +| image:ROOT:no.png[] h| Sync Gateway Application Read Only | Can read Sync Gateway users and roles, and read application data through Sync Gateway. -| image:yes.png[] -| image:yes.png[] -| image:no.png[] +| image:ROOT:yes.png[] +| image:ROOT:yes.png[] +| image:ROOT:no.png[] h| Sync Gateway Replicator | Can manage Inter-Sync Gateway Replications. + This user cannot read application data. -| image:yes.png[] -| image:yes.png[] -| image:no.png[] +| image:ROOT:yes.png[] +| image:ROOT:yes.png[] +| image:ROOT:no.png[] h| Sync Gateway Dev Ops | Can manage Sync Gateway node-level configuration, and access Sync Gateway's /metrics endpoint for Prometheus integration. -| image:yes.png[] -| image:yes.png[] -| image:no.png[] +| image:ROOT:yes.png[] +| image:ROOT:yes.png[] +| image:ROOT:no.png[] h| Sync-Gateway Role | Can access DB / bucket scoped operations -| image:no.png[] -| image:no.png[] -| image:yes.png[] +| image:ROOT:no.png[] +| image:ROOT:no.png[] +| image:ROOT:yes.png[] h| Application Access | Can access DB / bucket scoped operations -| image:no.png[] -| image:no.png[] -| image:yes.png[] +| image:ROOT:no.png[] +| image:ROOT:no.png[] +| image:ROOT:yes.png[] h| Bucket Full Access | Can access DB / bucket scoped operations -| image:no.png[] -| image:no.png[] -| image:yes.png[] +| image:ROOT:no.png[] +| image:ROOT:no.png[] +| image:ROOT:yes.png[] h| Full Admin | Can access all operations -| image:no.png[] -| image:no.png[] -| image:yes.png[] +| image:ROOT:no.png[] +| image:ROOT:no.png[] +| image:ROOT:yes.png[] |=== @@ -276,9 +276,9 @@ This is the default setting for the admin interface. [#lbl-port-req] .Network Port Requirements -include::partial$sgw-network-port-reqs.adoc[] +include::ROOT:partial$sgw-network-port-reqs.adoc[] For more on configuration see {bootstrap-schema--xref--api-admin-interface} -include::partial$block-related-content-api.adoc[] \ No newline at end of file +include::ROOT:partial$block-related-content-api.adoc[] \ No newline at end of file diff --git a/modules/ROOT/pages/rest-api/rest-api-admin.adoc b/modules/rest-api/pages/rest-api-admin.adoc similarity index 75% rename from modules/ROOT/pages/rest-api/rest-api-admin.adoc rename to modules/rest-api/pages/rest-api-admin.adoc index f9dae8597..62cf3e55e 100644 --- a/modules/ROOT/pages/rest-api/rest-api-admin.adoc +++ b/modules/rest-api/pages/rest-api-admin.adoc @@ -1,16 +1,16 @@ = Admin REST API -:page-aliases: refer/rest-api-admin.adoc, rest-api-admin.adoc +:page-aliases: ROOT:refer/rest-api-admin.adoc, ROOT:rest-api-admin.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: -toc :page-content: Reference :description: Description of the Sync Gateway Admin REST API -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-related: {rest-api--xref} | {rest-api-metrics--xref} :topic-group: REST API -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == Introduction @@ -28,13 +28,13 @@ Calls to `requireUser`, `requireAccess` and `requireRole` will be no-ops, and wi == API Reference -The xref:rest_api_admin.adoc[API reference] groups all the endpoints by functionality. +The xref:rest-api:rest_api_admin.adoc[API reference] groups all the endpoints by functionality. Each endpoint description specifies its RBAC role requirements, but see -xref:rest-api/rest-api-access-rbac-roles.adoc[RBAC Roles] +xref:rest-api:rest-api-access-rbac-roles.adoc[RBAC Roles] and the Couchbase Server documentation here {server-security-roles--xref} if further information is required. -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/rest-api/rest-api-metrics.adoc b/modules/rest-api/pages/rest-api-metrics.adoc similarity index 74% rename from modules/ROOT/pages/rest-api/rest-api-metrics.adoc rename to modules/rest-api/pages/rest-api-metrics.adoc index 27ccafb42..ecc456534 100644 --- a/modules/ROOT/pages/rest-api/rest-api-metrics.adoc +++ b/modules/rest-api/pages/rest-api-metrics.adoc @@ -1,16 +1,16 @@ = Metrics REST API -:page-aliases: refer/rest-api-metrics.adoc, rest-api-metrics.adoc +:page-aliases: ROOT:refer/rest-api-metrics.adoc, ROOT:rest-api-metrics.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :page-content: conceptual :description: Description of the Sync Gateway Metrics Rest API -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-related: {rest-api--xref} | {rest-api-admin--xref} | {xref-sgw-pg-stats-monitoring} | {xref-sgw-pg-stats-prometheus} :topic-group: REST API -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == Introduction @@ -34,12 +34,12 @@ To allow users to access the Metrics API up you need to create a Couchbase Serve == Configuration -include::partial$prometheus-activation.adoc[] +include::ROOT:partial$prometheus-activation.adoc[] == API Reference -The xref:rest_api_metric.adoc[API reference] groups all the endpoints by functionality. -For more information, refer to xref:manage/stats-monitoring.adoc[View Statistics and Metrics]. +The xref:rest-api:rest_api_metric.adoc[API reference] groups all the endpoints by functionality. +For more information, refer to xref:manage:stats-monitoring.adoc[View Statistics and Metrics]. -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/rest-api/rest-api.adoc b/modules/rest-api/pages/rest-api.adoc similarity index 50% rename from modules/ROOT/pages/rest-api/rest-api.adoc rename to modules/rest-api/pages/rest-api.adoc index e3a4deaaa..e2838ae77 100644 --- a/modules/ROOT/pages/rest-api/rest-api.adoc +++ b/modules/rest-api/pages/rest-api.adoc @@ -1,19 +1,19 @@ = Public REST API -:page-aliases: refer/rest-api-public.adoc, rest-api.adoc +:page-aliases: ROOT:refer/rest-api-public.adoc, ROOT:rest-api.adoc :page-role: -toc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-content: conceptual :description: Description of the Sync Gateway Rest API -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-related: {rest-api-admin--xref} | {rest-api-metrics--xref} :topic-group: REST API -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == API Reference -The xref:rest_api_public.adoc[API reference] groups all the endpoints by functionality. +The xref:rest-api:rest_api_public.adoc[API reference] groups all the endpoints by functionality. -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/rest-api/pages/rest_api_admin.adoc b/modules/rest-api/pages/rest_api_admin.adoc new file mode 100644 index 000000000..7616f223a --- /dev/null +++ b/modules/rest-api/pages/rest_api_admin.adoc @@ -0,0 +1,8 @@ +:page-layout: rest-api +:page-aliases: ROOT:rest_api_admin_static.adoc, ROOT:rest_api_admin.adoc +:doctitle: Sync Gateway Admin API Reference +:navtitle: Admin API Reference + +++++ +include::ROOT:partial$sgw-openapi-admin.html[] +++++ diff --git a/modules/rest-api/pages/rest_api_metric.adoc b/modules/rest-api/pages/rest_api_metric.adoc new file mode 100644 index 000000000..3b99566d1 --- /dev/null +++ b/modules/rest-api/pages/rest_api_metric.adoc @@ -0,0 +1,8 @@ +:page-layout: rest-api +:doctitle: Sync Gateway Metrics API Reference +:navtitle: Metrics API Reference +:page-aliases: ROOT:rest_api_metrics_static.adoc, ROOT:rest_api_metric.adoc + +++++ +include::ROOT:partial$sgw-openapi-metric.html[] +++++ diff --git a/modules/rest-api/pages/rest_api_public.adoc b/modules/rest-api/pages/rest_api_public.adoc new file mode 100644 index 000000000..484fffb03 --- /dev/null +++ b/modules/rest-api/pages/rest_api_public.adoc @@ -0,0 +1,8 @@ +:page-layout: rest-api +:doctitle: Sync Gateway Public API Reference +:navtitle: Public API Reference +:page-aliases: ROOT:rest_api_public_static.adoc, ROOT:rest_api_public.adoc + +++++ +include::ROOT:partial$sgw-openapi-public.html[] +++++ diff --git a/modules/ROOT/pages/security/audit-log-events.adoc b/modules/security/pages/audit-log-events.adoc similarity index 97% rename from modules/ROOT/pages/security/audit-log-events.adoc rename to modules/security/pages/audit-log-events.adoc index bcff11d40..6d8ea0318 100644 --- a/modules/ROOT/pages/security/audit-log-events.adoc +++ b/modules/security/pages/audit-log-events.adoc @@ -1,5 +1,5 @@ = Audit Logging Events Reference -:page-aliases: audit-log-events.adoc +:page-aliases: ROOT:audit-log-events.adoc :page-edition: Enterprise :description: Audit Logging provides tools for administrators to track operational irregularities and to support regulatory and security compliance standards, such as link:https://www.hhs.gov/hipaa/index.html[HIPAA] and link:https://soc2.co.uk/soc2[SOC-2]. Below is a list of possible Audit Events. @@ -36,7 +36,7 @@ You can use the value to specify which events will be present or written to your |`EventScope` |The scope of the event. This can be `Global` or `Database`. -You can configure global scope events via the xref:configuration/configuration-schema-bootstrap.adoc#logging-audit-audit_log_file_path[bootstrap config], and database events via the xref:rest_api_admin.adoc[Admin REST API]. +You can configure global scope events via the xref:configuration:configuration-schema-bootstrap.adoc#logging-audit-audit_log_file_path[bootstrap config], and database events via the xref:rest-api:rest_api_admin.adoc[Admin REST API]. |`EventType` |The type of action performed by the event. @@ -779,12 +779,12 @@ Database level audit events are segregated into per Sync Gateway database specif == See Also -* xref:security/audit-logging.adoc[] +* xref:security:audit-logging.adoc[] -* xref:security/manage-audit-logs.adoc[] +* xref:security:manage-audit-logs.adoc[] -* xref:manage/sgcollect-info.adoc[] +* xref:manage:sgcollect-info.adoc[] -* xref:rest_api_admin.adoc[Admin REST API Reference] +* xref:rest-api:rest_api_admin.adoc[Admin REST API Reference] -* xref:rest_api_admin_static.adoc[Admin REST API Reference] +* xref:ROOT:rest_api_admin_static.adoc[Admin REST API Reference] diff --git a/modules/ROOT/pages/security/audit-logging.adoc b/modules/security/pages/audit-logging.adoc similarity index 91% rename from modules/ROOT/pages/security/audit-logging.adoc rename to modules/security/pages/audit-logging.adoc index c7ca020fa..7f4963335 100644 --- a/modules/ROOT/pages/security/audit-logging.adoc +++ b/modules/security/pages/audit-logging.adoc @@ -1,5 +1,5 @@ = Audit Logging -:page-aliases: audit-logging.adoc +:page-aliases: ROOT:audit-logging.adoc :page-edition: Enterprise :description: Audit Logging provides tools for administrators to track operational irregularities and to support regulatory and security compliance standards. @@ -25,7 +25,7 @@ Logs are immutable and cannot be altered once recorded. Viewing and managing audit logs permissions are enforced through Sync Gateway RBAC controls. Logs are written locally on each Sync Gateway node. -IMPORTANT: xref:manage/sgcollect-info.adoc[SG Collect Info] does NOT collect audit log information as audit logs contain sensitive, unredacted data. +IMPORTANT: xref:manage:sgcollect-info.adoc[SG Collect Info] does NOT collect audit log information as audit logs contain sensitive, unredacted data. There is only one audit log file active at a time, which is periodically rotated based on the following properties: @@ -48,7 +48,7 @@ NOTE: Administrators must ensure the rotated logs are picked up before they are Audit events are tagged at a database level to distinguish between events coming from different databases. The fields the event was called with are also added if applicable to the optional context property of the event. -For more information, see xref:security/audit-log-events.adoc[audit events reference page]. +For more information, see xref:security:audit-log-events.adoc[audit events reference page]. NOTE: Event auditing occurs per Sync Gateway node, capturing its own events only. If you require a cluster-wide record, the records must be manually consolidated by an adminstrator. @@ -66,7 +66,7 @@ If a given event is disabled, it will not be logged regardless of the user. Events can be enabled per database or globally. NOTE: If an audit event has `DefaultEnabled` set to `true`, it does not need to be explicitly enabled by the API. -See xref:security/audit-log-events.adoc[] for more information on specific audit events. +See xref:security:audit-log-events.adoc[] for more information on specific audit events. === Audit Fields @@ -143,12 +143,12 @@ Above is a successful login by `user1` to retrieve a document named `doc`. == See Also -* xref:security/manage-audit-logs.adoc[] +* xref:security:manage-audit-logs.adoc[] -* xref:security/audit-log-events.adoc[] +* xref:security:audit-log-events.adoc[] -* xref:manage/sgcollect-info.adoc[] +* xref:manage:sgcollect-info.adoc[] -* xref:rest-api/rest-api-admin.adoc[Admin REST API] +* xref:rest-api:rest-api-admin.adoc[Admin REST API] -* xref:rest_api_admin.adoc[Admin REST API Reference] +* xref:rest-api:rest_api_admin.adoc[Admin REST API Reference] diff --git a/modules/ROOT/pages/security/authentication-certs.adoc b/modules/security/pages/authentication-certs.adoc similarity index 93% rename from modules/ROOT/pages/security/authentication-certs.adoc rename to modules/security/pages/authentication-certs.adoc index f98e8dbd9..ae6cb3ac5 100644 --- a/modules/ROOT/pages/security/authentication-certs.adoc +++ b/modules/security/pages/authentication-certs.adoc @@ -1,16 +1,16 @@ = TLS Certificate Authentication -:page-aliases: deployment-considerations,configuring-ssl, security.adoc, authentication-certs.adoc +:page-aliases: deployment-considerations,configuring-ssl, ROOT:security.adoc, ROOT:authentication-certs.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: Securing Couchbase Sync Gateway with TLS Authentication :url-curl: https://curl.haxx.se/ :url-httpie: https://github.com/jakubroztocil/httpie -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: Security :param-related: {authentication-users--xref} | {xref-sgw-pg-sync-function} | {import-filter--xref} | {read-access--xref} | {xref-sgw-pg-write-access} :param-abstract: This content explains how to implement TLS Certificate Authentication for Sync Gateway -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == Data Access @@ -116,7 +116,7 @@ Each method is discussed below in more detail. === Username and Password The username and password of the RBAC user are specified in the Sync Gateway configuration file. -This method is used in the getting started xref:getting-started.adoc#start-sync-gateway[section]. +This method is used in the getting started xref:ROOT:getting-started.adoc#start-sync-gateway[section]. === X.509 Certificates @@ -131,7 +131,7 @@ To use X.509 certificate based authentication with Sync Gateway, you must first Once the Couchbase Server cluster has been protected by the deployment of root and node certificates described above, a _client_ certificate can be signed by the root certificate, to allow Sync Gateway to access the cluster. To generate the _client_ certificate, make sure that the Couchbase Server cluster has the expected xref:server:manage:manage-security/configure-client-certificates.adoc#assumptions[bucket and RBAC user]. -Also refer to the xref:getting-started.adoc#configure-couchbase-server[Getting Started: Configure Couchbase Server] to configure the RBAC user with appropriate privileges for access by a Sync Gateway instance. +Also refer to the xref:ROOT:getting-started.adoc#configure-couchbase-server[Getting Started: Configure Couchbase Server] to configure the RBAC user with appropriate privileges for access by a Sync Gateway instance. Next, follow the instructions in xref:server:manage:manage-security/configure-client-certificates.adoc#client-certificate-authorized-by-a-root-certificate[Client Access: Root-Certificate Authorization] to create a client certificate that is authorized by the cluster’s root certificate. @@ -146,7 +146,7 @@ X.509 certificate based authentication is enabled on Sync Gateway by specifying [source,json] ---- -include::example$configuration/x509-config.json[] +include::ROOT:example$configuration/x509-config.json[] ---- If the connection is successful, you should see the following in the logs. @@ -168,4 +168,4 @@ More detail on the configuration properties for x.509 authentication can be foun If the **username**/**password** properties are also specified in the configuration file then Sync Gateway will use password-based authentication and also include the client certificate in the TLS handshake. -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/security/authentication-users.adoc b/modules/security/pages/authentication-users.adoc similarity index 90% rename from modules/ROOT/pages/security/authentication-users.adoc rename to modules/security/pages/authentication-users.adoc index 99e5657e1..1b57d5337 100644 --- a/modules/ROOT/pages/security/authentication-users.adoc +++ b/modules/security/pages/authentication-users.adoc @@ -1,16 +1,16 @@ = User Authentication -:page-aliases: learn/authentication.adoc, authentication.adoc, authentication-users.adoc +:page-aliases: ROOT:learn/authentication.adoc, ROOT:authentication.adoc, ROOT:authentication-users.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :description: Access {sgw} securely to sync from cloud to edge :keywords: 'user authentication' 'sync gateway' sync replication edge cloud mobile -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: Security :param-related: {authentication-certs--xref} | {xref-sgw-pg-sync-function} | {import-filter--xref} | {read-access--xref} | {xref-sgw-pg-write-access} :param-abstract: This content explains how to implement user authentication in {sgw} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] :idprefix: :idseparator: - @@ -68,7 +68,7 @@ This is the recommended way of using basic authentication. :param-page: replication :param-bookmark: basic-authentication -include::partial$blocklinks-cbl.adoc[] +include::ROOT:partial$blocklinks-cbl.adoc[] == Auth Providers @@ -84,12 +84,12 @@ The session ID can be used to configure the {cbl} replicator or for other HTTP r The following diagram describes the sequence of steps. -image::static-auth-provider.png[] +image::ROOT:static-auth-provider.png[] API reference: -- xref:rest_api_public.adoc#tag/Authentication/operation/post_db-_facebook[/+{db}+/_facebook] -- xref:rest_api_public.adoc#tag/Authentication/operation/post_db-_google[/+{db}+/_google] +- xref:rest-api:rest_api_public.adoc#tag/Authentication/operation/post_db-_facebook[/+{db}+/_facebook] +- xref:rest-api:rest_api_public.adoc#tag/Authentication/operation/post_db-_google[/+{db}+/_google] For other providers we recommend to use Custom Authentication or OpenID Connect. @@ -102,9 +102,9 @@ the App Server will verify those, then tell the {sgw} to create a new session fo The following diagram shows an example architecture to support Google SignIn in a Couchbase Mobile application, the client sends an access token to the App Server where a server side validation is done with the Google API and a corresponding {sgw} user is then created if it's the first time the user logs in. The last request creates a session. -image::custom-auth-flow.png[] +image::ROOT:custom-auth-flow.png[] -Given a user that has already been created, a new session for that user can be created on the Admin xref:rest_api_admin.adoc#tag/Session/operation/post_db-_session[POST /+{db}+/_session] endpoint. +Given a user that has already been created, a new session for that user can be created on the Admin xref:rest-api:rest_api_admin.adoc#tag/Session/operation/post_db-_session[POST /+{db}+/_session] endpoint. [source,bash] ---- @@ -124,7 +124,7 @@ The HTTP response body contains the credentials of the session. * *name* corresponds to the `cookie_name` * *value* corresponds to the `session_id` * *path* is the hostname of the {sgw} -* *expirationDate* corresponds to the cookie's expiration time. The endpoint's xref:rest_api_admin.adoc#tag/Session/operation/post_db-_session[API reference] contains more information about how the expiration time is automatically extended according to the user session activity. +* *expirationDate* corresponds to the cookie's expiration time. The endpoint's xref:rest-api:rest_api_admin.adoc#tag/Session/operation/post_db-_session[API reference] contains more information about how the expiration time is automatically extended according to the user session activity. * *secure* Whether the cookie should only be sent using a secure protocol (e.g. HTTPS) * *httpOnly* Whether the cookie should only be used when transmitting HTTP, or HTTPS, requests thus restricting access from other, non-HTTP APIs @@ -166,7 +166,7 @@ In the algorithm dropdown, make sure to select `RS256` as the signing algorithm . Upon successful validation, {sgw} authenticates the user based on the subject and issuer in the token. Since Open ID tokens are typically large, the usual approach is to use the Open ID token to obtain a {sgw} session id (using the -xref:rest_api_public.adoc#tag/Session/operation/post_db-_session[+POST /{db}/_session+] +xref:rest-api:rest_api_public.adoc#tag/Session/operation/post_db-_session[+POST /{db}/_session+] endpoint), and then use the returned session id for subsequent authentication requests. ===== @@ -202,7 +202,7 @@ On launch, the application should check if the token has expired. If it has then you must request a new token (Google SignIn for iOS has a method called `signInSilently` for this purpose). By doing this, the application can then use the token to create a {sgw} session. -image::client-auth.png[] +image::ROOT:client-auth.png[] . The Google SignIn SDK prompts the user to login and if successful it returns an ID token to the application. . The ID token is used to create a {sgw} session by sending a POST `+/{db}/_session+` request. diff --git a/modules/ROOT/pages/security/manage-audit-logs.adoc b/modules/security/pages/manage-audit-logs.adoc similarity index 87% rename from modules/ROOT/pages/security/manage-audit-logs.adoc rename to modules/security/pages/manage-audit-logs.adoc index 1741f7515..e578a68be 100644 --- a/modules/ROOT/pages/security/manage-audit-logs.adoc +++ b/modules/security/pages/manage-audit-logs.adoc @@ -1,5 +1,5 @@ = Manage Audit Logs -:page-aliases: manage-audit-logs.adoc +:page-aliases: ROOT:manage-audit-logs.adoc :page-edition: Enterprise :description: Administrators can manage audit logs to track operational irregularities and to support regulatory and security compliance standards. @@ -23,11 +23,11 @@ This will affect the configuration on a per database basis. For more information, see: -* xref:configuration/configuration-schema-bootstrap.adoc[Bootstrap Configuration Schema]. +* xref:configuration:configuration-schema-bootstrap.adoc[Bootstrap Configuration Schema]. -* xref:configuration/configuration-schema-database.adoc[Database Configuration Schema]. +* xref:configuration:configuration-schema-database.adoc[Database Configuration Schema]. -* xref:rest_api_admin.adoc[Admin REST API]. +* xref:rest-api:rest_api_admin.adoc[Admin REST API]. == Global Configuration with the Bootstrap Config @@ -50,7 +50,7 @@ NOTE: Configuration via the bootstrap config will affect your configuration glob To successfully configure audit logging, you must set a file path for your audit logs and set the `enabled` parameter to `true`. Enabling and disabling audit logging is handled by the Admin REST API at a cluster and Sync Gateway database level. Setting enabled to true without any specified enabled events will only enable events with `DefaultEnabled` set to `true`. -To view the list of audit events, see xref:security/audit-log-events.adoc[] +To view the list of audit events, see xref:security:audit-log-events.adoc[] To configure audit logs retention and rotation globally, you can use the following parameters below with your bootstrap configuration. @@ -89,17 +89,17 @@ a|`rotation` is an object that contains the following properties: |=== -For further bootstrap configuration options, see xref:configuration/configuration-schema-bootstrap.adoc[]. +For further bootstrap configuration options, see xref:configuration:configuration-schema-bootstrap.adoc[]. == Database Configuration with the Admin REST API Couchbase recommends you only use configuration at the database level if you wish to alter your settings per database. -You can configure audit events at runtime without modifying the entire database configuration using the following HTTP request methods with the xref:rest_api_admin.adoc[Admin REST API]: +You can configure audit events at runtime without modifying the entire database configuration using the following HTTP request methods with the xref:rest-api:rest_api_admin.adoc[Admin REST API]: -* xref:rest_api_admin.adoc#tag/Database-Configuration/operation/get_db-_config-audit[GET /{db}/_config/audit] -* xref:rest_api_admin.adoc#tag/Database-Configuration/operation/put_db-_config-audit[PUT /{db}/_config/audit (replace)] -* xref:rest_api_admin.adoc#tag/Database-Configuration/operation/post_db-_config-audit[POST /{db}/_config/audit (upsert)] +* xref:rest-api:rest_api_admin.adoc#tag/Database-Configuration/operation/get_db-_config-audit[GET /{db}/_config/audit] +* xref:rest-api:rest_api_admin.adoc#tag/Database-Configuration/operation/put_db-_config-audit[PUT /{db}/_config/audit (replace)] +* xref:rest-api:rest_api_admin.adoc#tag/Database-Configuration/operation/post_db-_config-audit[POST /{db}/_config/audit (upsert)] These request methods apply changes at the database level. Below you can find examples demonstrating use of the above methods. @@ -160,11 +160,11 @@ A use case for these fields would be to exclude certain administrative users or Users and roles are organised into the following domains: * `sgw` - Users and Roles that are created by and operate solely within Sync Gateway. -For more information, see xref:access-control/access-control-concepts.adoc#lbl-sgw-users[Sync Gateway defined Users and Roles]. +For more information, see xref:access-control:access-control-concepts.adoc#lbl-sgw-users[Sync Gateway defined Users and Roles]. * `cbs` - Users that are are RBAC controlled. These are created on Couchbase Server. Sync Gateway's Admin and Metrics REST APIs are authenticated using Couchbase Server users. -For more information, see xref:access-control/access-control-concepts.adoc#lbl-rbac-users[RBAC Users]. +For more information, see xref:access-control:access-control-concepts.adoc#lbl-rbac-users[RBAC Users]. .Set the entire database audit configuration with simple schema ==== @@ -297,12 +297,12 @@ The request above demonstrates simultaneous disabling of the default audit event == See Also -* xref:security/audit-logging.adoc[] +* xref:security:audit-logging.adoc[] -* xref:security/audit-log-events.adoc[] +* xref:security:audit-log-events.adoc[] -* xref:manage/sgcollect-info.adoc[] +* xref:manage:sgcollect-info.adoc[] -* xref:rest_api_admin.adoc[Admin REST API Reference] +* xref:rest-api:rest_api_admin.adoc[Admin REST API Reference] -* xref:rest_api_admin_static.adoc[Admin REST API Reference] +* xref:ROOT:rest_api_admin_static.adoc[Admin REST API Reference] diff --git a/modules/ROOT/pages/security/secure-sgw-access.adoc b/modules/security/pages/secure-sgw-access.adoc similarity index 96% rename from modules/ROOT/pages/security/secure-sgw-access.adoc rename to modules/security/pages/secure-sgw-access.adoc index 02b4a18c7..5acae8465 100644 --- a/modules/ROOT/pages/security/secure-sgw-access.adoc +++ b/modules/security/pages/secure-sgw-access.adoc @@ -1,16 +1,15 @@ = Secure Sync Gateway Access -:page-aliases: secure-sgw-access.adoc +:page-aliases: ROOT:secure-sgw-access.adoc, ROOT:anchor-secure-sync-gateway-access.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: -:page-aliases: anchor-secure-sync-gateway-access.adoc :description: Couchbase Sync Gateway TLS encryption and verification -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: Security :param-related: {authentication-users--xref} | {authentication-certs--xref} :param-abstract!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] :svc-config-json: https://github.com/couchbase/sync_gateway/blob/master/examples/serviceconfig.json[blob serviceconfig.json] @@ -189,4 +188,4 @@ Note that you can no longer start {sgw} without providing at least one parameter For more on command line options, see: {command-line-options--xref}. -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/server-compatibility/server-compatibility-backups.adoc b/modules/server-compatibility/pages/server-compatibility-backups.adoc similarity index 78% rename from modules/ROOT/pages/server-compatibility/server-compatibility-backups.adoc rename to modules/server-compatibility/pages/server-compatibility-backups.adoc index 4c4a5adc0..8b1c0f842 100644 --- a/modules/ROOT/pages/server-compatibility/server-compatibility-backups.adoc +++ b/modules/server-compatibility/pages/server-compatibility-backups.adoc @@ -1,5 +1,5 @@ = Backup and Restore -- Server Compatibility -:page-aliases: server-compatibility-backups.adoc +:page-aliases: ROOT:server-compatibility-backups.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -8,7 +8,7 @@ ifdef::prerelease[:page-status: {prerelease}] :idseparator: - -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -19,7 +19,7 @@ include::partial$_set_page_context.adoc[] :param-topic-group: compatibility :param-related: {compatibility--xref} :param-abstract!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Header @@ -37,5 +37,5 @@ if you're planning to use them in conjunction with Sync Gateway // BEGIN -- Page Footer -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/server-compatibility/server-compatibility-buckets.adoc b/modules/server-compatibility/pages/server-compatibility-buckets.adoc similarity index 93% rename from modules/ROOT/pages/server-compatibility/server-compatibility-buckets.adoc rename to modules/server-compatibility/pages/server-compatibility-buckets.adoc index 18c44af12..590057028 100644 --- a/modules/ROOT/pages/server-compatibility/server-compatibility-buckets.adoc +++ b/modules/server-compatibility/pages/server-compatibility-buckets.adoc @@ -1,5 +1,5 @@ = Buckets -- Server Compatibility -:page-aliases: server-compatibility-buckets.adoc +:page-aliases: ROOT:server-compatibility-buckets.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -8,7 +8,7 @@ ifdef::prerelease[:page-status: {prerelease}] :idseparator: - -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -18,7 +18,7 @@ include::partial$_set_page_context.adoc[] // BEGIN -- Page Header :param-topic-group: compatibility :param-related: {compatibility--xref} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Header == Introduction @@ -60,5 +60,5 @@ You can use per-collection sync functions to set expiry on all documents within NOTE: You can still set Document expiration settings on individual documents. // BEGIN -- Page Footer -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/server-compatibility/server-compatibility-collections.adoc b/modules/server-compatibility/pages/server-compatibility-collections.adoc similarity index 78% rename from modules/ROOT/pages/server-compatibility/server-compatibility-collections.adoc rename to modules/server-compatibility/pages/server-compatibility-collections.adoc index 2be3d637c..5888a2a0e 100644 --- a/modules/ROOT/pages/server-compatibility/server-compatibility-collections.adoc +++ b/modules/server-compatibility/pages/server-compatibility-collections.adoc @@ -1,5 +1,5 @@ = Collections -- Server Compatibility -:page-aliases: server-compatibility-collections.adoc +:page-aliases: ROOT:server-compatibility-collections.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -8,7 +8,7 @@ ifdef::prerelease[:page-status: {prerelease}] :idseparator: - -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -19,7 +19,7 @@ include::partial$_set_page_context.adoc[] :param-topic-group: compatibility :param-related: {compatibility--xref} :param-abstract!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Header @@ -35,5 +35,5 @@ Sync Gateway supports scopes and collections ({server-collections-default--xref} // BEGIN -- Page Footer -include::partial$block-related-content-data.adoc[] +include::ROOT:partial$block-related-content-data.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/server-compatibility/server-compatibility-eventing.adoc b/modules/server-compatibility/pages/server-compatibility-eventing.adoc similarity index 93% rename from modules/ROOT/pages/server-compatibility/server-compatibility-eventing.adoc rename to modules/server-compatibility/pages/server-compatibility-eventing.adoc index b7b9f75d6..7f8f933cc 100644 --- a/modules/ROOT/pages/server-compatibility/server-compatibility-eventing.adoc +++ b/modules/server-compatibility/pages/server-compatibility-eventing.adoc @@ -1,5 +1,5 @@ = Eventing -- Server Compatibility -:page-aliases: server-compatibility-eventing.adoc +:page-aliases: ROOT:server-compatibility-eventing.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -9,7 +9,7 @@ ifdef::prerelease[:page-status: {prerelease}] :idseparator: - -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -19,11 +19,11 @@ include::partial$_set_page_context.adoc[] // BEGIN -- Page Header :param-topic-group: compatibility :param-related: {compatibility--xref} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Header -include::partial$block-caveats.adoc[tags=ee-only-feature] +include::ROOT:partial$block-caveats.adoc[tags=ee-only-feature] == Introduction @@ -38,7 +38,7 @@ Here we provide details on how {server-eventing--xref} relates to data changes i == Using Eventing - Server 7.6.3+ -include::partial$block-caveats.adoc[tags=eventing-mixed-mode] +include::ROOT:partial$block-caveats.adoc[tags=eventing-mixed-mode] Sync Gateway 3.2.0 and later supports interoperability with Eventing from Couchbase Server version 7.6.3+. You can use Eventing to handle data changes that happen when applications interact and to integrate with other Couchbase services such as Data, Query and Full Text Search. @@ -121,5 +121,5 @@ You will see the following warning if you try to do this: + `SyncGateway is enabled on: , deployment of source bucket mutating handler will cause Intra Bucket Recursion` // BEGIN -- Page Footer -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/server-compatibility/server-compatibility-transactions.adoc b/modules/server-compatibility/pages/server-compatibility-transactions.adoc similarity index 89% rename from modules/ROOT/pages/server-compatibility/server-compatibility-transactions.adoc rename to modules/server-compatibility/pages/server-compatibility-transactions.adoc index 4191ed5d6..d1020035f 100644 --- a/modules/ROOT/pages/server-compatibility/server-compatibility-transactions.adoc +++ b/modules/server-compatibility/pages/server-compatibility-transactions.adoc @@ -1,5 +1,5 @@ = Transactions -- Server Compatibility -:page-aliases: server-compatibility-transactions.adoc +:page-aliases: ROOT:server-compatibility-transactions.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -8,7 +8,7 @@ ifdef::prerelease[:page-status: {prerelease}] :idseparator: - -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -19,7 +19,7 @@ include::partial$_set_page_context.adoc[] // BEGIN -- Page Heading :param-topic-group: compatibility :param-related: {compatibility--xref} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -47,5 +47,5 @@ Only committed transactions will ever reach Sync Gateway. There is no guarantee that a series of updates made within a transaction block, on either the Couchbase Server or Couchbase Lite client side, will be ACID compliant when they sync to the other end. -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] diff --git a/modules/ROOT/pages/server-compatibility/server-compatibility-xdcr.adoc b/modules/server-compatibility/pages/server-compatibility-xdcr.adoc similarity index 88% rename from modules/ROOT/pages/server-compatibility/server-compatibility-xdcr.adoc rename to modules/server-compatibility/pages/server-compatibility-xdcr.adoc index 446019585..65697759a 100644 --- a/modules/ROOT/pages/server-compatibility/server-compatibility-xdcr.adoc +++ b/modules/server-compatibility/pages/server-compatibility-xdcr.adoc @@ -1,5 +1,5 @@ = XDCR -- Server Compatibility -:page-aliases: server-compatibility-xdcr.adoc +:page-aliases: ROOT:server-compatibility-xdcr.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -9,7 +9,7 @@ ifdef::prerelease[:page-status: {prerelease}] :idseparator: - -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -22,7 +22,7 @@ include::partial$_set_page_context.adoc[] :param-topic-group: compatibility :param-related: {compatibility--xref} :param-abstract: Sync Gateway is specifically designed for mobile synchronization, but there are use-cases where it can usefully be used alongside XDCR to provide a comprehensive solution. -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -58,7 +58,7 @@ This history is necessary to consistently handle the revocation of access grants [[icr-active-mobile]] .Active-to-active mobile synchronization -image::{image-icr-active-mobile-sync}[,std-image-size] +image::ROOT:{image-icr-active-mobile-sync}[,std-image-size] [#lbl-xdcr] @@ -84,7 +84,7 @@ It pushes data from the primary data center to the secondary data centers, where * Sync Gateway, although deployed at both ends of the XDCR replication, crucially is in *read-only* mode at the target end. .XDCR Replication -image::{image-xdcr-data-replication-to-read-only}[,std-image-size] +image::ROOT:{image-xdcr-data-replication-to-read-only}[,std-image-size] ==== [#lbl-prov-drc] @@ -98,15 +98,15 @@ Even though Sync Gateway is the operational replicator of choice for mobile data === Clusters in Same Region -include::../deploy/setting-up-dr-cluster.adoc[tags=page-attributes] +include::deploy:setting-up-dr-cluster.adoc[tags=page-attributes] -include::../deploy/setting-up-dr-cluster.adoc[tags=clusters-in-same-region] +include::deploy:setting-up-dr-cluster.adoc[tags=clusters-in-same-region] === Clusters in Different Regions -include::../deploy/setting-up-dr-cluster.adoc[tags=clusters-in-diff-region] +include::deploy:setting-up-dr-cluster.adoc[tags=clusters-in-diff-region] // BEGIN -- Page Footer -include::partial$block-related-content-sync.adoc[] -// END -- Page Footer \ No newline at end of file +include::ROOT:partial$block-related-content-sync.adoc[] +// END -- Page Footer diff --git a/modules/ROOT/pages/server-compatibility/xdcr-active-active-eventing.adoc b/modules/server-compatibility/pages/xdcr-active-active-eventing.adoc similarity index 96% rename from modules/ROOT/pages/server-compatibility/xdcr-active-active-eventing.adoc rename to modules/server-compatibility/pages/xdcr-active-active-eventing.adoc index 8c9c648f1..66063980f 100644 --- a/modules/ROOT/pages/server-compatibility/xdcr-active-active-eventing.adoc +++ b/modules/server-compatibility/pages/xdcr-active-active-eventing.adoc @@ -1,17 +1,17 @@ = XDCR Active-Active and Eventing -:page-aliases: xdcr-active-active-eventing.adoc +:page-aliases: ROOT:xdcr-active-active-eventing.adoc :description: pass:q[Understand how to safely use Couchbase Eventing functions in bi-directional XDCR environments, including Sync Gateway 4.0 compatibility.] :keywords: xdcr, eventing, active-active, sync gateway, replication, loop prevention, conflict resolution, enrichment, mobile, couchbase eventing, replication logic :idprefix: :idseparator: - -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes :param-topic-group: compatibility :param-related: {compatibility--xref} :param-abstract: Learn how to design Couchbase Eventing functions to avoid replication loops and conflicts in active-active XDCR environments with Sync Gateway 4.0. -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading == Introduction @@ -155,5 +155,5 @@ These issues apply to all Couchbase versions with Eventing and XDCR support, and // BEGIN -- Page Footer -include::partial$block-related-content-sync.adoc[] +include::ROOT:partial$block-related-content-sync.adoc[] // END -- Page Footer \ No newline at end of file diff --git a/modules/ROOT/pages/start-here/get-started-install.adoc b/modules/start-here/pages/get-started-install.adoc similarity index 97% rename from modules/ROOT/pages/start-here/get-started-install.adoc rename to modules/start-here/pages/get-started-install.adoc index 2f7edb1bc..a3ee4f6df 100644 --- a/modules/ROOT/pages/start-here/get-started-install.adoc +++ b/modules/start-here/pages/get-started-install.adoc @@ -1,5 +1,5 @@ = Install Sync Gateway -:page-aliases: getting-started, start/get-started-install.adoc +:page-aliases: getting-started, ROOT:start/get-started-install.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -7,7 +7,7 @@ ifdef::prerelease[:page-status: {prerelease}] :page-type: procedural -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -55,20 +55,20 @@ For other command-line options -- see {command-line-options--xref} :topic-group: Start Here! :param-abstract: pass:q[This is *Step 3* in the _Start Here!_ topic group. It installs the _Sync Gateway_ binary distribution] :param-related: {introduction--xref} | {get-started-prepare--xref} | {get-started-verify-install--xref} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading .Preparatory Steps NOTE: Ensure you have read -- and acted-upon -- the information in {get-started-prepare--xref}. :param-page: {page-relative-src-path} -include::partial$topic-group-get-started.adoc[] +include::ROOT:partial$topic-group-get-started.adoc[] == Installation Process -You can install Sync Gateway on any of the xref:supported-environments.adoc[supported operating systems]. +You can install Sync Gateway on any of the xref:product-notes:supported-environments.adoc[supported operating systems]. On completion of this topic you should have a working Sync Gateway that you can extend and configure to meet your business needs. The installation process first deploys the Sync Gateway package, then defines and starts an example instance of Sync Gateway running as a service. @@ -275,7 +275,7 @@ Download the required edition of Sync Gateway from the {downloads--url}. Open the installer and follow the instructions. If the installation was successful you will see the following: -image::windows-installation-complete.png[] +image::ROOT:windows-installation-complete.png[] When the installation is complete Sync Gateway will be running as a service `SyncGateway`. @@ -629,7 +629,7 @@ Now that you have a working version of Sync Gateway, which you can connect a con -include::partial$block-related-content-deploy.adoc[] +include::ROOT:partial$block-related-content-deploy.adoc[] // Tidy up diff --git a/modules/ROOT/pages/start-here/get-started-prepare.adoc b/modules/start-here/pages/get-started-prepare.adoc similarity index 85% rename from modules/ROOT/pages/start-here/get-started-prepare.adoc rename to modules/start-here/pages/get-started-prepare.adoc index 6fcd780c2..99de29a5e 100644 --- a/modules/ROOT/pages/start-here/get-started-prepare.adoc +++ b/modules/start-here/pages/get-started-prepare.adoc @@ -1,12 +1,12 @@ = Prepare to Install Sync Gateway -:page-aliases: start/get-started-prepare.adoc +:page-aliases: ROOT:start/get-started-prepare.adoc, ROOT:getting-started.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: pass:q[Prerequisites for installing _Sync Gateway_; to synchronize your data from cloud to edge.] -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Attributes @@ -23,11 +23,11 @@ include::partial$_set_page_context.adoc[] :topic-group: Start Here! :param-abstract: pass:q[This is *Step 2* in the _Start Here!_ topic group. It introduces the prerequisites for the installation of _Sync Gateway_] :param-related: {introduction--xref} | {get-started-install--xref} | {get-started-verify-install--xref} -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading :param-page: {page-relative-src-path} -include::partial$topic-group-get-started.adoc[] +include::ROOT:partial$topic-group-get-started.adoc[] == What You Need @@ -50,39 +50,39 @@ TIP: You can get Couchbase Server from our {url-downloads}[Downloads, window=_bl You will then need to configure Couchbase Server by adding a Bucket and an RBAC User for Sync Gateway -- see: <>. -include::partial$block-caveats.adoc[tags="cbs6.0ke-xattrs"] +include::ROOT:partial$block-caveats.adoc[tags="cbs6.0ke-xattrs"] == Network Port Requirements -include::partial$sgw-network-port-reqs.adoc[] +include::ROOT:partial$sgw-network-port-reqs.adoc[] == Couchbase Server Host Ports -include::partial$sgw-svr-ports.adoc[] +include::ROOT:partial$sgw-svr-ports.adoc[] [#sgw-and-couchbase-server] [#lbl-req-compat, reftext=Compatibility Requirements] == Compatibility with Couchbase Server -include::partial$sgw-svr-compatibility.adoc[] +include::ROOT:partial$sgw-svr-compatibility.adoc[] == Compatibility with Couchbase Lite -include::partial$compatibility-cbl-sgw.adoc[] +include::ROOT:partial$compatibility-cbl-sgw.adoc[] == Supported Operating Systems -include::partial$sgw-supported-os.adoc[tags=sup-os-dev-test-prod] +include::ROOT:partial$sgw-supported-os.adoc[tags=sup-os-dev-test-prod] -include::partial$sgw-supported-os.adoc[tags=sup-os-dev-test] +include::ROOT:partial$sgw-supported-os.adoc[tags=sup-os-dev-test] [#cloud-support] -include::partial$sgw-supported-os.adoc[tags=sup-os-cloud] +include::ROOT:partial$sgw-supported-os.adoc[tags=sup-os-cloud] == Cluster Configuration for Sync Gateway @@ -119,7 +119,7 @@ Use this bucket to test the deployment of Sync Gateway, later in the Getting Sta .. In the pop-up window, enter *get-started-bucket* for the *name* and select *Add Bucket*. You can leave the other options to their defaults. + -include::partial$block-caveats.adoc[tags="ephemeral-buckets"] +include::ROOT:partial$block-caveats.adoc[tags="ephemeral-buckets"] === Step {counter: step} -- Create RBAC User @@ -151,12 +151,12 @@ NOTE: For more on creating Couchbase Server users see: {server-manage-security-u When installing Couchbase Server on the cloud, ensure that network permissions (or firewall settings) allow incoming connections to Couchbase Server ports. -include::partial$sgw-svr-ports.adoc[] +include::ROOT:partial$sgw-svr-ports.adoc[] If this is not done, the Couchbase Server node can experience difficulty joining a cluster. You can refer to the {xref--pfx-svr}install:install-ports.adoc[Couchbase Server Ports] guide to see the full list of available ports and their associated services. // BEGIN -- Page Footer -include::partial$block-related-content-deploy.adoc[] -// END -- Page Footer \ No newline at end of file +include::ROOT:partial$block-related-content-deploy.adoc[] +// END -- Page Footer diff --git a/modules/ROOT/pages/start-here/get-started-verify-install.adoc b/modules/start-here/pages/get-started-verify-install.adoc similarity index 96% rename from modules/ROOT/pages/start-here/get-started-verify-install.adoc rename to modules/start-here/pages/get-started-verify-install.adoc index adc400201..82b280b27 100644 --- a/modules/ROOT/pages/start-here/get-started-verify-install.adoc +++ b/modules/start-here/pages/get-started-verify-install.adoc @@ -1,5 +1,5 @@ = Verify a Sync Gateway Install -:page-aliases: start/get-started-verify-install.adoc +:page-aliases: ROOT:start/get-started-verify-install.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -7,7 +7,7 @@ ifdef::prerelease[:page-status: {prerelease}] :page-type: procedural -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN - Page Attributes @@ -22,7 +22,7 @@ include::partial$_set_page_context.adoc[] :topic-group: Start Here! :param-related: {introduction--xref} | {get-started-prepare--xref} | {get-started-install--xref} :param-abstract: pass:q,a[This is *Step 4* in the _Start Here!_ topic group. Here we will verify that you can connect your _{sgw}_ to a _Couchbase Server_ and synchronize changes whether made in Couchbase Server or through {sgw}'s REST API.] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END - Page Heading @@ -35,7 +35,7 @@ https://blog.couchbase.com/using-docker-with-couchbase-mobile/[blog post on usin :param-page: {page-relative-src-path} -include::partial$topic-group-get-started.adoc[] +include::ROOT:partial$topic-group-get-started.adoc[] == Introduction @@ -325,7 +325,7 @@ The document should include any changes made through {sgw}, including the initia + [#img-cbs-view] .Couchbase Server Document Editor -image::cbs-view-first-doc.png[] +image::ROOT:cbs-view-first-doc.png[] [#lbl-crud-get] @@ -462,9 +462,9 @@ Assuming the delete worked you should see the following response: To verify that document changes have been replicated, you can: -* Monitor the {sgw} revision number returned by the database endpoint (xref:rest_api_public.adoc#tag/Database-Management/operation/get_db-[GET /\{db}/]). +* Monitor the {sgw} revision number returned by the database endpoint (xref:rest-api:rest_api_public.adoc#tag/Database-Management/operation/get_db-[GET /\{db}/]). The revision number increments for every change that happens on the {sgw} database. -* Query a document by ID on the {sgw} REST API as shown in <>. Use xref:rest_api_public.adoc#tag/Document/operation/get_keyspace-docid[GET /\{keyspace}/\{docid}] -- see: {rest-api-access--xref} for more. +* Query a document by ID on the {sgw} REST API as shown in <>. Use xref:rest-api:rest_api_public.adoc#tag/Document/operation/get_keyspace-docid[GET /\{keyspace}/\{docid}] -- see: {rest-api-access--xref} for more. * Query a document from the Query Workbench on the {cbs} Console. @@ -484,5 +484,5 @@ Maybe you want to learn more about {sgw}'s {configuration-schema-bootstrap--xref ** Apps on mobile devices using Couchbase Lite -- see {sync-using-app--xref} // BEGIN -- Page Footer -include::partial$block-related-content-deploy.adoc[] +include::ROOT:partial$block-related-content-deploy.adoc[] // END -- Page Footer diff --git a/modules/ROOT/pages/sync/delta-sync.adoc b/modules/sync/pages/delta-sync.adoc similarity index 93% rename from modules/ROOT/pages/sync/delta-sync.adoc rename to modules/sync/pages/delta-sync.adoc index 8759b9812..eab39356a 100644 --- a/modules/ROOT/pages/sync/delta-sync.adoc +++ b/modules/sync/pages/delta-sync.adoc @@ -1,5 +1,5 @@ = Delta Sync -:page-aliases: delta-sync.adoc +:page-aliases: ROOT:delta-sync.adoc ifdef::show_edition[:page-edition: {release}] {enterprise} ifdef::prerelease[:page-status: {prerelease}] :page-role: @@ -8,12 +8,12 @@ ifdef::prerelease[:page-status: {prerelease}] :keywords: sync gateway, replication, sync, synchronization, edge, cloud :pageOriginRel: "sg=1.5, Cbs=5.0)_" -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: Sync :param-related: {xref-sgw-pg-sync-from-client} | {sync-inter-syncgateway-overview--xref} | {delta-sync--xref} | {xref-sgw-pg-resync} :param-abstract: This content introduces Sync Gateway's delta sync feature; sync only the data that has changed. -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] == Overview @@ -38,7 +38,7 @@ Replication does not use Delta Sync when pushing to a pre-2.8 target. == Configuration -You can enable delta-sync on a per-database basic in your Sync Gateway configuration file using the `delta_sync` properties in xref:rest-api/rest-api-admin.adoc[Database Configuration] -- as shown in <>: +You can enable delta-sync on a per-database basic in your Sync Gateway configuration file using the `delta_sync` properties in xref:rest-api:rest-api-admin.adoc[Database Configuration] -- as shown in <>: [#sample-cfg] .Sample of Database with Delta Sync @@ -94,4 +94,4 @@ Then enabling delta sync would take up an additional 400 KB of storage on Couchb ==== -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/sync/import-processing.adoc b/modules/sync/pages/import-processing.adoc similarity index 71% rename from modules/ROOT/pages/sync/import-processing.adoc rename to modules/sync/pages/import-processing.adoc index 4f0025726..40e8b1cce 100644 --- a/modules/ROOT/pages/sync/import-processing.adoc +++ b/modules/sync/pages/import-processing.adoc @@ -1,17 +1,17 @@ = Import Processing -:page-aliases: import-filter.adoc, import-processing.adoc -include::partial$_set_page_context.adoc[] +:page-aliases: ROOT:import-filter.adoc, ROOT:import-processing.adoc +include::ROOT:partial$_set_page_context.adoc[] == Overview The *import process* is a key part of mobile convergence. It is the means by which {sgw} becomes aware of non-{sgw} data changes and obtains the mobile metadata it requires to replicate changes. -image::shared-bucket-access.png[] +image::ROOT:shared-bucket-access.png[] == Operation -Any non-{sgw} change is eligible for import. For more information, refer to the xref:access-control/sync-function/sync-function.adoc[Sync Function] documentation. +Any non-{sgw} change is eligible for import. For more information, refer to the xref:access-control:sync-function/sync-function.adoc[Sync Function] documentation. The document is first run through the Sync Function to compute read security and routing, with the following differences: @@ -19,14 +19,14 @@ The document is first run through the Sync Function to compute read security and This means that `requireAccess`, `requireUser` and `requireRole` calls in the Sync Function are treated as no-ops. * During import, `oldDoc` is `nil` when the Sync Function is executed. -You can specify a filter function dynamically using xref:rest_api_admin.adoc#tag/Database-Configuration/operation/get_keyspace-_config-import_filter[/{keyspace}/_config/import_filter], or you can define one when you set up a database. -Refer to the xref:configuration/configuration-schema-import-filter.adoc[Import Filter Configuration] documentation for more information. +You can specify a filter function dynamically using xref:rest-api:rest_api_admin.adoc#tag/Database-Configuration/operation/get_keyspace-_config-import_filter[/{keyspace}/_config/import_filter], or you can define one when you set up a database. +Refer to the xref:configuration:configuration-schema-import-filter.adoc[Import Filter Configuration] documentation for more information. -TIP: Use the `logging-console-log-keys` in the xref:configuration/configuration-schema-bootstrap.adoc#lbl-schema[Bootstrap Schema] log key to troubleshoot import processing issues in the logs. +TIP: Use the `logging-console-log-keys` in the xref:configuration:configuration-schema-bootstrap.adoc#lbl-schema[Bootstrap Schema] log key to troubleshoot import processing issues in the logs. == Function Provision -Use the {rest-api-admin--xref--database-configuration} Admin Rest API endpoint xref:rest_api_admin.adoc#tag/Database-Configuration/operation/post_db-_config[POST /{db}/_config] to provision an import filter for a database using the `application/javascript` mime type. +Use the {rest-api-admin--xref--database-configuration} Admin Rest API endpoint xref:rest-api:rest_api_admin.adoc#tag/Database-Configuration/operation/post_db-_config[POST /{db}/_config] to provision an import filter for a database using the `application/javascript` mime type. If you are using legacy configuration then, you need to include it in your configuration file, see: {configuration-properties-legacy--xref--databases-import-filter}. @@ -37,7 +37,7 @@ NOTE: You need Couchbase Lite 3.1+ and Sync Gateway 3.1+ to use `custom` Scopes If you’re using Capella App Services or Sync Gateway releases that are older than version 3.1, you won’t be able to access `custom` Scopes and Collections. To use Couchbase Lite 3.1+ with these older versions, you can use the `default` Collection as a backup option. -The configuration settings described here are provisioned through the xref:rest-api/rest-api-admin.adoc[Database Configuration] endpoints. +The configuration settings described here are provisioned through the xref:rest-api:rest-api-admin.adoc[Database Configuration] endpoints. [source,JSON] ---- @@ -55,7 +55,7 @@ The configuration settings described here are provisioned through the xref:rest- } ---- -For more information, see xref:configuration/configuration-schema-database.adoc#_database[Sync Gateway Configuration Schema]. +For more information, see xref:configuration:configuration-schema-database.adoc#_database[Sync Gateway Configuration Schema]. [cols="2", options="header"] |=== @@ -76,4 +76,4 @@ For more information, see xref:configuration/configuration-schema-database.adoc# |=== -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/sync/sync-inter-syncgateway-conflict-resolution.adoc b/modules/sync/pages/sync-inter-syncgateway-conflict-resolution.adoc similarity index 54% rename from modules/ROOT/pages/sync/sync-inter-syncgateway-conflict-resolution.adoc rename to modules/sync/pages/sync-inter-syncgateway-conflict-resolution.adoc index ddb11ffdc..5210fd2a9 100644 --- a/modules/ROOT/pages/sync/sync-inter-syncgateway-conflict-resolution.adoc +++ b/modules/sync/pages/sync-inter-syncgateway-conflict-resolution.adoc @@ -1,24 +1,24 @@ = Enhanced Conflict Resolution -:page-aliases: learn/icr-conflict-resolution.adoc, sync-inter-syncgateway-conflict-resolution.adoc +:page-aliases: ROOT:learn/icr-conflict-resolution.adoc, ROOT:sync-inter-syncgateway-conflict-resolution.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: About conflict resolution in inter-Sync Gateway replication -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-topic-group: inter-syncgateway :param-related: {configuration-properties-legacy--xref} | {rest-api-admin--xref} :param-abstract: Introduces inter-Sync Gateway replication conflict resolution policies and behaviors -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] -include::partial$block-caveats.adoc[tags=sgr2-only] +include::ROOT:partial$block-caveats.adoc[tags=sgr2-only] -include::partial$incpg-icr-conflict.adoc[] +include::ROOT:partial$incpg-icr-conflict.adoc[] -include::partial$block-related-content-icr.adoc[] \ No newline at end of file +include::ROOT:partial$block-related-content-icr.adoc[] \ No newline at end of file diff --git a/modules/sync/pages/sync-inter-syncgateway-manage.adoc b/modules/sync/pages/sync-inter-syncgateway-manage.adoc new file mode 100644 index 000000000..0cc2247ca --- /dev/null +++ b/modules/sync/pages/sync-inter-syncgateway-manage.adoc @@ -0,0 +1,21 @@ += Manage Inter-Sync Gateway Replications +:page-aliases: ROOT:learn/icr-admin.adoc, ROOT:icr-admin.adoc, ROOT:sync-inter-syncgateway-manage.adoc +ifdef::show_edition[:page-edition: {release}] +ifdef::prerelease[:page-status: {prerelease}] +:page-role: +:description: Managing inter-Sync Gateway replications +:keywords: cloud edge sync replicate + +include::ROOT:partial$_set_page_context.adoc[] + + +:param-topic-group: inter-syncgateway +:param-related: {configuration-properties-legacy--xref} | {rest-api-admin--xref} +:param-abstract!: +include::ROOT:partial$_show_page_header_block.adoc[] + +include::ROOT:partial$block-caveats.adoc[tags=sgr2-only] + +include::ROOT:partial$incpg-icr-admin.adoc[tags=!in-this-section] + +include::ROOT:partial$block-related-content-icr.adoc[] diff --git a/modules/ROOT/pages/sync/sync-inter-syncgateway-monitor.adoc b/modules/sync/pages/sync-inter-syncgateway-monitor.adoc similarity index 52% rename from modules/ROOT/pages/sync/sync-inter-syncgateway-monitor.adoc rename to modules/sync/pages/sync-inter-syncgateway-monitor.adoc index b9a6d5db1..767b13dc1 100644 --- a/modules/ROOT/pages/sync/sync-inter-syncgateway-monitor.adoc +++ b/modules/sync/pages/sync-inter-syncgateway-monitor.adoc @@ -1,19 +1,19 @@ = Replication Monitoring and Statistics -:page-aliases: learn/icr-monitoring.adoc, icr-monitoring.adoc, sync-inter-syncgateway-monitor.adoc +:page-aliases: ROOT:learn/icr-monitoring.adoc, ROOT:icr-monitoring.adoc, ROOT:sync-inter-syncgateway-monitor.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: Monitoring inter-Sync Gateway replications -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-topic-group: inter-syncgateway :param-related: {configuration-properties-legacy--xref} | {rest-api-admin--xref} :param-abstract: This content covers the retrieval of status and statistical data relating to replication. -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] -include::partial$block-caveats.adoc[tags=sgr2-only] +include::ROOT:partial$block-caveats.adoc[tags=sgr2-only] -include::partial$incpg-icr-monitoring.adoc[tags=!in-this-section] +include::ROOT:partial$incpg-icr-monitoring.adoc[tags=!in-this-section] -include::partial$block-related-content-icr.adoc[] +include::ROOT:partial$block-related-content-icr.adoc[] diff --git a/modules/ROOT/pages/sync/sync-inter-syncgateway-overview.adoc b/modules/sync/pages/sync-inter-syncgateway-overview.adoc similarity index 93% rename from modules/ROOT/pages/sync/sync-inter-syncgateway-overview.adoc rename to modules/sync/pages/sync-inter-syncgateway-overview.adoc index 713849966..65dd7d326 100644 --- a/modules/ROOT/pages/sync/sync-inter-syncgateway-overview.adoc +++ b/modules/sync/pages/sync-inter-syncgateway-overview.adoc @@ -1,25 +1,25 @@ = Inter-Sync Gateway Replication -:page-aliases: learn/icr-sgreplicate.adoc, icr-sgreplicate.adoc, sync-inter-syncgateway-overview.adoc +:page-aliases: ROOT:learn/icr-sgreplicate.adoc, ROOT:icr-sgreplicate.adoc, ROOT:sync-inter-syncgateway-overview.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: :description: Use inter-Sync Gateway replication to keep clusters in different mobile data centers in sync. -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :param-topic-group: inter-syncgateway :param-related: {configuration-properties-legacy--xref} | {rest-api-admin--xref} :param-abstract: pass:q[_Inter-Sync Gateway_ replication supports resilient, secure, scalable bidirectional synchronization of data cloud-to-edge.] -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // Footnotes :fn-arch: footnote:arch[This architecture is also known as ship-to-shore or hub-and-spoke.] :fnref-arch: footnote:arch[] :fnxdcr: footnote:[If one-directional XDCR is used alongside Sync Gateway, then Sync Gateway cluster must be in read-only mode.] -include::partial$block-caveats.adoc[tags=sgr2-only] +include::ROOT:partial$block-caveats.adoc[tags=sgr2-only] == Introduction @@ -37,7 +37,7 @@ In the architecture diagram (<>), the replicator on the active [[icr-architecture]] .Inter-Sync Gateway Replication architecture -image::icr-replication-overview.svg[] +image::ROOT:icr-replication-overview.svg[] // end::intro-img[] // end::intro-full[] @@ -55,7 +55,7 @@ A typical architecture for this use cases is shown in <> [[icr-cloud-to-edge]] .Cloud-to-edge synchronization -image::icr-cloud-to-edge200712.svg[,600] +image::ROOT:icr-cloud-to-edge200712.svg[,600] === Active-to-active Mobile Synchronization @@ -70,7 +70,7 @@ Couchbase Server uses the Cross Data Center Replication API (xref:server:manage: [[icr-active-mobile]] .Active-to-active mobile synchronization -image::icr-active-mobile-sync200713.svg[,600] +image::ROOT:icr-active-mobile-sync200713.svg[,600] // end::use-cases[] @@ -135,7 +135,7 @@ _Related configuration elements_: {configuration-schema-database--xref--db-repl === Delta Sync -include::partial$block-caveats.adoc[tags=ee-only-feature] +include::ROOT:partial$block-caveats.adoc[tags=ee-only-feature] With delta-sync enabled on the replication and both databases involved, only the changed data items are transferred. @@ -157,7 +157,7 @@ Inter-Sync Gateway replication supports named collections, including: * Limit replication to specific collections. * Map local collections to differently named remote collections. -For detailed configuration of collections parameters (`collections_enabled`, `collections_local`, `collections_remote`), see xref:configuration/configuration-schema-isgr.adoc#replication[Run Inter-Sync Gateway Replication Configuration Schema]. +For detailed configuration of collections parameters (`collections_enabled`, `collections_local`, `collections_remote`), see xref:configuration:configuration-schema-isgr.adoc#replication[Run Inter-Sync Gateway Replication Configuration Schema]. ==== Collection Mapping @@ -232,14 +232,14 @@ _Related replication definition elements_: {configuration-schema-database--xref == High Availability -include::partial$incpg-icr-availability.adoc[leveloffset=+1] +include::ROOT:partial$incpg-icr-availability.adoc[leveloffset=+1] == Conflict Resolution -include::partial$incpg-icr-conflict.adoc[tags=overview-full, leveloffset=+1] +include::ROOT:partial$incpg-icr-conflict.adoc[tags=overview-full, leveloffset=+1] -include::partial$block-related-content-icr.adoc[] +include::ROOT:partial$block-related-content-icr.adoc[] diff --git a/modules/sync/pages/sync-inter-syncgateway-run.adoc b/modules/sync/pages/sync-inter-syncgateway-run.adoc new file mode 100644 index 000000000..48aebc3dd --- /dev/null +++ b/modules/sync/pages/sync-inter-syncgateway-run.adoc @@ -0,0 +1,21 @@ += Initialize Inter-Sync Gateway Replications +:page-aliases: ROOT:running-replications.adoc, ROOT:learn/icr-running.adoc, ROOT:icr-running.adoc, ROOT:sync-inter-syncgateway-run.adoc +ifdef::show_edition[:page-edition: {release}] +ifdef::prerelease[:page-status: {prerelease}] +:page-role: +:description: Initializing and running inter-Sync Gateway replication + +include::ROOT:partial$_set_page_context.adoc[] + +:param-topic-group: inter-syncgateway +:param-related: {configuration-properties-legacy--xref} | {rest-api-admin--xref} +:param-abstract!: +include::ROOT:partial$_show_page_header_block.adoc[] + +include::ROOT:partial$static_restapi/css.adoc[] + +include::ROOT:partial$block-caveats.adoc[tags=sgr2-only] + +include::ROOT:partial$incpg-icr-initialization.adoc[tags=!in-this-section] + +include::ROOT:partial$block-related-content-icr.adoc[] diff --git a/modules/ROOT/pages/sync/sync-using-app.adoc b/modules/sync/pages/sync-using-app.adoc similarity index 81% rename from modules/ROOT/pages/sync/sync-using-app.adoc rename to modules/sync/pages/sync-using-app.adoc index f613f47ed..bd4e12770 100644 --- a/modules/ROOT/pages/sync/sync-using-app.adoc +++ b/modules/sync/pages/sync-using-app.adoc @@ -1,5 +1,5 @@ = Sync with Couchbase Lite -:page-aliases: sync-from-client.adoc, sync-using-app.adoc +:page-aliases: ROOT:sync-from-client.adoc, ROOT:sync-using-app.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-role: -toc @@ -7,14 +7,14 @@ ifdef::prerelease[:page-status: {prerelease}] :keywords: sync gateway, replication, sync, synchronization, edge, cloud :pageOriginRel: "sg=1.5, Cbs=5.0)_" -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] // BEGIN -- Page Heading :topic-group: sync :param-related!: :param-abstract!: -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] // END -- Page Heading @@ -24,7 +24,7 @@ Couchbase Lite client applications use a Replicator process to synchronize their [#fig-sync-diag] .Sync from Cloud/Server to Edge -image::svr-sgw-cbl.png[] +image::ROOT:svr-sgw-cbl.png[] Pull Replication:: @@ -40,7 +40,7 @@ For more on how to build Couchbase Lite applications that use Sync Gateway repli :param-page: replication :param-path!: :param-bookmark!: -include::partial$blocklinks-cbl.adoc[] +include::ROOT:partial$blocklinks-cbl.adoc[] -include::partial$block-related-content-api.adoc[] +include::ROOT:partial$block-related-content-api.adoc[] diff --git a/modules/ROOT/pages/sync/sync-with-couchbase-server.adoc b/modules/sync/pages/sync-with-couchbase-server.adoc similarity index 94% rename from modules/ROOT/pages/sync/sync-with-couchbase-server.adoc rename to modules/sync/pages/sync-with-couchbase-server.adoc index 77905e915..0c8e010b0 100644 --- a/modules/ROOT/pages/sync/sync-with-couchbase-server.adoc +++ b/modules/sync/pages/sync-with-couchbase-server.adoc @@ -1,5 +1,5 @@ = Sync with Couchbase Server -:page-aliases: shared-bucket-access.adoc, sync-with-server.adoc, sync-with-couchbase-server.adoc +:page-aliases: ROOT:shared-bucket-access.adoc, ROOT:sync-with-server.adoc, ROOT:sync-with-couchbase-server.adoc ifdef::show_edition[:page-edition: {release}] ifdef::prerelease[:page-status: {prerelease}] :page-toclevels: 2@ @@ -10,21 +10,21 @@ ifdef::prerelease[:page-status: {prerelease}] :pageOriginRel: "sg=1.5, Cbs=5.0)_" :imagesdir: ../assets/images -include::partial$_set_page_context.adoc[] +include::ROOT:partial$_set_page_context.adoc[] :topic-group: Sync :param-related: {sync-using-app--xref} | {sync-inter-syncgateway-overview--xref} | {delta-sync--xref} | {resync--xref} :param-abstract: This content explains how Sync Gateway synchronizes document changes made through Couchbase SDKs and {sqlpp} queries. -include::partial$_show_page_header_block.adoc[] +include::ROOT:partial$_show_page_header_block.adoc[] -include::partial$block-standard-footnotes.adoc[tags=sgw1x5;cbs5x0] +include::ROOT:partial$block-standard-footnotes.adoc[tags=sgw1x5;cbs5x0] :fn-sgw: footnote:fn-sgw[Prior to Release 2.5, Server 5.0 all writes had to go through Sync Gateway, or had to use bucket shadowing to ensure that the security and replication metadata needed by mobile applications was preserved.] // :fn-sgw-ref: footnote:fn-sgw[] :enable-sba-config-item: {configuration-schema-database--pfx}#enable_shared_bucket_access[$dbname.enable_shared_bucket_access] :xattr--page: xref:server:learn:data/extended-attributes-fundamentals.adoc[Extended Attributes (XATTR)] -include::partial$block-caveats.adoc[tags="cbs6.0ke-xattrs"] +include::ROOT:partial$block-caveats.adoc[tags="cbs6.0ke-xattrs"] == Introduction @@ -45,7 +45,7 @@ You can configure both these properties using the Admin Rest API {configuration- [#sgw-paths] .Sync Gateway Data Access Paths -image::shared-bucket-access.png[] +image::ROOT:shared-bucket-access.png[] [#sba-feature] @@ -114,10 +114,10 @@ https://blog.couchbase.com/store-sync-binary-data-attachments-blobs-couchbase-mo Couchbase Lite apps seamlessly handle blobs and attachments, see the appropriate platform examples here: :param-page: blob -include::partial$blocklinks-cbl.adoc[] +include::ROOT:partial$blocklinks-cbl.adoc[] .Using a WebApp -Attachments can be accessed through {sgw-t}'s REST API using the xref:rest_api_public.adoc#tag/Document-Attachment/operation/get_keyspace-docid-attach[+/{keyspace}/{docid}/{attach}+] endpoint. +Attachments can be accessed through {sgw-t}'s REST API using the xref:rest-api:rest_api_public.adoc#tag/Document-Attachment/operation/get_keyspace-docid-attach[+/{keyspace}/{docid}/{attach}+] endpoint. === Tombstone Revisions @@ -180,7 +180,7 @@ You can enable it without bringing down the entire {sgw-t} cluster -- see <