postiz-app/.env.example
postiz-contribution[bot] 4ff903d899
Merge main into staging
2026-10-15 14:08:26 +00:00

417 lines
17 KiB
Plaintext

# Postiz environment reference
# Configuration reference: http://docs.postiz.com/configuration/reference
#
# Every variable Postiz reads is listed here. Uncommented entries are the ones a
# self-hosted instance needs to boot; everything commented out is optional and
# only enables the feature it belongs to.
#
# If you add a new environment variable to the codebase, add it here too.
# =============================================================================
# Required
# =============================================================================
DATABASE_URL="postgresql://postiz-user:postiz-password@localhost:5432/postiz-db-local"
REDIS_URL="redis://localhost:6379"
JWT_SECRET="random string for your JWT secret, make it long"
# === These need to be exactly the URLs you're accessing Postiz on
FRONTEND_URL="http://localhost:4200"
NEXT_PUBLIC_BACKEND_URL="http://localhost:3000"
BACKEND_INTERNAL_URL="http://localhost:3000"
# Marketing / landing site the app links back to (logo, footer links).
#MAIN_URL="http://localhost:4200"
# Public base URL advertised by the MCP server metadata, when it differs from
# NEXT_PUBLIC_BACKEND_URL (for example behind a separate MCP hostname).
#NEXT_PUBLIC_OVERRIDE_BACKEND_URL=""
# Server-side base URL used by the shared fetch helper when it runs outside the
# browser. Normally derived automatically; set it only if you must override it.
#BACKEND_URL=""
# Only needed if you run your own Postiz Canva app: its origin from the Canva
# Developer Portal (Security -> Credentials), allowed by CORS on the backend.
#CANVA_APP_ORIGIN="https://app-xxxxxxxxxxx.canva-apps.com"
# HTTP ports. Defaults: backend 3000, orchestrator 3002.
#PORT=3000
#ORCHESTRATOR_PORT=3002
# =============================================================================
# Storage
# =============================================================================
# Where uploads and social media icons are saved - "local" or "cloudflare".
STORAGE_PROVIDER="local"
# Your upload directory path if you host your files locally, otherwise Cloudflare will be used.
#UPLOAD_DIRECTORY=""
# Public path the frontend uses to serve those local uploads.
#NEXT_PUBLIC_UPLOAD_STATIC_DIRECTORY=""
## Remember to set your public internet IP address in the allow-list for the API token.
##
## Cloudflare R2 is used when STORAGE_PROVIDER="cloudflare".
CLOUDFLARE_ACCOUNT_ID="your-account-id"
CLOUDFLARE_ACCESS_KEY="your-access-key"
CLOUDFLARE_SECRET_ACCESS_KEY="your-secret-access-key"
CLOUDFLARE_BUCKETNAME="your-bucket-name"
CLOUDFLARE_BUCKET_URL="https://your-bucket-url.r2.cloudflarestorage.com/"
CLOUDFLARE_REGION="auto"
## Optional media normalization (postiz-uploader on RunPod Serverless). Requires STORAGE_PROVIDER="cloudflare".
## When set, web uploads are transcoded to 1080p h264 mp4 / downsized images in the background;
## the media record reports status "processing" until the normalized file replaces the original.
#RUNPOD_API_KEY=""
#RUNPOD_ENDPOINT_ID=""
## Optional video clipping (YouTube video -> captioned vertical clips -> draft posts). Requires STORAGE_PROVIDER="cloudflare",
## RUNPOD_API_KEY (with access to both endpoints below) and OPENAI_API_KEY. Ingest jobs go to the CPU endpoint, clip jobs to the
## GPU endpoint of postiz-uploader (which needs its own Oxylabs account to fetch from YouTube); Deepgram transcribes videos
## that have no usable captions.
#RUNPOD_INGEST_ENDPOINT_ID=""
#RUNPOD_CLIPPER_ENDPOINT_ID=""
#DEEPGRAM_API_KEY=""
# Skip the browser-side image shrink before upload (keeps full resolution).
#DISABLE_IMAGE_COMPRESSION=false
# Only accept public API uploads whose URL contains this domain.
#RESTRICT_UPLOAD_DOMAINS=""
# Transloadit is used for browser-side media processing when both are set.
#TRANSLOADIT_AUTH=""
#TRANSLOADIT_TEMPLATE=""
#TRANSLOADIT_SECRET=""
# =============================================================================
# Email
# =============================================================================
# "resend", "nodemailer", or unset to disable outgoing email entirely.
#EMAIL_PROVIDER="resend"
#EMAIL_FROM_ADDRESS=""
#EMAIL_FROM_NAME=""
## This is a dummy key, you must create your own from Resend.
## If this variable exists, user activation is required.
## If it is commented out, users are activated automatically.
#RESEND_API_KEY="RzeTwHijvxvPUerScFcenUZUALuQJzSaGSMJ"
# SMTP settings, required when EMAIL_PROVIDER="nodemailer".
#EMAIL_HOST=""
#EMAIL_PORT="587"
#EMAIL_SECURE="false"
#EMAIL_USER=""
#EMAIL_PASS=""
# =============================================================================
# Registration & login
# =============================================================================
#DISABLE_REGISTRATION=false
# Reject sign-ups using plus-addressed emails (user+tag@example.com).
#DISALLOW_PLUS=true
# --- Generic OAuth (Authentik, Keycloak, Authelia, ...)
POSTIZ_GENERIC_OAUTH="false"
NEXT_PUBLIC_POSTIZ_OAUTH_DISPLAY_NAME="Authentik"
NEXT_PUBLIC_POSTIZ_OAUTH_LOGO_URL="https://raw.githubusercontent.com/walkxcode/dashboard-icons/master/png/authentik.png"
POSTIZ_OAUTH_URL="https://auth.example.com"
POSTIZ_OAUTH_AUTH_URL="https://auth.example.com/application/o/authorize"
POSTIZ_OAUTH_TOKEN_URL="https://auth.example.com/application/o/token"
POSTIZ_OAUTH_USERINFO_URL="https://authentik.example.com/application/o/userinfo"
POSTIZ_OAUTH_CLIENT_ID=""
POSTIZ_OAUTH_CLIENT_SECRET=""
# POSTIZ_OAUTH_SCOPE="openid profile email" # default value
# --- Sign in with Apple
# APPLE_CLIENT_ID: the Services ID identifier (web sign-in)
# APPLE_TEAM_ID / APPLE_KEY_ID / APPLE_PRIVATE_KEY: the .p8 signing key
# APPLE_APP_BUNDLE_ID: iOS app bundle id, added as an extra allowed audience
#APPLE_CLIENT_ID=""
#APPLE_TEAM_ID=""
#APPLE_KEY_ID=""
#APPLE_PRIVATE_KEY=""
#APPLE_APP_BUNDLE_ID=""
# --- Sign in with Farcaster (Neynar)
#NEYNAR_CLIENT_ID="" # still gates the Farcaster login button in the UI
#NEYNAR_SECRET_KEY=""
# NEYNAR_LOGIN_URL="https://app.neynar.com/login" # default value
#NEYNAR_APP_FID="" # Farcaster id of the account that represents your app (the one users see requesting access)
#NEYNAR_APP_MNEMONIC="" # recovery phrase of that account's custody wallet, used only to sign managed-signer key requests
#NEYNAR_SPONSOR_SIGNERS="false" # "true" lets Neynar pay the on-chain signer fee (billed to your Neynar credits); otherwise the user pays in Warpcast
# Deep link scheme the mobile app is sent back to after OAuth login.
# MOBILE_APP_SCHEME="postiz://auth/callback" # default value
# =============================================================================
# Background jobs (Temporal)
# =============================================================================
# TEMPORAL_ADDRESS="localhost:7233" # default value
# TEMPORAL_NAMESPACE="default" # default value
#TEMPORAL_TLS="false"
#TEMPORAL_API_KEY=""
# Run the recurring cron workflows on this instance.
#RUN_CRON=true
# Queues this worker server should NOT run, comma-separated. Use it to pin a
# queue to a single server: exclude it everywhere except the owning server.
#EXCLUDE_QUEUE="reddit,x,twitch"
# How many worker servers share each queue. Per-server concurrency is divided
# by this so the global concurrency stays correct. Default 1.
#WORKER_CONCURRENCY_DIVIDER=1
# =============================================================================
# Social media providers
# =============================================================================
X_URL=""
X_API_KEY=""
X_API_SECRET=""
# Strip links out of X posts (avoids the reach penalty).
#STRIP_LINKS_FROM_X_POSTS=true
# Hide the analytics tab for X channels (the endpoint needs a paid API tier).
#DISABLE_X_ANALYTICS=true
LINKEDIN_CLIENT_ID=""
LINKEDIN_CLIENT_SECRET=""
REDDIT_CLIENT_ID=""
REDDIT_CLIENT_SECRET=""
GITHUB_CLIENT_ID=""
GITHUB_CLIENT_SECRET=""
THREADS_APP_ID=""
THREADS_APP_SECRET=""
FACEBOOK_APP_ID=""
FACEBOOK_APP_SECRET=""
INSTAGRAM_APP_ID=""
INSTAGRAM_APP_SECRET=""
YOUTUBE_CLIENT_ID=""
YOUTUBE_CLIENT_SECRET=""
# Google Business Profile - falls back to the YOUTUBE_* credentials when unset.
GOOGLE_GMB_CLIENT_ID=""
GOOGLE_GMB_CLIENT_SECRET=""
TIKTOK_CLIENT_ID=""
TIKTOK_CLIENT_SECRET=""
TIKTOK_BUSINESS_CLIENT_ID=""
TIKTOK_BUSINESS_CLIENT_SECRET=""
PINTEREST_CLIENT_ID=""
PINTEREST_CLIENT_SECRET=""
DRIBBBLE_CLIENT_ID=""
DRIBBBLE_CLIENT_SECRET=""
TUMBLR_CLIENT_ID=""
TUMBLR_CLIENT_SECRET=""
DISCORD_CLIENT_ID=""
DISCORD_CLIENT_SECRET=""
DISCORD_BOT_TOKEN_ID=""
SLACK_ID=""
SLACK_SECRET=""
SLACK_SIGNING_SECRET=""
MASTODON_URL="https://mastodon.social"
MASTODON_CLIENT_ID=""
MASTODON_CLIENT_SECRET=""
TWITCH_CLIENT_ID=""
TWITCH_CLIENT_SECRET=""
KICK_CLIENT_ID=""
KICK_SECRET=""
WHOP_CLIENT_ID=""
VK_ID=""
MEWE_APP_ID=""
MEWE_API_KEY=""
# MEWE_HOST="https://mewe.com" # default value
TELEGRAM_TOKEN=""
TELEGRAM_BOT_NAME=""
# --- Newsletter providers
BEEHIIVE_API_KEY=""
BEEHIIVE_PUBLICATION_ID=""
LISTMONK_DOMAIN=""
LISTMONK_USER=""
LISTMONK_API_KEY=""
LISTMONK_LIST_ID=""
#LISTMONK_WELCOME_TEMPLATE_ID=""
# --- Provider visibility / migration
# HIDDEN_PROVIDERS="tiktok" # comma-separated identifiers hidden from the add-channel screen
# MIGRATE_PROVIDERS="tiktok:tiktok-business" # comma-separated "old:new" pairs, a reconnect of "old" goes through "new" and the channel is migrated in place
# =============================================================================
# AI & media generation
# =============================================================================
OPENAI_API_KEY=""
# Web search tool for the AI agent.
#TAVILY_API_KEY=""
# Text-to-speech for generated slideshow videos.
#ELEVENSLABS_API_KEY=""
# fal.ai - image generation for slideshow videos.
#FAL_KEY=""
# EvoLink API key for Seedance AI video generation (https://evolink.ai).
#EVOLINK_API_KEY=""
# Polotno design editor API key.
NEXT_PUBLIC_POLOTNO=""
# =============================================================================
# MCP, agent & extension
# =============================================================================
# Public MCP endpoint shown to users in the app.
#MCP_URL=""
# Serve only the MCP routes from this instance (no REST controllers).
#MCP_ONLY=false
# OAuth client configured for the ChatGPT app. Only this client can receive
# verified user email claims for ChatGPT Enterprise domain restrictions.
OPENAI_OAUTH_CLIENT_ID=""
# Value returned from the ChatGPT app domain-verification challenge endpoint.
#OPENAI_APP_CHALLANGE=""
# Client id of the OAuth app (Settings > Developers) that HubSpot agents
# connect with. HubSpot sends no client secret, so this one app uses PKCE
# instead, gets a refresh token, and the MCP backend answers OAuth discovery
# at its domain root. Set it on both the API and the MCP backend.
# HUBSPOT_OAUTH_CLIENT_ID=""
# Client id and secret of the HubSpot app itself (HubSpot project > app >
# Auth tab), not of the Postiz app above. Its redirect URL is
# <NEXT_PUBLIC_BACKEND_URL>/oauth/hubspot/callback, which finishes the install
# (HubSpot only counts it once the code is exchanged). Set them on the API.
# HUBSPOT_APP_CLIENT_ID=""
# HUBSPOT_APP_CLIENT_SECRET=""
# MCP OAuth Dynamic Client Registration (RFC 7591) redirect-domain allowlist.
# When set (comma separated), POST /oauth/register only accepts redirect_uris
# whose host matches a listed domain or one of its subdomains; unset or empty
# means any client can self-register. Only https callbacks are checked:
# loopback (http://localhost:8787/callback - Grok, Claude Code) and
# private-use scheme callbacks (cursor://...) stay on the user's machine
# and are always accepted. Example locks web callbacks to the claude.ai
# connector; add cursor.com for Cursor.
# DCR_VERIFIED_DOMAINS="claude.ai,claude.com"
# Postiz Cloud only: lets people connect a self-hosted Postiz on the MCP
# consent screen ("Use self-hosted"). The MCP tool calls of that connection
# are relayed to the instance with its API key. Leave unset on self-hosted
# installs; set it on both the API and the MCP backend.
# MCP_SELF_HOSTED_RELAY=true
# Shared secret for the internal agent endpoint on the public API.
#AGENT_API_KEY=""
# Shared secret used to sign SSO handoffs into the media agent.
#AGENT_MEDIA_SSO_KEY=""
# Chrome Extension Settings (for cookie-based platform integrations like Skool)
EXTENSION_ID=""
# =============================================================================
# Short link services
# =============================================================================
# DUB_TOKEN="" # Your self-hosted Dub API token
# DUB_API_ENDPOINT="https://api.dub.co" # Your self-hosted Dub API endpoint
# DUB_SHORT_LINK_DOMAIN="dub.sh" # Your self-hosted Dub domain
# SHORT_IO_SECRET_KEY="" # Your Short.io API secret key
# KUTT_API_KEY="" # Your Kutt.it API key
# KUTT_API_ENDPOINT="https://kutt.it/api/v2" # Your self-hosted Kutt API endpoint
# KUTT_SHORT_LINK_DOMAIN="kutt.it" # Your self-hosted Kutt domain
# LINK_DRIP_API_KEY="" # Your LinkDrip API key
# LINK_DRIP_API_ENDPOINT="https://api.linkdrip.com/v1/" # Your self-hosted LinkDrip API endpoint
# LINK_DRIP_SHORT_LINK_DOMAIN="dripl.ink" # Your self-hosted LinkDrip domain
# =============================================================================
# Preview comments (anti-spam)
# =============================================================================
# reCAPTCHA Settings (invisible v2 on anonymous preview comments, optional; unset = no captcha)
# RECAPTCHA_SITE_KEY="" # Your reCAPTCHA v2 invisible site key
# RECAPTCHA_SECRET_KEY="" # Your reCAPTCHA v2 invisible secret key
# =============================================================================
# Payments (Stripe & RevenueCat)
# =============================================================================
FEE_AMOUNT=0.05
STRIPE_PUBLISHABLE_KEY=""
STRIPE_SECRET_KEY=""
STRIPE_SIGNING_KEY=""
STRIPE_SIGNING_KEY_CONNECT=""
# Coupon applied to new subscriptions.
#STRIPE_DISCOUNT_ID=""
# RevenueCat (App Store / Google Play subscriptions from the mobile app).
# Webhook URLs: {BACKEND_URL}/payment/stripe and {BACKEND_URL}/payment/revenuecat, Authorization header value = REVENUECAT_WEBHOOK_SECRET.
REVENUECAT_SECRET_KEY=""
REVENUECAT_WEBHOOK_SECRET=""
# Reject purchases made in the App Store / Play sandbox environment.
#IN_APP_PURCHASE_REJECT_SANDBOX=true
# =============================================================================
# Analytics & support widgets
# =============================================================================
#NEXT_PUBLIC_GTM_ID=""
#NEXT_PUBLIC_TRACKING_TRIAL=""
#NEXT_PUBLIC_FACEBOOK_PIXEL=""
#FACEBOOK_PIXEL_ACCESS_TOKEN=""
#NEXT_PUBLIC_POSTHOG_KEY=""
#NEXT_PUBLIC_POSTHOG_HOST=""
#DATAFAST_WEBSITE_ID=""
#DATAFAST_API_KEY=""
# Chatbase support widget secret (also toggles the widget on).
#CHATBASE_TOKEN=""
NEXT_PUBLIC_DISCORD_SUPPORT=""
# =============================================================================
# Error reporting (Sentry)
# =============================================================================
#NEXT_PUBLIC_SENTRY_DSN=""
#NEXT_PUBLIC_APP_VERSION=""
# Set to "1" to send events to a local Spotlight instance instead.
#SENTRY_SPOTLIGHT=""
# Build-time only - used to upload source maps.
#SENTRY_ORG=""
#SENTRY_PROJECT=""
#SENTRY_AUTH_TOKEN=""
# =============================================================================
# Security
# =============================================================================
# When connecting providers that take a self-hosted URL (WordPress, Mastodon,
# Lemmy, Listmonk, Bluesky PDS, etc.) Postiz fetches that URL server-side and
# blocks requests that resolve to private/internal/loopback/link-local IPs to
# prevent SSRF. Set to true ONLY if your Postiz instance must reach those
# services on a trusted private network (e.g. same Docker network or VPC).
# DISABLE_SSRF_PROTECTION=false
# Serve auth cookies without the Secure flag. Only for plain-HTTP local dev.
# NOT_SECURED=false
API_LIMIT=30 # The limit of the public API hour limit
# =============================================================================
# Deploy gate (pnpm test:e2e:prod)
# =============================================================================
# Runs e2e/prod against an already-deployed Postiz instead of a local stack, to
# decide whether a deployment is allowed to go to production. Every tier is
# opt-in: with none of these set the suite skips entirely and passes.
#
# Tier 1 - reachability and public-API auth rejection. Backend base URL, no
# trailing slash. Default: unset (whole suite skipped).
#POSTIZ_SMOKE_URL=""
# Tier 2 - adds authenticated read-only checks and a draft create/list/delete
# round-trip. A public API key for the org used for smoke testing. No external
# side effects. Default: unset (tier 2 and 3 skipped).
#POSTIZ_SMOKE_API_KEY=""
# Tier 3 - REALLY PUBLISHES to real social accounts. Comma-separated Postiz
# channel (integration) ids, as returned by GET /public/v1/integrations. Postiz
# can delete its own record afterwards but cannot retract the post from the
# network, so only name throwaway accounts kept for this. The gate posts text
# only with empty settings, so name channels whose provider needs no extra
# per-post settings - a provider that requires e.g. a subreddit or a video
# title will reject the post. Default: unset (tier 3 skipped).
#POSTIZ_SMOKE_PUBLISH_CHANNELS=""
# =============================================================================
# Developer Settings
# =============================================================================
NX_ADD_PLUGINS=false
IS_GENERAL="true" # required for now
# Version string shown in the app footer.
#NEXT_PUBLIC_VERSION=""