Skip to content
rifleDB
Docs: Overview

Docs

How to connect an app, run the server, and decide who may read and write what. New here? The quickstart takes six steps on your own machine.

Get started

  • Quickstart

    Run a server, connect a React app, read the same value with curl and lock a folder to its owner, in six steps.

  • Setup & download

    Install the SDK from npm, declare your folders, and run the server with Node.js and Redis or with Docker Compose.

  • SDK guide

    The rifledb SDK in a React single-page app and in Next.js: hooks, server rendering with live hydration, service keys and REST.

Reference

  • Access control

    Device keys; public, private and secret folders; sharing with grants, folder keys and invites; passkey step-up and admins.

  • Protocol

    The socket messages and the REST API on the same paths: paths and values, signed requests, errors and rate-limit scopes.

  • Operations

    Running the server: environment variables, reverse proxies, rate limits, Redis durability and backups, metrics and logs.

  • Benchmarks

    The performance suite: micro benchmarks and workload scenarios, how they measure, and how two runs are compared.

What rifleDB is not. Secret folders are access-controlled, not end-to-end encrypted: the server can read every value. Version 1 is a single server process with Redis behind it, without clustering.