Documentation

Access

  • Role grants

    Manage the fixed role bindings that authorize server users.

  • Authentication and access control

    The neutral access model every ecosystem shares: principals, actions, resource-glob grants, per-index tokens, and the anonymous-read policy.

  • Bootstrap the first administrator

    Create one local administrator from standard input or a mounted secret before starting peryx.

  • Control access to an index

    Recipes for the common access tasks: scope a token to some resources, declare an index's reads private, close a whole server, and keep a secret in a file.

  • Scoped token lifecycle

    Create, list, inspect, rotate, and revoke named API tokens over a reach the caller is authorized to grant.

  • Client auth versus upstream credentials

    Two separate questions peryx keeps apart: who a client is to peryx, and how peryx authenticates to an upstream. Why a cache must never forward the first to the second.