.env.example

#-----------------------Backend Config------------------------------#
# Prisma Config
DATABASE_URL=postgresql://postgres:testpass@hoppscotch-db:5432/hoppscotch

# Sensitive Data Encryption Key while storing in Database (32 character)
DATA_ENCRYPTION_KEY=data encryption key with 32 char

# Whitelisted origins for the Hoppscotch App.
# This list controls which origins can interact with the app through cross-origin comms.
# - localhost ports (3170, 3000, 3100): app, backend, development servers and services
# - app://localhost_3200: Bundle server origin identifier
#   NOTE: `3200` here refers to the bundle server (port 3200) that provides the bundles,
#   NOT where the app runs. The app itself uses the `app://` protocol with dynamic
#   bundle names like `app://{bundle-name}/`
WHITELISTED_ORIGINS=http://localhost:3170,http://localhost:3000,http://localhost:3100,app://localhost_3200,app://hoppscotch

# Optional: Default proxy URL offered to clients when proxying is enabled.
# Clients control whether requests are proxied via the in-app toggle; this only
# sets which URL they default to. Remove the variable to configure it solely
# from the admin dashboard.
PROXY_APP_URL="https://proxy.hoppscotch.io"

# If true, the client’s IP address is understood as the left-most entry in the X-Forwarded-For header
TRUST_PROXY=false

#-----------------------Frontend Config------------------------------#

# Base URLs
VITE_BASE_URL=http://localhost:3000
VITE_SHORTCODE_BASE_URL=http://localhost:3000
VITE_ADMIN_URL=http://localhost:3100

# Backend URLs
VITE_BACKEND_GQL_URL=http://localhost:3170/graphql
VITE_BACKEND_WS_URL=ws://localhost:3170/graphql
VITE_BACKEND_API_URL=http://localhost:3170/v1

# Terms Of Service And Privacy Policy Links (Optional)
VITE_APP_TOS_LINK=https://docs.hoppscotch.io/support/terms
VITE_APP_PRIVACY_POLICY_LINK=https://docs.hoppscotch.io/support/privacy

# Set default to null as https://proxy.hoppscotch.io/ doesn't require an access token
VITE_PROXYSCOTCH_ACCESS_TOKEN=

# Set to `true` for subpath based access
ENABLE_SUBPATH_BASED_ACCESS=false

#-----------------------Container Runtime Config---------------------#

# Caddy's in-container HTTP port (default 80). Set a free port (e.g. 8000) to run
# under a non-root UID like OpenShift (ports < 1024 need root or CAP_NET_BIND_SERVICE),
# and update your published mapping too. Avoid internal ports 8080, 3200, 3000, 3100,
# 3170. Non-root runs expect GID 0. On the AIO image this applies only when
# ENABLE_SUBPATH_BASED_ACCESS=true; the legacy HOPP_AIO_ALTERNATE_PORT is honoured
# there as a fallback.
# HOPP_ALTERNATE_PORT=8000