DockFlare/env.example

88 lines
No EOL
2.7 KiB
Text

# .env: DockFlare Tunnel Manager Configuration
# -----------------------------------------------------------------------------
# Create a copy of this file named '.env' in the project root.
# DO NOT commit the real .env file to version control!
# -----------------------------------------------------------------------------
# REQUIRED CLOUDFLARE CREDENTIALS
# ==============================
# Generate API Token at: https://dash.cloudflare.com/profile/api-tokens
# Required permissions:
# - Account > Cloudflare Tunnel > Edit
# - Zone > DNS > Edit
# Cloudflare API Token (REQUIRED)
CF_API_TOKEN=your_cloudflare_api_token
# Cloudflare Account ID (REQUIRED)
# Find in Cloudflare dashboard URL: https://dash.cloudflare.com/ACCOUNT_ID
CF_ACCOUNT_ID=your_cloudflare_account_id
# Cloudflare Zone ID (REQUIRED for DNS management)
# Find in Overview tab of your domain
CF_ZONE_ID=your_cloudflare_zone_id
# TUNNEL CONFIGURATION
# ===================
# Tunnel Name (REQUIRED unless using external cloudflared)
# This will be created automatically if it doesn't exist
TUNNEL_NAME=your_tunnel_name
# External Cloudflared Configuration (OPTIONAL)
# Set to true if you're managing cloudflared yourself
USE_EXTERNAL_CLOUDFLARED=false
# Required if USE_EXTERNAL_CLOUDFLARED=true
EXTERNAL_TUNNEL_ID=your_external_tunnel_id
# DOCKER CONFIGURATION
# ==================
# Docker Network Name (used for internal cloudflared mode)
CLOUDFLARED_NETWORK_NAME=cloudflare-net
# Cloudflared Container Name (auto-generated if not specified)
# Default: cloudflared-agent-{TUNNEL_NAME}
CLOUDFLARED_CONTAINER_NAME=cloudflared-agent-your_tunnel_name
# BEHAVIOR SETTINGS
# ===============
# Label Prefix for Docker Containers
# All labels will start with this prefix
LABEL_PREFIX=cloudflare.tunnel
# Grace Period for Rule Deletion (in seconds)
# How long to keep rules after container stops (default: 8 hours)
GRACE_PERIOD_SECONDS=28800
# Cleanup Interval (in seconds)
# How often to check for rules to delete
CLEANUP_INTERVAL_SECONDS=300
# Agent Status Update Interval (in seconds)
# How often to check cloudflared agent status
AGENT_STATUS_UPDATE_INTERVAL_SECONDS=10
# State File Path (where to save tunnel state)
STATE_FILE_PATH=/app/data/state.json
# Enable Scanning All Docker Networks (default: false)
# Set to true to discover containers across all networks
SCAN_ALL_NETWORKS=false
# PROXY SETTINGS
# ============
# Trusted Proxies
# IP ranges that are trusted to provide X-Forwarded-* headers
# Comma-separated list of IPs or CIDR ranges
TRUSTED_PROXIES=172.16.0.0/12,192.168.0.0/16
# TLS VERIFICATION
# ==============
# Default TLS Verification Setting
# When true, skip TLS verification for all origin services by default
DEFAULT_NO_TLS_VERIFY=false