Banata

Getting Started

Introduction

Banata Auth is a dashboard-first auth platform with a self-hosted deployment option.

What Banata Auth Is

Banata Auth is a managed auth platform for:

  • user management
  • organizations
  • SSO and directory sync
  • custom RBAC
  • audit logs
  • email delivery and templates
  • project-scoped API keys

Banata is the system of record. Your customer data does not live in your app database by default. Your app talks to Banata over HTTP and Banata owns the auth runtime, similar to WorkOS or Clerk.

The Product Contract

Banata has one primary operating model:

  1. Sign in to the Banata dashboard
  2. Create a project
  3. Create a project-scoped API key
  4. Bind your app to that project with the API key
  5. Start auth flows from your frontend through Banata's server-side helpers and SDKs

If you skip the dashboard bootstrap step, Banata should not become a usable auth runtime for that app.

Managed Vs Self-Hosted

These are not two different product shapes.

  • Hosted Banata: you use Banata's hosted dashboard and API.
  • Self-hosted Banata: you deploy the Banata platform yourself, but developers still sign in to a Banata dashboard, create a project, create an API key, and use the same SDKs.

Self-hosting is a deployment choice, not a different integration model.

Recommended Starting Point

For most teams:

Only use @banata-auth/convex if you are operating the Banata platform itself.

Package Roles

PackagePrimary Role
@banata-auth/sdkRemote dashboard/admin API client
@banata-auth/nextjsNext.js auth proxy and server helpers
@banata-auth/reactReact auth client plugins, provider, and UI helpers
@banata-auth/convexInternal/self-host platform runtime package
@banata-auth/sharedShared types, errors, and validation

How To Read These Docs

  • SDK Reference is the main Banata integration surface.
  • Next.js shows how to bind app auth routes to Banata with a server-side API key.
  • API Keys explains project scoping and key management.
  • Self-Hosting is for operators deploying the Banata platform itself.

Important Version Notes

  • The current Convex-backed platform runtime is tested against better-auth@1.4.x.
  • Published @banata-auth/*@0.1.0 packages were released with broken workspace:* internal dependencies. Use 0.1.1+.