Plane分布式系统安装与配置指南

Plane分布式系统安装与配置指南

plane A distributed system for running WebSocket services at scale. 项目地址: https://gitcode.com/gh_mirrors/plane8/plane

1. 项目基础介绍

Plane 是一个用于运行状态ful WebSocket后端的分布式系统，它可以动态地为每个活动文档生成一个进程。这个系统受到 Figma 的多玩家基础设施的启发，适用于以下场景：

• 扩展权威的多玩家后端
• 运行隔离的代码环境（如REPLs、代码笔记本和LLM代理沙盒）
• 需要为每个活动用户会话分配专用高RAM进程的数据密集型应用

Plane 的工作原理类似于分布式哈希表，但存储的不是数据，而是运行中的进程。当你通过HTTP API请求与某个键相关的进程时，Plane 会返回一个现有进程的URL，或者启动一个新的进程并返回其URL。只要有一个开放的连接（通常是WebSocket连接），Plane 会保持该进程运行。一旦所有连接关闭并超过一定时间阈值，Plane 将关闭该进程。

2. 项目使用的关键技术和框架

• 编程语言: Rust
• WebSocket: 用于实时通信
• HTTP API: 用于进程管理
• 分布式系统: 实现进程的动态分配和管理

3. 项目安装和配置的准备工作及详细步骤

准备工作

• 确保你的操作系统支持Rust编译器。

• 安装Rust编译器和Cargo包管理器。你可以通过官方文档 rustup.rs 来安装它们。

• 克隆Plane项目到本地：

  git clone https://github.com/jamsocket/plane.git
  cd plane
  

安装步骤

步骤1：安装依赖

在项目根目录下，运行以下命令来安装项目依赖：

cargo install --all

这个命令会安装项目中所有依赖的库和工具。

步骤2：构建项目

使用Cargo构建项目：

cargo build

这个命令会编译项目中的所有Rust代码。

步骤3：运行项目

构建完成后，你可以运行项目来启动Plane服务：

cargo run

这个命令会启动Plane服务，默认情况下，它会在本地开发环境中运行。

步骤4：配置项目

Plane 的配置主要通过环境变量或配置文件进行。你可以创建一个名为 plane.toml 的配置文件，并放置在项目根目录中。以下是一个基本的配置文件示例：

[plane]
# 监听地址
address = "127.0.0.1:8080"

# 进程管理器配置
[plane.process_manager]
# 进程超时时间（秒）
timeout = 300

# 日志配置
[plane.logging]
# 日志级别
level = "info"

你可以根据需要调整这些配置项。

步骤5：部署项目

如果你的环境已经准备好，你可以将Plane部署到生产环境。这通常涉及以下步骤：

• 使用Docker或其他容器化工具来打包应用程序。
• 将容器部署到服务器上。
• 配置负载均衡器和反向代理（如Nginx或HAProxy）。

确保在部署前阅读官方的生产部署指南。

以上就是 Plane 分布式系统的安装和配置指南。遵循这些步骤，你可以在本地或生产环境中成功部署 Plane。

plane A distributed system for running WebSocket services at scale. 项目地址: https://gitcode.com/gh_mirrors/plane8/plane