Skip to content

A one-of-a-kind resume builder that keeps your privacy in mind. Completely secure, customizable, portable, open-source and free forever. Try it out today!

10.3 KB
Raw Blame
# --- Application ---
# Public port used by the production server and the Vite web server in local development.
PORT="3000"

# Port used by the Hono server in local development. Vite proxies API requests to this port.
SERVER_PORT="3001"
# Optional comma-separated proxy IPs/CIDRs. Only these socket peers may supply X-Forwarded-For.
# Configure your reverse proxy to append the actual client address; never trust a public client network.
TRUSTED_PROXIES=""

# Public URL where the app is served. Used for auth callbacks, OAuth issuer URLs,
# OpenGraph metadata, and absolute upload URLs.
APP_URL="http://localhost:3000"

# Optional full Git commit SHA, embedded by official Docker builds and reported by /api/health.
# APP_REVISION=

# Optional: serve one already-public resume at /. Use the ID from /builder/<id>.
# Unset or blank keeps the marketing home. Restart after changes.
# ROOT_RESUME_ID=

# Optional: a second domain that serves the same public pages as APP_URL: resumes, /<username> (an account's
# primary resume), the home page. Sign-in and the editor stay on APP_URL. When set, shared links use this domain.
# Point the domain at this server.
# APP_ALIAS_URL=

# Optional: custom domains. People point a CNAME at this host (or its addresses for a root domain), and Traefik's
# HTTP provider reads /api/internal/traefik with the secret in an X-Provider-Secret header to issue certificates.
# Both are needed; leave unset to turn custom domains off.
# CUSTOM_DOMAIN_TARGET=
# CUSTOM_DOMAIN_PROVIDER_SECRET=

# Vercel: APP_URL can be omitted; production uses VERCEL_PROJECT_PRODUCTION_URL.

# --- Font mirror (server PDF rendering only) ---
# Optional absolute HTTP(S) base URL, without a query string or fragment.
# Mirrors only the five Computer Modern families; Google fonts and browser font
# requests remain external. Preserve the upstream font/<family>/<file>.woff layout.
# Set before server startup; restart/redeploy after changes. No web rebuild needed.
# See docs/self-hosting/fonts.mdx for setup and current limitations.
# WEB_FONT_BASE_URL="https://fonts.example.com/cm"

# --- Database (PostgreSQL) ---
# PostgreSQL connection URL. In Docker Compose, the hostname is usually `postgres`;
# when running directly on your machine, `localhost` is typical.
DATABASE_URL="postgresql://postgres:postgres@postgres:5432/postgres"

# Optional direct connection for migrations (Neon: DATABASE_URL_UNPOOLED alias).
# DATABASE_MIGRATION_URL=""
# DATABASE_POOL_MAX="10"

# When "true", the server refuses to boot if the live database schema has drifted from
# the migration ledger (e.g. a table dropped outside migrations). Default "false" logs
# the drift loudly at startup and continues.
STRICT_SCHEMA_CHECK="false"

# --- Authentication ---
# Generated using `openssl rand -hex 32`
AUTH_SECRET="change-me-to-a-secure-secret-key-in-production"

# Better Auth Dashboard (optional)
# Enables the Better Auth Dashboard plugin when set, you probably don't need this.
BETTER_AUTH_API_KEY=""

# OpenAI plugin directory domain verification (optional)
# Only needed to publish this instance's MCP server as a ChatGPT/Codex plugin.
# Paste the token from the plugin portal; it is served at /.well-known/openai-apps-challenge.
OPENAI_APPS_CHALLENGE_TOKEN=""

# Social Auth (Apple, optional)
# Set both values to enable Apple sign-in. CLIENT_ID is the Apple Services ID.
# CLIENT_SECRET is a signed Apple JWT, not the .p8 key; renew it before its expiry (at most 6 months).
# Register https://<your-host>/api/auth/callback/apple as the Apple return URL.
APPLE_CLIENT_ID=""
APPLE_CLIENT_SECRET=""

