diff --git a/modules/ROOT/pages/_partials/landing-page-tiles-layout.adoc b/modules/ROOT/pages/_partials/landing-page-tiles-layout.adoc new file mode 100644 index 00000000..e389eb26 --- /dev/null +++ b/modules/ROOT/pages/_partials/landing-page-tiles-layout.adoc @@ -0,0 +1,21 @@ +:page-role: tiles -toc +:!sectids: + +// Pass through HTML styles for this page. +ifdef::basebackend-html[] +++++ + +++++ +endif::[] diff --git a/modules/ROOT/pages/configuration-schema-db-security.adoc b/modules/ROOT/pages/configuration-schema-db-security.adoc index 2ad79023..7fd99d4b 100644 --- a/modules/ROOT/pages/configuration-schema-db-security.adoc +++ b/modules/ROOT/pages/configuration-schema-db-security.adoc @@ -48,11 +48,15 @@ include::partial$static_restapi/admin/index.adoc[tags=put_db-_role-name-response === Example + + ==== [{tabs}] ===== + + Curl:: + -- diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index ac0f8e85..db54a279 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -32,15 +32,18 @@ include::partial$_set_page_context.adoc[]
++++ -[.column] -====== {empty} -[.content] -include::page$introduction.adoc[tags=intro] - -[.column] -====== {empty} -[.media-left] -image::cbm-architecture.png[,300] +Sync Gateway is a secure, high-performance gateway designed for cloud-to-edge data synchronization. +It serves as the synchronization server in a Couchbase Mobile deployment, enabling mobile, web, and IoT applications to view and sync data with Couchbase Server. + +// [.column] +// ====== {empty} +// [.content] +// include::page$introduction.adoc[tags=intro] + +// [.column] +// ====== {empty} +// [.media-left] +// image::cbm-architecture.png[,300] ++++
diff --git a/modules/ROOT/pages/introduction.adoc b/modules/ROOT/pages/introduction.adoc index 6e08bcbf..40712538 100644 --- a/modules/ROOT/pages/introduction.adoc +++ b/modules/ROOT/pages/introduction.adoc @@ -1,55 +1,139 @@ -= Introduction -ifdef::show_edition[:page-edition: {release}] -ifdef::prerelease[:page-status: {prerelease}] -:page-role: -:page-partial: -:description: pass:q[A short introduction to _Couchbase's Sync Gateway_ and how to get started using it.] += Sync Gateway +:navtitle: Sync Gateway +:description: Sync Gateway is a secure, high-performance gateway designed for cloud-to-edge data synchronization. +// Handles boilerplate logic for landing page tiles layout +:page-role: tiles -toc +:!sectids: +Sync Gateway is a secure, high-performance gateway designed for cloud-to-edge data synchronization. It serves as the synchronization server in a Couchbase Mobile deployment, enabling mobile, web, and IoT applications to view and sync data with Couchbase Server. -include::partial$_set_page_context.adoc[] +You can use Sync Gateway in conjunction with Couchbase Lite for full bi-directional sync between edge devices and the cloud. It provides fine-grained access control, RESTful API, and secure sync capabilities. +== Why Use Sync Gateway? -// BEGIN -- Page Heading -:topic-group: Start Here! -:param-abstract: pass:q[This is *Step 1* in Sync Gateway's Start Here! topic group.] -:param-related: {get-started-prepare--xref} | {get-started-install--xref} | {get-started-verify-install--xref} -include::partial$_show_page_header_block.adoc[] -// END -- Page Heading +* Bi-directional synchronization: Sync data between Couchbase Lite clients and Couchbase Server with real-time updates. +* Secure access control: Supports RBAC, channels, and sync functions. -== Getting Started with Sync Gateway +* RESTful API: Public, Admin and Metric REST API interfaces for data and configuration access. -:param-page: {page-relative-src-path} -include::partial$topic-group-get-started.adoc[] +* Scalable architecture: Designed for high-throughput, cloud-to-edge synchronization. -// tag::intro[] -Sync Gateway is the synchronization server in a Couchbase Mobile deployment. -It is designed to provide data synchronization for large-scale interactive web, mobile, and IoT applications -// end::intro[] --- see: <>. +== Key Capabilities -[#fig-mobile-server] -.Couchbase Mobile -- Deployment Architecture -image::cbm-architecture.png[] +* Fine-grained data distribution using channels for efficient synchronization. -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. +* Sync Function support: Customizable business logic for validation, transformation, and access control. -You can read more about the Data Synchronization process in {sync-with-couchbase-server--xref}. -Some of its most central, and commonly used features, are those used to ensure secure **Access Control**. +* Role-Based Access Control. -Sync Gateway assures secure access control using: +* RESTful API: Public, Admin and Metric REST API interfaces for data and configuration access. -* **User authentication**, which ensures that only authorized users can connect to Sync Gateway. -For more information see the -{users--xref}, {roles--xref} and {authentication-users--xref} content. +* Integration with Couchbase Lite and Couchbase Server. -* *Data Routing*, which ensures that authorized users can only access documents in those {channels--xref} assigned to them and only in accordance with their assigned privileges. -You can set those privileges to confer {read-access--xref} and-or {write-access--xref} as required. +* Supports peer-to-peer, cloud, and hybrid sync topologies. -The business logic behind the validation and authorization of document access is provided by the customizable {sync-function--xref}. +// We need to go up one heading level to break the previous h2 div (with flex-basis 50%). += {empty} +[.full-width-tile] +TIP: For more information about the latest changes to Sync Gateway, see xref:whatsnew.adoc[]. -// BEGIN -- Page Footer -include::partial$block-related-content-deploy.adoc[] -// END -- Page Footer +== Get Started + +Get started with Sync Gateway, from preparing your environment to installing and verifying your installation. + +* xref:get-started-prepare.adoc[Prepare your environment] +* xref:get-started-install.adoc[Install Sync Gateway] +* xref: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[] + +== Configuration + +Learn how to configure Sync Gateway for cloud to edge synchronization including bootstrap, database settings, security, and more. + +* xref:configuration-schema-bootstrap.adoc[] +* xref:configuration-schema-database.adoc[] +* xref:configuration-schema-db-security.adoc[] +* xref:configuration-schema-access-control.adoc[] +* xref:configuration-schema-import-filter.adoc[] +* xref:configuration-schema-isgr.adoc[] +* xref:configuration-javascript-functions.adoc[] +* xref:configuration-environment-variables.adoc[] + +== Security + +Implement comprehensive security measures to protect your data and control access to Sync Gateway. + +* xref:secure-sgw-access.adoc[] +* xref:authentication-users.adoc[] +* xref:authentication-certs.adoc[] +* xref:audit-logging.adoc[] + +== Access Control + +Configure fine-grained access control with users, roles, channels, and sync functions. + +* xref:access-control-concepts.adoc[] +* xref:sync-function.adoc[] +* xref:access-contrlol-how.adoc[How to] +* xref:auto-purge-channel-access-revocation.adoc[] + +== REST API + +Interact with Sync Gateway programmatically using comprehensive REST API interfaces. + +* xref:rest-api-access.adoc[] +* xref:rest-api-admin.adoc[] +* xref:rest-api-metrics.adoc[] +* xref:rest-api.adoc[] +* xref:rest-api-access-rbac-roles.adoc[] + +== Sync + +Synchronize data between Sync Gateway and your applications, servers, and other Sync Gateway instances. + +* xref:sync-with-server.adoc[] +* xref:sync-using-app.adoc[] +* xref:inter-syncgateway-overview.adoc[] +* xref:delta-sync.adoc[] +* xref:import-processing.adoc[] + +== Manage + +Perform administrative and operational tasks to maintain and monitor Sync Gateway. + +* xref:revisions.adoc[] +* xref:managing-tombstones.adoc[] +* xref:resync.adoc[] +* xref:stats-monitoring.adoc[] +* xref:database-offline.adoc[] +* xref:logging.adoc[] + +== Deploy + +Deploy Sync Gateway in production environments with scalability and reliability considerations. + +* xref:command-line-options.adoc[] +* xref:load-balancer.adoc[] +* xref:webhooks.adoc[] +* xref:stats-prometheus.adoc[] +* xref:indexing.adoc[] +* xref:deploy-cluster-to-kubernetes.adoc[] + +== Server Compatibility + +Understand Sync Gateway compatibility with Couchbase Server features and services. + +* xref:server-compatibility-buckets.adoc[Buckets] +* xref:server-compatibility-collections.adoc[Collections] +* xref:server-compatibility-eventing.adoc[Eventing] +* xref:server-compatibility-transactions.adoc[Transactions] +* xref:server-compatibility-xdcr.adoc[XDCR] +* xref:server-compatibility-backups.adoc[Backup and Restore] \ No newline at end of file