Docs

Guides for the people who run RIM, build clients and plugins for it, use it, and work on it. Rendered from the server and client repositories at the commits named below.

Operators

Running a RIM server: installing it with Docker Compose, upgrading and backing it up, watching it, switching features off, and running a public relay.

• Self-hosting a RIM server
• Transactional Email
• Audit retention
• Background jobs
• A closed company server
• Instance features
• Metrics
• Public relay runbook
• Release checklist
• Upgrading a server
• Server identity and server-to-server traffic
• The relay

Client authors

Talking to a RIM server from your own client: the HTTP and GraphQL contract, sessions and CSRF, pagination, messaging, search and the change feed.

• Talking to a server over HTTP
• Pagination Contract
• Messaging Contract
• Message Search (Full-Text Search)
• Message Change Feed

Plugin authors

Extending the client: what a plugin is, the capabilities it asks for, a first plugin step by step, the TypeScript SDK and how it is published, the rim-plugin.json manifest, web plugins in a sandboxed frame, the desktop host and its example plugins, and signed workspace plugins.

• Plugin Model
• Capability And Security Model
• Your first plugin
• @rim-platform/plugin-sdk
• The plugin manifest
• Web plugins
• Workspace plugins
• Plugin chat methods (rim.chat.*)
• Local Plugin Host
• Hello World Plugin
• TypeScript template plugin
• Publishing the plugin SDK

Using RIM

The desktop and web client: getting started from a fresh install to a first conversation, commands, keybinds, macros and pipelines, the AI agent, installing it and signing in, building it, the keyboard, plugins, keys and recovery, linking a device, encrypted conversations, relays and the local message cache.

• Getting started
• Commands and automation
• The AI agent
• Installing RIM
• RIM client
• Keyboard
• Search UI
• In-app updates
• Version skew between client and server
• Plugins
• Identity key backup (desktop)
• Device linking (desktop)
• The web app as a linked device
• End-to-end encrypted DMs and groups on the desktop
• End-to-end encrypted DMs and groups in the web app
• Secret vault
• Local message cache
• Relays: the client

Project

Where RIM is heading and how it is built: the vision, the server architecture and the design models, how to contribute, security with its overview and threat model, and the client's internals and branding.

• RIM — Product Vision
• Architecture
• Command Model
• Keybind Model
• Context Model
• Contributing
• Contributor Covenant Code of Conduct
• Changelog
• Security overview
• Security policy
• Outside cryptographic review: brief for Stages 3 and 4
• Audit Log Access Matrix
• RIM Desktop UI Shell
• Error boundaries
• ESLint + Prettier
• rim_mls
• Branding