unifi-toolkit/.env.example at main · marcleblanc2/unifi-toolkit · 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
# ============================================
# UniFi Toolkit Configuration
# ============================================
#
# IMPORTANT: Run ./setup.sh for guided configuration!
# The setup wizard will generate these values for you.
#
# ============================================

# ============================================
# DEPLOYMENT SETTINGS
# ============================================

# Deployment type: local or production
# - local: No authentication, access via http://localhost:8000
# - production: Authentication required, HTTPS via Caddy
DEPLOYMENT_TYPE=local

# Domain name for HTTPS (production only)
# Must point to this server's IP address for Let's Encrypt
DOMAIN=toolkit.yourdomain.com

# Admin credentials (production only)
# Generate with: ./setup.sh (interactive) or ./reset_password.sh
AUTH_USERNAME=admin
AUTH_PASSWORD_HASH=

# ============================================
# REQUIRED SETTINGS
# ============================================

# Encryption key for securing UniFi credentials stored in the database
# Generate with: python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"
# WARNING: Do not change this key after initial setup or encrypted data will be lost
ENCRYPTION_KEY=your-fernet-key-here

# ============================================
# DATABASE SETTINGS
# ============================================

# Database URL (default uses SQLite in data/ directory)
DATABASE_URL=sqlite+aiosqlite:///./data/unifi_toolkit.db

# ============================================
# LOGGING
# ============================================

# Log level: DEBUG, INFO, WARNING, ERROR, CRITICAL
LOG_LEVEL=INFO

# ============================================
# UNIFI CONTROLLER
# ============================================
# UniFi controller credentials are configured through the WEB UI
# after first launch — not through environment variables.
#
# 1. Start the container
# 2. Open the dashboard in your browser
# 3. Enter your controller URL, credentials, and site ID
# 4. Click "Test Connection" then "Save"
#
# Credentials are encrypted at rest using the ENCRYPTION_KEY above.

# ============================================
# TOOL-SPECIFIC SETTINGS
# ============================================

# Wi-Fi Stalker: Device refresh interval in seconds
STALKER_REFRESH_INTERVAL=60

# ============================================
# ADVANCED SETTINGS
# ============================================

# Application port (local deployment only, default: 8000)
APP_PORT=8000