DockFlare/env.example
ChrispyBacon-dev 39ae9767fa .
2025-04-14 09:11:45 +02:00

32 lines
No EOL
1.6 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).
# -----------------------------------------------------------------------------
# REQUIRED: Cloudflare API Token
# Get this from the Cloudflare Dashboard: My Profile -> API Tokens -> Create Token
# Use a template or create a custom token with permissions:
# - Account Scope: Cloudflare Tunnel: Edit
# (Or potentially Zone Scope: DNS:Edit, Tunnel:Edit if managing DNS records later)
# Example: Zx......................................bY
CF_API_TOKEN=YOUR_CLOUDFLARE_API_TOKEN_HERE
# REQUIRED: Desired Cloudflare Tunnel Name
# This is the name that will appear in the Cloudflare dashboard for the tunnel.
# The script will check if a tunnel with this name exists, and create it if not.
# Use only letters, numbers, and hyphens.
# Example: my-cool-app-tunnel
TUNNEL_NAME=my-automated-tunnel
# OPTIONAL: Docker Container Name for the Cloudflared Agent
# This is the name given to the Docker container that runs 'cloudflared tunnel run'.
# If commented out or not set, the application (app.py) will default to: 'cloudflared-agent-<TUNNEL_NAME>'
# Example: CLOUDFLARED_CONTAINER_NAME=my-personal-cf-runner
# CLOUDFLARED_CONTAINER_NAME=
CF_API_TOKEN=YOUR_CLOUDFLARE_API_TOKEN_HERE
TUNNEL_NAME=my-automated-tunnel
CF_ACCOUNT_ID=YOUR_CLOUDFLARE_ACCOUNT_ID_HERE
# CLOUDFLARED_CONTAINER_NAME= # Optional
# CF_ZONE_ID=YOUR_CLOUDFLARE_ZONE_ID_HERE # Needed later if doing explicit DNS