# Native app links (optional; unset means the association endpoints return 404)
# Comma-separated TEAMID.bundle.id values, Android package names, and SHA-256 signing fingerprints.
# Every Android package uses every listed fingerprint (release, Play signing, or debug as needed).
MOBILE_IOS_APP_IDS=""
MOBILE_ANDROID_PACKAGES=""
MOBILE_ANDROID_CERT_SHA256=""

# Social Auth (Google, optional)
# Set both values to enable Google sign-in.
GOOGLE_CLIENT_ID=""
GOOGLE_CLIENT_SECRET=""

# Social Auth (GitHub, optional)
# Set both values to enable GitHub sign-in.
GITHUB_CLIENT_ID=""
GITHUB_CLIENT_SECRET=""

# Social Auth (LinkedIn, optional)
# Set both values to enable LinkedIn sign-in.
LINKEDIN_CLIENT_ID=""
LINKEDIN_CLIENT_SECRET=""

# Custom OAuth Provider (optional)
# Set OAUTH_CLIENT_ID and OAUTH_CLIENT_SECRET plus either OAUTH_DISCOVERY_URL or
# the three manual endpoint URLs below.
OAUTH_PROVIDER_NAME=""
OAUTH_CLIENT_ID=""
OAUTH_CLIENT_SECRET=""
OAUTH_DISCOVERY_URL=""
OAUTH_AUTHORIZATION_URL=""
OAUTH_TOKEN_URL=""
OAUTH_USER_INFO_URL=""

# Space-separated scopes requested from the custom OAuth provider.
OAUTH_SCOPES="openid profile email"

# --- Email (optional) ---
# If SMTP_HOST, SMTP_USER, SMTP_PASS, or SMTP_FROM is missing, the app logs the
# email to the console instead.
SMTP_HOST=""
SMTP_PORT=""
SMTP_USER=""
SMTP_PASS=""
SMTP_FROM="Reactive Resume <[email protected]>"
# false requires STARTTLS; true uses TLS from connection start. Plaintext SMTP is refused.
SMTP_SECURE="false"

# --- Storage (optional) ---
# Backend defaults to S3 when all credentials are present, otherwise local.
# Vercel defaults to private Blob; Workers uses native R2. Explicit selection: local, s3, blob, r2.
# STORAGE_BACKEND="local"
# Total storage health-check deadline, including both S3 PUT and DELETE requests.
# Set external probe timeouts higher than this value (milliseconds).
# STORAGE_HEALTHCHECK_TIMEOUT_MS="5000"
# Cloudflare Workers uses CLOUDFLARE=1 and native STORAGE_BACKEND="r2" bindings.
# Configure it through wrangler.jsonc and Wrangler secrets, not this Docker environment template.
# BLOB_READ_WRITE_TOKEN=""
# BLOB_STORE_ID=""
# DEPLOYMENT_NAMESPACE="default"
# Vercel previews need isolated resources before setting ALLOW_PREVIEW_MIGRATIONS=true.

# If all S3 keys are disabled, Docker uses local filesystem storage instead.
# Make sure to mount this directory to a volume or the host filesystem to ensure data integrity.
# LOCAL_STORAGE_PATH overrides where local uploads/cache are written.
# Defaults to /app/data in the official Docker image; in dev, defaults to <workspace>/data.
# LOCAL_STORAGE_PATH="/app/data"

# Seaweedfs
S3_ACCESS_KEY_ID="seaweedfs"
S3_SECRET_ACCESS_KEY="seaweedfs"
S3_REGION="us-east-1"
S3_ENDPOINT="http://seaweedfs:8333"
S3_BUCKET="reactive-resume"
S3_FORCE_PATH_STYLE="true"

# --- AI Agent Workspace (optional) ---
# ENCRYPTION_SECRET is required for saved AI providers and the assistant.
# Redis is optional on a single server. Providers and conversations persist in PostgreSQL.
# Redis shares rate limits, resume events, cancellation and view deduplication, and resumes reply streams.
# Vercel Upstash KV_URL is accepted as an alias for REDIS_URL.
# Password-only auth (redis-server --requirepass) needs an empty username:
#   redis://:<password>@<host>:<port>  or  redis://default:<password>@<host>:<port>
# A named username is only for servers with a configured ACL user; passwordless (`nopass`) ACL users keep an
# explicitly empty password: redis://<user>:@<host>:<port>
REDIS_URL="redis://redis:6379"
ENCRYPTION_SECRET="change-me-to-a-secure-agent-secret-in-production"

