Yorkie

If you want to update this page or add new content, please submit a pull request to the Homepage.

Configuration

This section covers configuration and integration topics for building production-ready applications with Yorkie. These guides help you design your architecture, secure your application, and configure project-level settings.

Topics

  • Architecture Patterns: Explore recommended architectural patterns for integrating Yorkie with your existing systems
  • Security: Configure allowed origins and Auth Webhooks to secure your Yorkie applications
  • Event Webhook: Receive notifications when specific events occur in your Yorkie documents
  • Revisions: Implement version control with snapshots, history browsing, and restore functionality
  • Resources: Configure project-level settings for document limits, snapshots, and lifecycle behavior
  • Projects: Organize multiple applications with project-based isolation, API keys, and per-project configuration

Prerequisites

Before exploring these topics, ensure you have:

  1. Completed the Getting Started guide
  2. Built at least one application using Yorkie SDKs
  3. Understood basic concepts like Client, Document, and Channel
  4. Reviewed key terms in the Glossary