Skip to content

Deployment

Running Record Store somewhere real.

The shape of a deployment

flowchart TB
    subgraph public [Public]
        S["S3 API :7600<br/>applications, embeds"]
        C["Console :7602<br/>administrators, share links"]
    end
    subgraph private [Private]
        M["Management API :7601<br/>CLI, console backend, metrics"]
    end
    C --> M

The single most important deployment decision: 7600 and 7602 may face the internet; 7601 must not. The management API is unrestricted administrative access. See Ports.

Before you start

Have these ready:

  • A data directory on durable storage, backed up
  • Root credentials, a credential master key, and a management system token
  • A plan for TLS in front of the public ports
  • Somewhere to keep the master key that is not the data directory

The master key cannot be rotated. Losing it means losing every stored credential and, if encryption is enabled, every object. Back it up first, not later.