Back to Rivet

Registry Configuration

website/src/content/docs/general/registry-configuration.mdx

2.2.12.4 KB
Original Source

import RegistryConfigSchema from "@/components/docs/RegistryConfigSchemaClient.astro";

Example Configurations

Basic Setup

typescript
import { setup, actor } from "rivetkit";

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

const registry = setup({
  use: { myActor },
});

Connecting to Rivet Engine

<CodeGroup>
typescript
import { setup, actor } from "rivetkit";

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

// Reads from RIVET_ENDPOINT, RIVET_TOKEN, and RIVET_NAMESPACE
const registry = setup({
  use: { myActor },
});
typescript
import { setup, actor } from "rivetkit";

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

const registry = setup({
  use: { myActor },
  endpoint: "https://api.rivet.dev",
  token: process.env.RIVET_TOKEN,
  namespace: "production",
});
</CodeGroup>

Starting Your App

After configuring your registry, start it:

<CodeGroup>
typescript
import { actor, setup } from "rivetkit";

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

registry.start();
typescript
import { actor, setup } from "rivetkit";

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

export default registry.serve();
typescript
import { Hono } from "hono";
import { actor, setup } from "rivetkit";

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

const app = new Hono();
app.all("/api/rivet/*", (c) => registry.handler(c.req.raw));

export default app;
typescript
import { actor, setup } from "rivetkit";

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

registry.startRunner();
</CodeGroup>

See Runtime Modes for details on when to use each mode.

Environment Variables

Many configuration options can be set via environment variables. See Environment Variables for a complete reference.

Configuration Reference

<RegistryConfigSchema />