Skip to main content

Glossary

Key terms and definitions used throughout the Kuploy documentation.

A​

Application (App) A deployed service — a container running your code. Each app is built from a Git repository and runs within a project. Multiple apps can exist within a single project.

Aggregate Quotas Usage limits that are summed across all kuploy-cloud instances linked to the same license. For example, if two instances have 10 projects each under a 20-project plan, the aggregate usage is 20/20 (100%).

B​

Build Minutes Time consumed building application images from source code. Includes pulling code, installing dependencies, compiling, and creating the container image. Tracked per billing period and subject to plan limits.

Buildpacks An automated build method based on Cloud Native Buildpacks. Detects your application type and builds a container image. Supports Heroku, Paketo, and Google providers.

C​

Claim Code A short-lived code (format: XXXX-XXXX, e.g., KPXY-4829) used to link a kuploy-cloud instance to a license. Generated by the instance, entered at kuploy.app/claim. Expires after 15 minutes.

D​

Dockerfile A build method where you provide your own Dockerfile for full control over the container build process.

E​

epay-gateway Self-hosted payment gateway that routes one-time payments and subscriptions to West-African mobile-money and card providers (Orange Money, MTN MoMo, KULU, Visa/MasterCard via Djomy, PayCard, CinetPay). kuploy-cloud integrates with a running epay-gateway deployment to offer mobile-money checkout as an alternative to Stripe on Business+ plans. Full docs at docs.epay-gateway.com.

F​

Feature Flags Capabilities that are enabled or disabled based on the tenant's platform plan. Includes: custom domains, AI assistant, multi-server, priority support, white-label, and domain purchase.

I​

Instance A single kuploy-cloud deployment, running on a Kubernetes cluster and linked to a license. A tenant can run multiple instances depending on their platform plan.

Instance Plan A subscription plan within a kuploy-cloud instance that organizations subscribe to (e.g., Free, Pro, Business). Defined and priced by the tenant. Controls per-organization resource limits.

K​

kuploy The open-source deployment engine. Provides Git-based deployments, managed databases, SSL, and container orchestration on Kubernetes.

kuploy-cloud The commercial edition of Kuploy. Extends the open-source core with multi-tenant billing, licensing, admin dashboard, team management, and quota enforcement.

kuploy-hub The licensing + identity hub running at kuploy.app. Issues licenses, runs the claim-code flow, aggregates usage across instances, and acts as the OpenID Connect identity provider for first-party products. Used interchangeably with kuploy.app in operator docs.

kuploy.app The centralized licensing and billing hub. Tenants subscribe to platform plans here. Issues license keys, manages aggregate quotas, and provides the claim code flow.

kuploy_hub_admin (OIDC claim) Boolean claim emitted on the hub's userinfo / id_token responses. True when the signed-in user has email.role = "admin" on kuploy-hub. Downstream products (leeram-business, future kuploy-cloud) use this to grant hub-level admins instance-management authority on their self-hosted deployments without per-deployment opt-in. See OIDC Custom Claims.

KUPLOY_OIDC_TRUSTED_CLIENTS JSON-array environment variable on kuploy-hub that registers first-party SSO consumers. Each entry's redirectUrls is validated for both OAuth callbacks and post-logout redirects. See SSO with kuploy-hub.

L​

License A key (lic_xxx) issued at kuploy.app that authorizes a kuploy-cloud instance to operate. Carries plan limits, feature flags, and quota information. Syncs periodically with the licensing hub.

License Sync Periodic communication between a kuploy-cloud instance and kuploy.app. Reports local usage, receives updated limits, aggregate usage, and warnings. Default interval: 5 minutes.

N​

Nixpacks The recommended build method. Automatically detects your application's language and framework, then builds an optimized container image with zero configuration.

O​

OIDC (OpenID Connect) The authentication layer kuploy-hub uses to act as the identity provider for first-party products. Consumers federate via Better Auth's genericOAuth plugin pointed at the hub's discovery URL. See SSO with kuploy-hub and OIDC Custom Claims.

Organization (Org) A customer of the tenant. Groups projects, applications, team members, and billing within a kuploy-cloud instance. Subscribes to an instance plan.

P​

Payment Gateway A Business+ feature that integrates a self-hosted epay-gateway with kuploy-cloud. Covers both (a) mobile-money/card checkout for org subscriptions, and (b) a composable "Payment Gateway" service orgs can add to their own projects. See the tenant guide and developer guide.

Platform Plan A subscription at kuploy.app (Hobby, Starter, Growth, Business, or Enterprise). Controls what the tenant's kuploy-cloud instances can do — instance count, aggregate resource limits, and feature flags.

Project A logical grouping of related applications, databases, and resources within an organization. Each project runs in its own Kubernetes namespace for isolation.

R​

requireInstanceAdmin Server-side gate used by first-party products (leeram-business today) to authorise license-management actions on a self-hosted deployment. Calls the hub's /oauth2/userinfo live on each invocation and reads kuploy_hub_admin. Failures use notFound() rather than redirect — the URL appears non-existent to anyone unauthorised. See Licensing & Platform Plans.

RP-Initiated Logout OIDC standard flow where a relying party (consumer) terminates the IdP's session in addition to its own local session. kuploy-hub publishes end_session_endpoint (at /api/auth/oauth2/endsession) for this. Without it, signing out of a consumer leaves the kuploy.app session cookie alive and a subsequent SSO sign-in silently re-auths. See SSO with kuploy-hub.

T​

Tenant An ISP, ITSP, or hosting provider who runs one or more kuploy-cloud instances. Subscribes to a platform plan at kuploy.app. Defines instance plans in kuploy.app, which are synced to all their kuploy-cloud instances.