favicon-api/.env.example at main · vemetric/favicon-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# Favicon API Configuration

# ======================
# Server Configuration
# ======================
PORT=3000
HOST=0.0.0.0

# Redirect URL when no domain is specified (optional - for self-hosters)
# When not set, returns a 400 error instead of redirecting
# REDIRECT_URL=https://example.com/docs

# ======================
# Logging
# ======================
# Log level: debug, info, warn, error (default: debug in dev, info in production)
# LOG_LEVEL=info

# Axiom integration (optional - only for production)
# Get your credentials from https://app.axiom.co/
# AXIOM_DATASET=your-dataset-name
# AXIOM_TOKEN=xaat-your-api-token

# ======================
# Default Fallback Image
# ======================
# URL of the default image to return when no favicon is found
# Leave empty to return a 404 error instead
DEFAULT_IMAGE_URL=https://example.com/default-favicon.png

# Use Google's favicon API as fallback when primary fetch fails (true/false)
# When enabled, tries Google's API before using the default fallback image
USE_FALLBACK_API=true

# ======================
# HTTP Cache Headers (in seconds)
# ======================
# Applies to both browser and CDN caching
# 604800 seconds = 7 days

# Cache duration for successful favicon fetches and fallback images
CACHE_CONTROL_SUCCESS=604800

# Cache duration for error responses
CACHE_CONTROL_ERROR=604800

# ======================
# Request Handling
# ======================
# Timeout for external requests in milliseconds
REQUEST_TIMEOUT=5000

# Maximum image size to fetch in bytes (5MB default)
MAX_IMAGE_SIZE=5242880

# User agent for HTTP requests
USER_AGENT=FaviconAPI/1.0

# ======================
# CORS Configuration
# ======================
# Allowed origins (* for all, or comma-separated list)
ALLOWED_ORIGINS=*

# ======================
# Security
# ======================
# Block requests to private IP ranges (SSRF protection)
BLOCK_PRIVATE_IPS=true

# Maximum number of redirects to follow
MAX_REDIRECTS=5

# ======================
# Analytics
# ======================
# Vemetric analytics (optional)
# Get your token from https://vemetric.com/
# VEMETRIC_TOKEN=your-vemetric-token
# Use this to point to a local Vemetric instance
# VEMETRIC_HOST=http://localhost:3001