https://github.com/jamsocket/plane

A distributed system for running WebSocket services at scale.
https://github.com/jamsocket/plane

rust websocket

Last synced: 28 days ago
JSON representation

A distributed system for running WebSocket services at scale.

• Host: GitHub
• URL: https://github.com/jamsocket/plane
• Owner: jamsocket
• License: mit
• Created: 2021-11-10T18:52:39.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-15T19:07:19.000Z (6 months ago)
• Last Synced: 2024-05-17T06:49:54.241Z (6 months ago)
• Topics: rust, websocket
• Language: Rust
• Homepage: https://plane.dev
• Size: 3.49 MB
• Stars: 1,600
• Watchers: 15
• Forks: 37
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    

        

    

    

        

    



[![Docker image](https://img.shields.io/docker/v/plane/plane)](https://hub.docker.com/r/plane/plane/tags)

[![Build Docker Image](https://github.com/jamsocket/plane/actions/workflows/build-image.yml/badge.svg)](https://github.com/jamsocket/plane/actions/workflows/build-image.yml)

[![Tests](https://github.com/jamsocket/plane/actions/workflows/tests.yml/badge.svg)](https://github.com/jamsocket/plane/actions/workflows/tests.yml)

[![Chat on Discord](https://img.shields.io/discord/939641163265232947?color=404eed&label=discord)](https://discord.gg/N5sEpsuhh9)

[![crates.io](https://img.shields.io/crates/v/plane.svg)](https://crates.io/crates/plane)

Plane is a distributed system for **running stateful WebSocket backends at scale**. Plane is heavily inspired by [Figma’s mulitplayer infrastructure](https://www.figma.com/blog/rust-in-production-at-figma/), which dynamically spawns a process for each active document.

Use cases include:

- Scaling up [authoritative multiplayer backends](https://jamsocket.com/blog/you-might-not-need-a-crdt).

- Running isolated code environments (like REPLs, code notebooks, and LLM agent sandboxes).

- Data-intensive applications that need a dedicated high-RAM process for each active user session.

## How Plane works

You can think of Plane as a distributed hashmap, but instead of storing data, it stores running processes. When you ask Plane for the process associated with a key (via an HTTP API), it either returns a URL to an existing process, or starts a new process and returns a URL to that.

Plane will keep the process running for as long as there is an open connection (usually a WebSocket connection) to it. Once all connections to a process have been closed for some time threshold, Plane will shut down the process.

Plane guarantees that only one process will be running for each key at any given time, allowing that process to act as an authoritative source of document state for as long as it is running.

### Architecture

Read more about [Plane’s architecture](https://plane.dev/concepts/architecture).

[![Architecture diagram of Plane](./docs/public/arch-diagram.svg)](https://plane.dev/concepts/architecture)

## Learn more

- Read the [quickstart guide](https://plane.dev/quickstart-guide)

- Learn about [Plane concepts](https://plane.dev/concepts/session-backends)

- See instructions for [building and developing Plane locally](https://plane.dev/developing)

- Read about [production deployment](https://plane.dev/deploy-to-prod)