# --- Web access (optional) ---
# One shared connection supplies search and enhanced reading: firecrawl, tavily or exa.
# Leave unset to use the built-in reader and let users connect a personal key (requires ENCRYPTION_SECRET).
# WEB_ACCESS_PROVIDER="tavily"
# WEB_ACCESS_API_KEY=""
# Optional custom Firecrawl service, without /v2; may be keyless. Other providers use fixed cloud endpoints.
# WEB_ACCESS_PROVIDER="firecrawl"
# WEB_ACCESS_API_URL="http://localhost:3102"
# Optional search-only backend; enable json in SearXNG search.formats.
# WEB_SEARCH_SEARXNG_URL="http://searxng:8080"

# Optional shared AI provider. When set, personal AI providers are disabled.
# AI_PROVIDER="openai"
# AI_MODEL="gpt-5-mini"
# AI_API_KEY=""
# AI_BASE_URL=""

# Authenticates GET/POST /api/career/run on every deployment.
# Required on Vercel: Cron sends Authorization: Bearer <CRON_SECRET> automatically.
# The once-per-minute cron in vercel.json requires Pro/Enterprise.
# Node/Docker and Cloudflare schedule internally without this token.
# CRON_SECRET="replace-with-a-random-secret-at-least-16-characters"

# --- Feature Flags ---
# This flag disables new signups, both on the web app and the server.
FLAG_DISABLE_SIGNUPS="false"

# This flag disables email/password login. Disables email verification, forgot password, and reset password flows.
# Users can still sign up via social auth (Google/GitHub/Custom OAuth), unless FLAG_DISABLE_SIGNUPS is also set to true.
FLAG_DISABLE_EMAIL_AUTH="false"

# This flag lets visitors continue as a guest without creating an account.
# Guests can create an account later and keep their resumes, cover letters and applications.
# Ignored when FLAG_DISABLE_SIGNUPS is true.
FLAG_ENABLE_GUEST_LOGIN="false"

# This flag disables the image processing.
# This is useful if you are using a machine with limited resources, like a Raspberry Pi.
FLAG_DISABLE_IMAGE_PROCESSING="false"

# This flag disables API and authentication rate limiting, including PDF export and AI requests.
# Rate limiting is enabled by default in production to prevent abuse.
FLAG_DISABLE_API_RATE_LIMIT="false"


# Allows dynamic OAuth client registration to use any parseable redirect URI,
# including custom schemes, private hosts, and non-loopback http:// URLs.
# WARNING: Enabling this on a public or multi-tenant deployment can enable phishing
# or token exfiltration. Only enable this on a trusted, self-hosted instance.
FLAG_ALLOW_UNSAFE_OAUTH_REDIRECT_URI="false"

# Suggests a <username>.cv domain from OlaCV to people who have no custom domain yet.
# With OLACV_API_KEY set, Share checks availability and price first and suggests only a name that's free.
FLAG_OLACV_SUGGESTION="false"
# OLACV_API_KEY=

# Allows AI providers to be configured with any base URL, including http:// and
# private/loopback addresses (e.g. http://localhost:11434 for a local Ollama instance).
# WARNING: Enabling this on a multi-tenant deployment is a Server-Side Request Forgery (SSRF)
# risk. Only enable this on a trusted, single-tenant self-hosted instance.
FLAG_ALLOW_UNSAFE_AI_BASE_URL="false"

# --- Others ---
# Google Cloud API Key (optional)
# For font-list generation tooling.
# Requires "Google Fonts Developer API" to be enabled.
GOOGLE_CLOUD_API_KEY=""

# Crowdin (optional)
# For translation tooling.
CROWDIN_PROJECT_ID=""
CROWDIN_API_TOKEN=""