Skip to main content
Opengeni is Apache-2.0: the API, web app, workers, Helm chart, and reference Terraform are all open source.

What you run

In production, use managed services or official charts for Postgres, Temporal, NATS, and object storage. The chart’s built-in copies are for local and smoke testing.

Install with Helm

Charts are published as OCI artifacts under ghcr.io/cloudgeni-ai. Each release’s BOM lists the chart reference and image digests. Pin the chart to the version you run and keep secrets in a Kubernetes Secret:

Reference infrastructure

Terraform for Azure, AWS, and GCP lives under deploy/terraform. List the deployment profiles and plan one:
The plan lists the resources, dependencies, required secrets, and the deploy, verify, and destroy commands.

Access modes

OPENGENI_PRODUCT_ACCESS_MODE sets how callers are identified: Outside local development, configured mode needs either OPENGENI_DELEGATION_SECRET (delegated tokens) or OPENGENI_AUTH_REQUIRED=true with OPENGENI_ACCESS_KEY (a shared key sent as x-opengeni-access-key). The shared key is a simple perimeter, not per-tenant access control. See the security boundary.

Credit coupons

With Stripe billing enabled, customers redeem promotion codes in the console. You create and manage the codes in your own Stripe account. Scoped offers redeem their fixed credit amount through a $0 checkout; customers buy additional credits separately. Set OPENGENI_WEB_BASE_URL if the console and API use different origins. Signup and coupon credits can share an editable model list, with overrides per offer. The model picker shows which credits a model uses and marks models the remaining credits do not cover; billing shows the models each grant covers. Operators can update that coverage for existing promotional balances without restarting services. Follow the promotional credit setup for activation and the policy command.

Before you expose it

Put the deployment behind a gateway with:
  • TLS
  • Authentication for every user-facing route
  • Rate and request-size limits sized for sessions, files, and SSE
  • SSE support: buffering off, read and send timeouts of at least 3600 seconds
  • Access logs
Review sandbox preparation profiles and environment allowlists: they decide which host credentials reach a sandbox.
Some migrations require stopping every old API and worker first, and the old image must not be restarted afterward. Read the upgrade notes in the deployment guide before every upgrade.
The console’s Help entry opens the public Opengeni docs. Set OPENGENI_DOCUMENTATION_URL to your own docs, or none to hide it. For link previews in Slack and other chat tools, set OPENGENI_PUBLIC_BASE_URL to the public address, and OPENGENI_WEB_BASE_URL to the console origin if it differs from the API.

Going deeper

The deployment guide covers Helm values, Terraform outputs, Connected Machine relay setup, observability, and cloud-specific notes.