Skip to main content
Ringee is configured entirely through environment variables. Any change to environment variables requires an application restart. The full example file can be found at: .env.example on GitHub

Required Settings

Application

DATABASE_URL

PostgreSQL connection string. Ringee uses Prisma ORM.
postgresql://ringee-user:ringee-password@localhost:5432/ringee-db-local?schema=public

REDIS_URL

redis://localhost:6379

REDIS_HOST

localhost

REDIS_PORT

6379

FRONTEND_URL

URL where the admin frontend is served.
http://localhost:4200

BACKEND_URL / PUBLIC_BACKEND_URL

URL where the backend API is served.
http://localhost:3000

APP_ENCRYPTION_SECRET

A random string used for encrypting sensitive data at the application level. Should be unique per installation.

Authentication (Clerk)

See the Clerk Configuration guide for setup details.
VariableDescription
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEYClerk publishable key
CLERK_PUBLISHABLE_KEYClerk publishable key (backend)
CLERK_SECRET_KEYClerk secret key
CLERK_WEBHOOK_SIGNING_SECRETWebhook signing secret
NEXT_PUBLIC_CLERK_SIGN_IN_URLSign-in page URL (default: /auth/sign-in)
NEXT_PUBLIC_CLERK_SIGN_UP_URLSign-up page URL (default: /auth/sign-up)
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URLRedirect after sign-in (default: /dashboard/overview)
NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URLRedirect after sign-up (default: /dashboard/overview)

Telephony (Telnyx)

See the Telnyx Configuration guide for setup details.
VariableDescription
TELNYX_API_KEYYour Telnyx API key
TELNYX_CONNECTION_IDTelnyx WebRTC connection ID
TELNYX_SIP_USERSIP username for WebRTC
TELNYX_SIP_PASSWORDSIP password for WebRTC
NEXT_PUBLIC_TELNYX_LOGINSIP login exposed to frontend
NEXT_PUBLIC_TELNYX_PASSWORDSIP password exposed to frontend

Payments (Stripe)

See the Stripe Configuration guide for setup details.
VariableDescription
STRIPE_SECRET_KEYYour Stripe secret key
STRIPE_WEBHOOK_SECRETStripe webhook signing secret

Email (Resend)

See the Email Configuration guide for details.
VariableDescription
RESEND_API_KEYYour Resend API key
EMAIL_FROM_ADDRESSSender email address
EMAIL_FROM_NAMESender display name

Storage (Cloudflare R2)

See the R2 Configuration guide for details.
VariableDescription
CLOUDFLARE_BUCKETNAMER2 bucket name
CLOUDFLARE_ACCOUNT_IDCloudflare account ID
CLOUDFLARE_ACCESS_KEYR2 access key
CLOUDFLARE_SECRET_ACCESS_KEYR2 secret access key
CLOUDFLARE_BUCKET_URLPublic bucket URL
CLOUDFLARE_REGIONRegion (default: auto)
STORAGE_PROVIDERStorage provider (default: cloudflare)

Optional Settings

Frontend

VariableDescription
NEXT_PUBLIC_API_BASE_URLBackend API URL for the frontend
NEXT_PUBLIC_SITE_URLPublic site URL
NEXT_PUBLIC_APP_ENVApp environment (development / production)

Sentry (Error Tracking)

VariableDescription
NEXT_PUBLIC_SENTRY_DSNSentry DSN
NEXT_PUBLIC_SENTRY_ORGSentry organization slug
NEXT_PUBLIC_SENTRY_PROJECTSentry project slug
SENTRY_AUTH_TOKENSentry auth token
NEXT_PUBLIC_SENTRY_DISABLEDDisable Sentry (true / false)

AI

VariableDescription
OPENAI_API_KEYOpenAI API key (used for AI features)