← Build on your apps

The settings file (onvoi.yaml)

Every app has an onvoi.yaml at the top of its code: what it runs, its data, who can do what, and the secrets it needs. Onvoi writes one for you if your project doesn’t have it.

An example

onvoi.yaml
apiVersion: onvoi.ai/v1alpha1
kind: Application
metadata:
  name: inventory
  license: MIT
runtime:
  stack: static            # static | node22 | python312 | docker
auth:
  mode: onvoi              # people sign in with their Onvoi account
  roles: [ { key: manager } ]
services:
  database: { type: mongodb, provision: true }
data:
  collections:
    - name: items
      schema: { type: object, required: [sku], properties: { sku: { type: string } } }
      access: { read: [ { role: "*" } ], update: [ { role: manager } ] }
secrets:
  - { name: WEATHER_API, required: true, shared: true, default: "https://api.weather.example" }
  - { name: STRIPE_KEY, required: false }

The sections

  • runtime — the stack, build and test commands, functions (with routes and schedules), and for a dedicated server start and health.
  • auth — sign-in with Onvoi and the roles your app uses.
  • services — a database, file storage, or external services it connects to.
  • data — collections with their schema, who may read and write them, and events.
  • secrets — names only (plus a shared value when you choose; see Secrets).
  • capabilities and events — what agents and other apps may do (see Expose your app to agents).
  • network — the outside addresses it may call; migrations, backup, design.

Changing it

Edit it in Source & advanced → Configuration (it’s checked, built and previewed like any change), or commit it with your code.