actual-budget-rest-api/.env.example at main · ZoneMix/actual-budget-rest-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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# =============================================================================
# Environment Configuration
# =============================================================================
# Copy this file to .env.local for development
# For production, use a secrets manager (GitHub Secrets, AWS Secrets Manager, etc.)


# =============================================================================
# Required - All Environments
# =============================================================================

NODE_ENV=development
ADMIN_PASSWORD=your_secure_password
ACTUAL_SERVER_URL=http://localhost:5006
ACTUAL_PASSWORD=your_actual_password
ACTUAL_SYNC_ID=your_sync_id


# =============================================================================
# Required - Production Only (optional in dev with auto-generated values)
# =============================================================================

# JWT_SECRET=your_jwt_secret_at_least_32_characters
# JWT_REFRESH_SECRET=your_refresh_secret_different_from_jwt_secret
# SESSION_SECRET=your_session_secret_different_from_jwt_secrets


# =============================================================================
# Server Configuration (Optional - defaults shown)
# =============================================================================

PORT=3000
TRUST_PROXY=false


# =============================================================================
# Authentication (Optional - defaults shown)
# =============================================================================

ADMIN_USER=admin
JWT_ACCESS_TTL=1h
JWT_REFRESH_TTL=24h


# =============================================================================
# Actual Budget (Optional - defaults shown)
# =============================================================================

DATA_DIR=/app/.actual-cache


# =============================================================================
# Database (Optional - PostgreSQL is default)
# =============================================================================

DB_TYPE=postgres
POSTGRES_HOST=localhost
POSTGRES_PORT=5432
POSTGRES_DB=postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=your_postgres_password

# Alternative: Use connection URL instead of individual components
# POSTGRES_URL=postgresql://user:password@host:port/database

# For SQLite: uncomment below and comment out PostgreSQL settings
# DB_TYPE=sqlite


# =============================================================================
# Redis (Optional - for distributed rate limiting)
# =============================================================================

REDIS_HOST=localhost
REDIS_PORT=6379
# REDIS_PASSWORD=your_redis_password

# Alternative: Use connection URL instead
# REDIS_URL=redis://localhost:6379


# =============================================================================
# CORS & Security (Optional - defaults shown)
# =============================================================================

ALLOWED_ORIGINS=http://localhost:3000,http://localhost:5678
ENABLE_CORS=true
ENABLE_HELMET=true
ENABLE_RATE_LIMITING=true
MAX_REQUEST_SIZE=10kb


# =============================================================================
# Logging (Optional - defaults shown)
# =============================================================================

LOG_LEVEL=info


# =============================================================================
# Minimum Requirements Summary
# =============================================================================
#
# Development Minimum:
#   - NODE_ENV=development
#   - ADMIN_PASSWORD
#   - ACTUAL_SERVER_URL
#   - ACTUAL_PASSWORD
#   - ACTUAL_SYNC_ID
#
# Production Minimum:
#   - All development requirements above
#   - JWT_SECRET (32+ characters, unique)
#   - JWT_REFRESH_SECRET (32+ characters, different from JWT_SECRET)
#   - SESSION_SECRET (32+ characters, different from JWT secrets)
#   - NODE_ENV=production
#
# Generate secrets: openssl rand -base64 32