Agent index (llms.txt) — fetch this first, then the page it names.

Choose your path

Pick the journey that matches what you want to do. Each one is a reading order, not a menu: follow it top to bottom. If you just want to join the network with machines of your own, read Get started and skip the rest.

I want to build an app on a cluster

You already have a gateway URL (a cluster someone runs, or your own).

  1. +Quickstart: install the CLI, add an environment, sign in, deploy.
  2. +Namespaces: the unit you work inside.
  3. +Sign-in and sessions and API keys and access control: who your users are and what each key may do.
  4. +The services you need: deployments, databases, cache, storage, pub/sub, functions, push, WebRTC, vault, domains.
  5. +Reference: TypeScript SDK, CLI, gateway HTTP API.

I want to run a cluster from nothing

You have a few VPSes and a domain. You want a working cluster and no help from anyone.

  1. +What you need: machines, domain, your own computer.
  2. +Install a cluster from scratch: the whole sequence, with a check after every step.
  3. +DNS and nameservers and TLS and certificates.
  4. +Create your first namespace and deploy.
  5. +Day two: monitoring, upgrades, backups, troubleshooting.

Just want to try it on one machine? Read One-VPS evaluation instead. It is not highly available.

I want to create a network

You have fresh machines and want a chain of your own, with those machines as its first validators.

  1. +What you need: machines, host keys, RootWallet.
  2. +Create a network: orama setup --create-network, what it builds and in what order.
  3. +Validators and staking: the bootstrap committee it creates, and how its power hands over to staked validators.
  4. +Publish it: the DNS records, the registry and the website copy that let others join.

I want to understand how it works and why it is safe

  1. +Architecture overview and the node process model.
  2. +Request lifecycle: what happens between your HTTPS request and the answer.
  3. +Security model, secrets and keys, and the stated limits.
  4. +Vulnerability disclosure.

I want to understand the chain

  1. +What the chain is and the modules.
  2. +Supply and emission, fees, validators and staking.
  3. +Governance, storage deals, relay rewards.
  4. +Running a chain node and global nodes.

I care about privacy

Read Privacy network overview first. It says plainly what is hidden from whom, and what is not built.

I use RootWallet

RootWallet overview, then installing it, then signing in to Orama.

I want to change Orama itself

Contributor setup, code style, testing, sandbox clusters.