Endpoints

Tell your nodes and clients where the Rivet control plane is, with the namespace and token in one URL.

Local development

No configuration is needed. RivetKit runs a local control plane on your machine.

Production

Private endpoint

The private endpoint tells your nodes and backend where the control plane is. It carries a secret token, so keep it server-side.

RIVET_ENDPOINT=https://my-namespace:<rivet-token>@rivet.example.com

import { actor, setup } from "rivetkit";

const myActor = actor({
  state: {},
  actions: {}
});

const registry = setup({
  use: { myActor },
  endpoint: "https://my-namespace:<rivet-token>@rivet.example.com",
});

URL auth syntax

Endpoint URLs carry the namespace and token:

https://namespace:token@host/path

This is the recommended form. Alternatively, set them separately:

RIVET_ENDPOINT=https://rivet.example.com
RIVET_NAMESPACE=my-namespace
RIVET_TOKEN=<rivet-token>

On a self-hosted control plane, use your namespace slug and your Rivet token, the auth.admin_token value from the control plane config. For the default namespace: https://default:<rivet-token>@rivet.example.com.

Reference