Ngrok Configuration Reference

from django_cfg import DjangoConfig, NgrokConfig
 
class MyConfig(DjangoConfig):
    project_name: str = "My Project"
 
    # Enable ngrok for webhook development
    ngrok: NgrokConfig = NgrokConfig(
        enabled=True,  # Enable ngrok (only in DEBUG=True)
        authtoken="${NGROK_AUTHTOKEN}",  # Optional: from env var automatically if omitted
    )
 
config = MyConfig()

from django_cfg import NgrokConfig
 
ngrok: NgrokConfig = NgrokConfig(
    enabled=True,
    authtoken="${NGROK_AUTHTOKEN}",  # Load from NGROK_AUTHTOKEN env var
)

ngrok: NgrokConfig = NgrokConfig(
    enabled=True,
    authtoken="your_ngrok_token_here",
)

ngrok: NgrokConfig = NgrokConfig(
    enabled=True,
    basic_auth=["admin:secret"],  # Format: ["user:pass"]
    compression=True,
)

import os
 
# Get tunnel URL
ngrok_url = os.environ.get('NGROK_URL')  # "https://abc123.ngrok.io"
 
# Build webhook URL
webhook_url = f"{ngrok_url}/api/webhooks/stripe/"

# Ngrok auth token (optional, for paid features)
export NGROK_AUTHTOKEN="your_ngrok_token"

from django_cfg import DjangoConfig, NgrokConfig
from .environment import env
 
class MyConfig(DjangoConfig):
    # Ngrok only in development
    ngrok: NgrokConfig = NgrokConfig(
        enabled=(env.environment == "development"),
    )

from django_cfg import NgrokConfig
 
ngrok: NgrokConfig = NgrokConfig(
    enabled=True,
    # authtoken is None → automatically reads NGROK_AUTHTOKEN at tunnel start
    compression=True,
)

ngrok: NgrokConfig = NgrokConfig(
    enabled=True,
    basic_auth=["admin:supersecret"],
)

from .environment import env
 
class MyConfig(DjangoConfig):
    ngrok: NgrokConfig = NgrokConfig(
        enabled=(env.environment == "development"),
    )
 
    # Use real URL in prod
    api_url: str = (
        "https://api.myapp.com"
        if env.environment == "production"
        else "http://localhost:8000"
    )

# ✅ CORRECT - omit authtoken; NGROK_AUTHTOKEN env var is read automatically
ngrok: NgrokConfig = NgrokConfig(
    enabled=True,
)
 
# ❌ WRONG - hardcode token
ngrok: NgrokConfig = NgrokConfig(
    enabled=True,
    authtoken="hardcoded-token",  # Security risk!
)

# ✅ CORRECT - automatically disabled in production (validator enforces DEBUG=True)
ngrok: NgrokConfig = NgrokConfig(
    enabled=True,
)
 
# Even better - explicit environment check
from .environment import env
 
ngrok: NgrokConfig = NgrokConfig(
    enabled=(env.environment == "development"),
)

# ✅ CORRECT - use Pydantic model
from django_cfg import NgrokConfig
 
ngrok: NgrokConfig = NgrokConfig(
    enabled=True,
    compression=True,
)
 
# ❌ WRONG - raw Django settings
# NGROK_ENABLED = True  # No validation!

# ❌ Raises ValidationError — cannot enable ngrok in production (DEBUG=False)
ngrok: NgrokConfig = NgrokConfig(
    enabled=True,  # ValidationError if DEBUG is False
)
 
# ✅ Correct — enable only in development
ngrok: NgrokConfig = NgrokConfig(
    enabled=(env.environment == "development"),
)