Skip to main content
Development preview — this is not a live application; it is still being built.
ProxmoxVEx
↑ ↓ to navigate Enter to open

Environment variable reference

Every PROXMOXVEX/config variable the code reads, its default, and

Every PROXMOXVEX_*/config variable the code reads, its default, and where it is read. Regenerate with python3 scripts/gen_env_docs.py.

Generated by scripts/gen_env_docs.py — do not edit inside the markers.

Variable Default Read in
CREDENTIALS_DIRECTORY (required) ../ProxmoxVEx/ProxmoxVEx/core/keystore.py
GEVENT_DEBUG (required) ../ProxmoxVEx/ProxmoxVEx/app.py
GITHUB_TOKEN `` ../ProxmoxVEx/ProxmoxVEx/constants.py, ../ProxmoxVEx/ProxmoxVEx/updater/__main__.py, ../ProxmoxVEx/ProxmoxVEx/updater/uploader.py
HTTP_UPGRADE NONE ../ProxmoxVEx/ProxmoxVEx/api/vms/console.py
LICENCE_SERVICE_API_KEY `` ../ProxmoxVEx/ProxmoxVEx/services/licensing.py, ../ProxmoxVEx/ProxmoxVEx/services/plugin_delivery.py
LICENCE_SERVICE_URL https://licensing.proxmoxvex.com ../ProxmoxVEx/ProxmoxVEx/services/firewall_feed.py, ../ProxmoxVEx/ProxmoxVEx/services/licensing.py, ../ProxmoxVEx/ProxmoxVEx/services/plugin_delivery.py
PATH_INFO `` ../ProxmoxVEx/ProxmoxVEx/app.py
PGDATABASE proxmoxvex ../ProxmoxVEx/ProxmoxVEx/core/db.py, ../ProxmoxVEx/ProxmoxVEx/core/db_pg.py
PGHOST localhost ../ProxmoxVEx/ProxmoxVEx/core/db.py, ../ProxmoxVEx/ProxmoxVEx/core/db_pg.py
PGPASSWORD proxmoxvex ../ProxmoxVEx/ProxmoxVEx/core/db.py, ../ProxmoxVEx/ProxmoxVEx/core/db_pg.py
PGPORT 5432 ../ProxmoxVEx/ProxmoxVEx/core/db.py, ../ProxmoxVEx/ProxmoxVEx/core/db_pg.py
PGUSER proxmoxvex ../ProxmoxVEx/ProxmoxVEx/core/db.py, ../ProxmoxVEx/ProxmoxVEx/core/db_pg.py
PROXMOXVEX_ALLOWED_ORIGINS `` ../ProxmoxVEx/ProxmoxVEx/globals.py
PROXMOXVEX_ANALYTICS_INGEST_URL `` ../ProxmoxVEx/ProxmoxVEx/services/firewall_feed.py
PROXMOXVEX_API_RATE_LIMIT 1200 ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_API_RATE_WINDOW 60 ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_BEHIND_PROXY `` ../ProxmoxVEx/ProxmoxVEx/api/helpers.py, ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_BIND_ALL `` ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_CONFIG_DIR `` ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_DATABASE_URL f"postgresql://{os.environ.get('PGUSER', 'proxmoxvex')}:{os.environ.get('PGPASSWORD', 'proxmoxvex')}@{os.environ.get('PGHOST', 'localhost')}:{os.environ.get('PGPORT', '5432')}/{os.environ.get('PGDATABASE', 'proxmoxvex')}" ../ProxmoxVEx/ProxmoxVEx/core/db.py, ../ProxmoxVEx/ProxmoxVEx/core/db_pg.py
PROXMOXVEX_DB_KEY (required) ../ProxmoxVEx/ProxmoxVEx/core/keystore.py
PROXMOXVEX_DEMO_ALLOWED_ORIGINS `` ../ProxmoxVEx/ProxmoxVEx/demo/__init__.py
PROXMOXVEX_DEMO_FIXTURE_DIR `` ../ProxmoxVEx/ProxmoxVEx/demo/cluster_mock.py
PROXMOXVEX_DEMO_MODE `` ../ProxmoxVEx/ProxmoxVEx/native/config_persist.py, ../ProxmoxVEx/ProxmoxVEx/services/licensing.py
PROXMOXVEX_DEMO_RESET_INTERVAL 900 ../ProxmoxVEx/ProxmoxVEx/demo/__init__.py
PROXMOXVEX_DEMO_TOKEN_SECRET demo-secret-change-in-production ../ProxmoxVEx/ProxmoxVEx/demo/__init__.py
PROXMOXVEX_DISABLE_FILE_LOG `` ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_DIST_DIR str(root / 'dist') ../ProxmoxVEx/ProxmoxVEx/api/mirror.py
PROXMOXVEX_FILE_LOG_LEVEL `` ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_FIREWALL_BLOCKLIST_URL `` ../ProxmoxVEx/ProxmoxVEx/services/firewall_feed.py
PROXMOXVEX_FIREWALL_KEY `` ../ProxmoxVEx/ProxmoxVEx/services/firewall_feed.py
PROXMOXVEX_HA `` ../ProxmoxVEx/ProxmoxVEx/background/__init__.py
PROXMOXVEX_HARDWARE_ID `` ../ProxmoxVEx/ProxmoxVEx/services/licensing.py
PROXMOXVEX_HEAVY_READ_CONCURRENCY 4 ../ProxmoxVEx/ProxmoxVEx/core/dbcrypto.py
PROXMOXVEX_HEAVY_READ_TTL 60 ../ProxmoxVEx/ProxmoxVEx/core/dbcrypto.py
PROXMOXVEX_HOST (required) ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_HTTP_PORT http_redirect_port ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_KEY_FILE (required) ../ProxmoxVEx/ProxmoxVEx/core/keystore.py
PROXMOXVEX_LOG_BACKUPS `` ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_LOG_FORMAT (required) ../ProxmoxVEx/ProxmoxVEx/utils/json_logging.py
PROXMOXVEX_LOG_LEVEL `` ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_LOG_MAX_BYTES `` ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_MACHINE_ID `` ../ProxmoxVEx/ProxmoxVEx/services/licensing.py
PROXMOXVEX_MAX_BROADCAST_BYTES str(5000000) ../ProxmoxVEx/ProxmoxVEx/utils/realtime.py
PROXMOXVEX_MAX_REQUEST_SIZE 10 * 1024 * 1024 ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_MAX_UPLOAD_SIZE 100 * 1024 * 1024 * 1024 ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_METRICS_RETENTION_DAYS 30 ../ProxmoxVEx/ProxmoxVEx/background/metrics.py
PROXMOXVEX_NODE_FINGERPRINT `` ../ProxmoxVEx/ProxmoxVEx/services/licensing.py
PROXMOXVEX_NODE_POOL_SIZE 100 ../ProxmoxVEx/ProxmoxVEx/core/manager.py, ../ProxmoxVEx/ProxmoxVEx/utils/concurrent.py
PROXMOXVEX_NODE_STATUS_TTL 5 ../ProxmoxVEx/ProxmoxVEx/core/manager.py
PROXMOXVEX_PKG_BASE (required) ../ProxmoxVEx/ProxmoxVEx/api/.ssh_ws_server.py
PROXMOXVEX_PLUGINS_SEED /app/plugins-seed ../ProxmoxVEx/ProxmoxVEx/core/config.py
PROXMOXVEX_PORT (required) ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_PW_HASH_CONCURRENCY 8 ../ProxmoxVEx/ProxmoxVEx/utils/auth.py
PROXMOXVEX_REMOTE_TMP /tmp ../ProxmoxVEx/ProxmoxVEx/api/nodes.py, ../ProxmoxVEx/ProxmoxVEx/api/templates_lib.py
PROXMOXVEX_RESERVED_ADMIN ProxmoxVEx ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_SCHEDULED_CMD_ALLOWLIST `` ../ProxmoxVEx/ProxmoxVEx/background/scheduler.py
PROXMOXVEX_SERVER auto ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_SLOW_QUERY_MS `` ../ProxmoxVEx/ProxmoxVEx/core/db_pg.py
PROXMOXVEX_SSH_HOST_KEY_POLICY tofu ../ProxmoxVEx/ProxmoxVEx/utils/ssh.py
PROXMOXVEX_SSH_MAX_CONCURRENT 25 ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_SSH_WS_HOST (required) ../ProxmoxVEx/ProxmoxVEx/api/.ssh_ws_server.py
PROXMOXVEX_SSH_WS_PORT (required) ../ProxmoxVEx/ProxmoxVEx/api/.ssh_ws_server.py, ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_SSH_WS_SSL_CERT (required) ../ProxmoxVEx/ProxmoxVEx/api/.ssh_ws_server.py
PROXMOXVEX_SSH_WS_SSL_KEY (required) ../ProxmoxVEx/ProxmoxVEx/api/.ssh_ws_server.py
PROXMOXVEX_STATEMENT_TIMEOUT_MS 15000 ../ProxmoxVEx/ProxmoxVEx/core/db_pg.py
PROXMOXVEX_SYSLOG_BIND 127.0.0.1 ../ProxmoxVEx/ProxmoxVEx/background/syslog_server.py
PROXMOXVEX_SYSLOG_BIND_ALL `` ../ProxmoxVEx/ProxmoxVEx/background/syslog_server.py
PROXMOXVEX_SYSLOG_TCP_MAX 1024 ../ProxmoxVEx/ProxmoxVEx/background/syslog_server.py
PROXMOXVEX_SYSTEM_ACTOR system ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_TASKS_TTL 3 ../ProxmoxVEx/ProxmoxVEx/core/manager.py
PROXMOXVEX_TEST_FAST_INIT (required) ../ProxmoxVEx/ProxmoxVEx/core/db.py
PROXMOXVEX_TRUSTED_PROXIES `` ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_UPDATE_ARCHIVE_URL https://proxmoxvex.com/downloads/ProxmoxVEx-latest.tar.gz ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_UPDATE_RAW_URL https://raw.githubusercontent.com/ArMaTeC/proxmox-vex-public/main ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_UPDATE_REPO_URL https://github.com/ArMaTeC/proxmox-vex-public ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_UPDATE_VERSION_URL https://raw.githubusercontent.com/ArMaTeC/proxmox-vex-public/main/version.json ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_UPSTREAM_SLOW_MS `` ../ProxmoxVEx/ProxmoxVEx/core/manager.py
PROXMOXVEX_URL (required) ../ProxmoxVEx/ProxmoxVEx/api/.ssh_ws_server.py
PROXMOXVEX_VERIFY_SSL 1 ../ProxmoxVEx/ProxmoxVEx/api/.ssh_ws_server.py, ../ProxmoxVEx/ProxmoxVEx/constants.py
PROXMOXVEX_VMWARE_CONNECT_TIMEOUT 8 ../ProxmoxVEx/ProxmoxVEx/core/vmware.py
PROXMOXVEX_VMW_DETAIL_MAX 20 ../ProxmoxVEx/ProxmoxVEx/background/broadcast.py
PROXMOXVEX_VNC_CONNECT_TIMEOUT 15 ../ProxmoxVEx/ProxmoxVEx/api/vms/common.py
PROXMOXVEX_VNC_WS_PORT (required) ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_WEBHOOK_ALLOW_PRIVATE (required) ../ProxmoxVEx/ProxmoxVEx/services/webhooks.py
PROXMOXVEX_WORKERS max(32, cpu_count * 16) ../ProxmoxVEx/ProxmoxVEx/app.py
PROXMOXVEX_WS_FALLBACK_HOST 0.0.0.0 ../ProxmoxVEx/ProxmoxVEx/api/.ssh_ws_server.py, ../ProxmoxVEx/ProxmoxVEx/api/vms/common.py
SSH_WS_HOST 127.0.0.1 ../ProxmoxVEx/ProxmoxVEx/api/.ssh_ws_server.py
SSH_WS_PORT 5002 ../ProxmoxVEx/ProxmoxVEx/api/.ssh_ws_server.py
SSH_WS_SSL_CERT `` ../ProxmoxVEx/ProxmoxVEx/api/.ssh_ws_server.py
SSH_WS_SSL_KEY `` ../ProxmoxVEx/ProxmoxVEx/api/.ssh_ws_server.py
SUPPORT_COMMUNITY_URL f"{portal_url}#community" ../ProxmoxVEx/ProxmoxVEx/api/support.py
SUPPORT_PORTAL_URL https://support.proxmoxvex.com/portal ../ProxmoxVEx/ProxmoxVEx/api/support.py
SUPPORT_SERVICE_API_KEY `` ../ProxmoxVEx/ProxmoxVEx/api/support.py
SUPPORT_SERVICE_URL `` ../ProxmoxVEx/ProxmoxVEx/api/support.py
proxmoxvex.original_path request.path ../ProxmoxVEx/ProxmoxVEx/app.py
wsgi.websocket NONE ../ProxmoxVEx/ProxmoxVEx/api/vms/console.py

Was this page helpful?

ProxmoxVEx Source-Available License
Checking status…

© 2025-2026 ProxmoxVEx contributors