DockFlare/env.example
ChrispyBacon-dev 4cc9001ded updates
2025-04-14 13:58:32 +02:00

32 lines
No EOL
1.9 KiB
Text

# -----------------------------------------------------------------------------
# Environment variables for the Cloudflare Tunnel Manager application
#
# IMPORTANT: Create this file as '.env' in the project root directory.
# DO NOT commit this file to version control (like Git).
# -----------------------------------------------------------------------------
# Cloudflare API Token: Required to authenticate with the Cloudflare API.
# - You can generate a token with the necessary permissions (e.g., Tunnel access, DNS management)
# at https://dash.cloudflare.com/profile/api-tokens.
# - It is HIGHLY recommended to use a token with *limited* permissions to minimize security risk.
CF_API_TOKEN=your_api_token_here
# Tunnel Name: The name you want to give your Cloudflare Tunnel. This should be a descriptive name.
# - It should be unique within your Cloudflare account.
# - This name will be used to identify the tunnel in the Cloudflare dashboard.
TUNNEL_NAME=your_tunnel_name
# Cloudflare Account ID: Your Cloudflare account identifier.
# - Found on the Cloudflare dashboard, typically a long hexadecimal string.
# - This is necessary for identifying your account when interacting with the Cloudflare API.
CF_ACCOUNT_ID=your_account_id_here
# Cloudflare Zone ID: The identifier for the specific domain/zone you want to use with the tunnel.
# - Found on the Cloudflare dashboard under the "Overview" tab for your domain.
# - This ensures the tunnel is linked to the correct domain for routing traffic.
CF_ZONE_ID=your_zone_id_here
# Path to State File: Where the application stores its state (e.g., tunnel connection status, configuration).
# - Make sure the application has read/write access to this path.
# - Consider using a persistent volume if running in a containerized environment (e.g., Docker) to preserve the state.
STATE_FILE_PATH=/app/data/state.json