yorkieteam/yorkie

Yorkie Docker镜像文档

镜像概述

什么是Yorkie？

Yorkie是一个开源文档存储，专为构建协作编辑应用而设计。它主要由三个核心组件构成：Client（客户端）、Document（文档）和Agent（代理）。

 Client "A" (Go)                 Agent                        MemDB or MongoDB
┌───────────────────┐           ┌────────────────────────┐   ┌───────────┐
│  Document "D-1"   │◄─Changes─►│  Collection "C-1"      │   │ Changes   │
│  { a: 1, b: {} }  │           │ ┌───────────────────┐  │◄─►│ Snapshots │
└───────────────────┘           │ │  Document "D-1"   │  │   └───────────┘
 Client "B" (JS)                │ │  { a: 2, b: {} }  │  │
┌───────────────────┐           │ │                   │  │
│  Document "D-1"   │◄─Changes─►│ │  Document "D-2"   │  │
│  { a: 2, b: {} }  │           │ │  { a: 3, b: {} }  │  │
└───────────────────┘           │ └───────────────────┘  │
 Client "C" (Admin)             │                        │
┌────────────────────┐          └────────────────────────┘
│  Query "Q-1"       │              ▲
│ db[c-1].find({a:2})├───DB Query───┘
└────────────────────┘

核心功能特性

• 开源文档存储系统，专注于协作编辑场景
• 支持多客户端（如Go、JS客户端）实时同步文档变更
• 基于变更（Changes）和快照（Snapshots）机制管理文档版本
• 提供文档集合（Collection）管理和查询能力
• 轻量级架构，易于集成到各类协作应用中

适用场景

• 实时协作编辑工具开发
• 多人协作文档系统
• 团队共享编辑平台
• 需要同步多用户操作的协同应用

系统要求

• Docker Engine 版本需 ≥ 1.10.0
• 推荐使用 Docker Compose，版本需 ≥ 1.6.0

镜像获取与使用

获取镜像

推荐通过 Docker Hub Registry 获取预构建的 Yorkie 镜像。

指定版本获取

如需使用特定版本，可拉取带有版本标签的镜像。可在 Docker Hub Registry 中查看所有可用版本。

bash
$ docker pull docker.xuanyuan.run/yorkieteam/yorkie:[TAG]

获取最新开发版本

latest 标签镜像用于开发环境，每当代码合并到 https://github.com/yorkie-team/yorkie 时自动构建。

bash
$ docker pull docker.xuanyuan.run/yorkieteam/yorkie:latest

基本使用方法

拉取镜像后，可通过标准 Docker 命令运行 Yorkie 服务。具体运行参数可根据实际需求进行配置，典型的启动命令如下：

bash
$ docker run -d --name yorkie yorkieteam/yorkie:latest

注意事项

• latest 标签镜像用于开发目的，生产环境建议使用特定版本标签以确保稳定性
• 如需持久化数据或自定义配置，可通过挂载卷或设置环境变量实现（具体配置参数请参考官方文档）
• 大规模部署时，建议结合 Docker Compose 或 Kubernetes 进行编排管理