Skip to content
SIMPLICITY-ADMIN

Config Options Reference

All options for simplicity-admin.config.ts. Pass these to defineConfig() or createAdmin().

Top-Level Options

Section titled “Top-Level Options”

database

Section titled “database”
  • Type: string
  • Default: none (required)
  • Description: PostgreSQL connection string.
database: 'postgres://user:password@localhost:5432/mydb'

schema

Section titled “schema”
  • Type: string
  • Default: 'public'
  • Description: The PostgreSQL schema to introspect for application tables.

systemSchema

Section titled “systemSchema”
  • Type: string
  • Default: '_simplicity'
  • Description: Schema name for SIMPLICITY-ADMIN internal tables (users, sessions, roles, audit log).

port

Section titled “port”
  • Type: number
  • Default: 3000
  • Description: Server port. Only used in standalone mode (not when embedded as middleware).

basePath

Section titled “basePath”
  • Type: string
  • Default: '/admin'
  • Description: URL base path for the admin UI and all API routes.

api

Section titled “api”

api.graphql

Section titled “api.graphql”
  • Type: boolean
  • Default: true
  • Description: Enable the GraphQL endpoint at {basePath}/graphql.

api.rest

Section titled “api.rest”
  • Type: boolean
  • Default: false
  • Description: Enable RESTful endpoints at {basePath}/api/{table} with OpenAPI spec.

api.graphiql

Section titled “api.graphiql”
  • Type: boolean
  • Default: true
  • Description: Enable the GraphiQL explorer at {basePath}/graphiql.

auth

Section titled “auth”

auth.secret

Section titled “auth.secret”
  • Type: string
  • Default: none (required)
  • Description: Secret key for signing and verifying JWTs. Use a strong random value in production.

auth.accessTokenTTL

Section titled “auth.accessTokenTTL”
  • Type: string
  • Default: '15m'
  • Description: Access token time-to-live. Accepts shorthand durations: '15m', '1h', '1d'.

auth.refreshTokenTTL

Section titled “auth.refreshTokenTTL”
  • Type: string
  • Default: '7d'
  • Description: Refresh token time-to-live.

tenancy

Section titled “tenancy”

tenancy.enabled

Section titled “tenancy.enabled”
  • Type: boolean
  • Default: false
  • Description: Enable multi-tenancy support.

tenancy.resolution

Section titled “tenancy.resolution”
  • Type: string
  • Default: 'header'
  • Description: How the tenant ID is resolved from incoming requests.

tenancy.header

Section titled “tenancy.header”
  • Type: string
  • Default: 'X-Tenant-ID'
  • Description: HTTP header name used for tenant resolution when tenancy.resolution is 'header'.

providers

Section titled “providers”
  • Type: object
  • Default: {}
  • Description: Custom provider overrides. Keys: database, api, auth, ui. Values must implement the corresponding provider interface from @mabulu-inc/simplicity-admin-core.
providers: {
  auth: myCustomAuthProvider,
}

plugins

Section titled “plugins”
  • Type: Plugin[]
  • Default: []
  • Description: Array of plugin instances. Plugins execute lifecycle hooks in array order.
plugins: [requestLogger(), auditTrail()]