.env.sample

# ==============================================================================
#                          AIOStreams - .env
# ==============================================================================
# AIOStreams has TWO kinds of configuration:
#
#   1. BOOTSTRAP variables (this file) - read from the environment only, before
#      the database is available. They configure the things needed to start the
#      process (server, database, encryption, operator auth, logging).
#      These MUST be set here and cannot be changed from the dashboard.
#
#   2. RUNTIME settings - everything else (branding, presets, built-ins, proxy,
#      caching, rate limits, limits, metadata, …). These are stored in the
#      database and are best configured from the dashboard Settings page, where
#      they can be edited live and validated. Every runtime setting still has a
#      matching environment variable; setting it here locks that value (the
#      field becomes read-only in the UI). Only do that if you specifically want
#      an immutable, env-pinned value.
#
# Full reference for every variable (bootstrap AND runtime):
#   https://docs.aiostreams.viren070.me/configuration/environment-variables
#
# Upgrading from an older version? Read:
#   https://docs.aiostreams.viren070.me/migrations/v2.30
# ==============================================================================


# ==============================================================================
#                            ESSENTIAL (REQUIRED)
# ==============================================================================

# The base URL of your addon, including protocol and hostname (and port if not
# behind a reverse proxy). REQUIRED. Used for generating installation URLs,
# self-scraping detection, genre links, and built-in addon stream URLs.
# Example: https://aiostreams.yourdomain.com
BASE_URL=

# CRITICAL: secret used to encrypt stored addon configurations.
# MUST be a 64-character hex string. Cannot be changed after first run
# (doing so makes existing encrypted configs undecryptable).
# Generate one:
#   Linux/macOS:          openssl rand -hex 32
#   Windows (PowerShell): -join ((0..31) | ForEach-Object { '{0:x2}' -f (Get-Random -Minimum 0 -Maximum 255) })
# (The legacy alias SESSION_SECRET is still accepted for one minor release.)
SECRET_KEY=

# REQUIRED: database URI for storing addon configuration.
# Supports SQLite (simplest) or PostgreSQL.
#   SQLite:     DATABASE_URI=sqlite://./data/db.sqlite
#   PostgreSQL: DATABASE_URI=postgres://user:password@host:port/database_name
DATABASE_URI=sqlite://./data/db.sqlite


# ==============================================================================
#                                 SERVER
# ==============================================================================

# The port the addon listens on.
# PORT=3000

# Optionally override the internal URL used when communicating with built-in
# addons. The default is fine for almost all setups.
# INTERNAL_URL=http://localhost:3000

# Node environment: production (default), development, or test.
# NODE_ENV=production

# Allow the dashboard System page to stop the AIOStreams process.
# SYSTEM_LIFECYCLE_ENABLED=false


# ==============================================================================
#                    REDIS (optional — scaled deployments)
# ==============================================================================
# Only recommended when running multiple instances (e.g. Docker Swarm).
# For standard single-container setups, leave this blank — AIOStreams uses a
# faster internal memory cache that is more than sufficient.
# REDIS_URI=redis://your_redis_hostname:6379
# Redis client connect timeout in milliseconds.
# REDIS_TIMEOUT=5000

# How often (seconds) each instance polls the DB settings version and reloads
# runtime config if another instance changed a setting via the dashboard.
# Keeps multi-instance deployments consistent. Set 0 to disable on
# single-instance setups.
# SETTINGS_REFRESH_INTERVAL=30


# ==============================================================================
#                          OPERATOR AUTHENTICATION
# ==============================================================================
# Credentials for this AIOStreams instance. Comma-separated username:password pairs.
# e.g. user1:pass1,user2:pass2
# AIOSTREAMS_AUTH=

# Comma-separated list of usernames (defined above) that are admins. Leave
# blank/unset to make all users admins. Admins can access the configure page and
# admin-only endpoints (proxy stats, proxy URL generation).
# AIOSTREAMS_AUTH_ADMINS=

# Comma-separated list of usernames (defined above) allowed to use the built-in
# proxy. Leave blank/unset to allow all authenticated users to use the proxy.
# Users not listed here can still log in and access the configure page if 
# auth required is enabled.
# e.g. proxyuser1,proxyuser2
# AIOSTREAMS_AUTH_PROXY=

# Per-user connection limits. Comma-separated username:limit pairs
# (use -1 or 0 for unlimited).
# AIOSTREAMS_AUTH_CONNECTIONS_LIMIT=


# ==============================================================================
#                            PRE-DB LOGGING
# ==============================================================================
# These configure the logger.

# error | warn | info | http | verbose | debug | silly
# LOG_LEVEL=info

# text | json   (json is recommended for production)
# LOG_FORMAT=json

# In-memory buffer of recent log lines for the dashboard Logs page.
# LOG_BUFFER_MAX_BYTES=67108864
# LOG_BUFFER_MAX_ENTRIES=200000


# ==============================================================================
#                          EVERYTHING ELSE
# ==============================================================================
# All other settings — addon name/ID, presets, built-in addons, debrid/service
# credentials, stream proxy, caching, rate limits, user limits, metadata, etc.
# - are runtime settings. Configure them from the dashboard Settings page.
#
# If you must pin one via the environment, find its variable name, format, and
# default in the reference:
#   https://docs.aiostreams.viren070.me/configuration/environment-variables
# ==============================================================================