y-redis 项目使用教程

y-redis 项目使用教程

y-redis Redis persistence layer for Yjs 项目地址: https://gitcode.com/gh_mirrors/yr/y-redis

1. 项目介绍

y-redis 是一个为 y-websocket 提供的替代后端，使用 Redis 实现可扩展性。该项目旨在通过 Redis 实例和存储提供者（如 S3 或兼容 Postgres 的数据库）来处理实时协作应用中的文档更新。y-redis 具有以下特点：

• 内存高效：服务器不维护内存中的 Y.Doc，而是通过 Redis 流式传输更新。Yjs 文档仅在初始同步时加载到内存中。
• 可扩展：可以启动任意数量的 y-redis 实例来处理客户端数量的波动，无需协调。
• 数据库无关：可以将文档持久化到兼容 S3 的后端或 Postgres 中，或实现自定义存储提供者。

2. 项目快速启动

2.1 使用 Docker Compose 快速启动

以下是使用 Docker Compose 快速启动 y-redis 的步骤：

1. 克隆项目：

   git clone https://github.com/yjs/y-redis.git
   cd y-redis
   

2. 安装依赖：

   npm install
   

3. 设置环境变量：

   cp .env.docker.template .env
   npx ecdsa-generate-keypair --name auth >> .env
   

4. 启动 Docker Compose：

   cd /demos/auth-express
   docker-compose up
   

5. 访问应用： 打开浏览器并访问 http://localhost:5173。

2.2 手动启动组件

如果不想使用 Docker Compose，可以手动启动各个组件：

1. 启动 Redis 实例：

   docker run -p 6379:6379 redis
   

2. 启动 S3 实例（使用 Minio）：

   docker run -p 9000:9000 -p 9001:9001 quay.io/minio/minio server /data --console-address ":9001"
   

3. 启动 y-redis 服务器和 worker：

   npm run start:server
   npm run start:worker
   

4. 启动 Express 服务器：

   cd demos/auth-express
   npm install
   npm start
   

5. 访问应用： 打开浏览器并访问 http://localhost:5173。

3. 应用案例和最佳实践

3.1 实时协作编辑器

y-redis 可以用于构建实时协作编辑器，如 Google Docs 的替代品。通过 Redis 的高效缓存和分布式特性，可以实现多个用户同时编辑同一文档，并实时同步更新。

3.2 多人游戏

在多人游戏中，y-redis 可以用于同步玩家状态和游戏数据。通过 Redis 的快速读写能力，可以确保所有玩家的状态在游戏中保持一致。

3.3 分布式任务队列

y-redis 的 worker 组件可以用于构建分布式任务队列，将任务分发到多个 worker 节点上执行，并通过 Redis 进行任务状态的同步和持久化。

4. 典型生态项目

4.1 y-websocket

y-websocket 是 y-redis 的主要前端组件，负责处理客户端与服务器之间的 WebSocket 连接，并实时同步文档更新。

4.2 Redis

Redis 是 y-redis 的核心依赖，用于缓存和分布式更新。Redis 的高性能和可扩展性使得 y-redis 能够处理大规模的实时协作应用。

4.3 Minio

Minio 是一个开源的 S3 兼容对象存储服务，可以作为 y-redis 的持久化存储后端。Minio 提供了简单易用的 API，适合用于开发和测试环境。

通过以上模块的介绍，您可以快速了解并上手 y-redis 项目，并将其应用于各种实时协作场景中。

y-redis Redis persistence layer for Yjs 项目地址: https://gitcode.com/gh_mirrors/yr/y-redis