agentic-node-ts-starter/.env.example at main · sapientpants/agentic-node-ts-starter · 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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# ============================================================================
# Environment Configuration Example (REQUIRED)
# ============================================================================
# IMPORTANT: Configuration is MANDATORY. You MUST:
# 1. Copy this file to .env: cp .env.example .env
# 2. Fill in your values or keep the defaults
#
# The application will NOT start without valid configuration.
# All variables are validated at application startup using Zod schemas.
# See docs/CONFIG.md for detailed documentation
# ============================================================================

# Node Environment
# Options: development, production, test, staging
# Default: development
NODE_ENV=development

# ============================================================================
# Application Settings
# ============================================================================

# Application name for logging and metrics
# Default: agentic-node-ts-starter
APP_NAME=agentic-node-ts-starter

# ============================================================================
# Logging
# ============================================================================

# Logging level
# Options: trace, debug, info, warn, error, fatal, silent
# Default: info (production), debug (development)
LOG_LEVEL=debug

# Debug namespaces to enable (optional)
# Example: app:*, express:*
# DEBUG=app:*

# Force colored output in terminals (optional)
# Options: true, false, 1, 0, yes, no
# FORCE_COLOR=true

# ============================================================================
# Feature Flags
# ============================================================================

# Enable metrics collection
# Options: true, false, 1, 0, yes, no
# Default: false
ENABLE_METRICS=false

# ============================================================================
# Timeouts
# ============================================================================

# General operation timeout in milliseconds
# Default: 30000 (30 seconds)
TIMEOUT_MS=30000

# ============================================================================
# Development Settings
# ============================================================================

# These settings are typically only used in development

# Force colored output in terminals
# Options: true, false, 1, 0, yes, no
# FORCE_COLOR=true

# Debug namespaces to enable
# Example: app:*, express:*, redis:*
# DEBUG=app:*

# ============================================================================
# Logging Output Configuration
# ============================================================================

# Logging output destination
# Options: stdout (default), stderr, file, syslog, null
# - stdout: Standard output (default behavior)
# - stderr: Standard error (useful when stdout is used for data)
# - file: Write to file specified by LOG_FILE_PATH
# - syslog: Send to syslog daemon
# - null: Disable logging entirely
# LOG_OUTPUT=stdout

# ============================================================================
# File Logging Configuration (when LOG_OUTPUT=file)
# ============================================================================

# Path to log file
# Default: ./logs/app.log
# LOG_FILE_PATH=./logs/app.log

# Maximum size of log file before rotation
# Examples: 10M, 100M, 1G
# Default: 10M
# LOG_FILE_MAX_SIZE=10M

# Maximum number of rotated log files to keep
# Default: 5
# LOG_FILE_MAX_FILES=5

# File permissions for log files (octal format)
# Default: 640 (rw-r-----)
# Examples: 600 (rw-------), 644 (rw-r--r--)
# LOG_FILE_PERMISSIONS=640

# ============================================================================
# Syslog Configuration (when LOG_OUTPUT=syslog)
# ============================================================================

# Syslog server hostname
# Default: localhost
# LOG_SYSLOG_HOST=localhost

# Syslog server port
# Default: 514
# LOG_SYSLOG_PORT=514

# Syslog protocol
# Options: udp, tcp
# Default: udp
# LOG_SYSLOG_PROTOCOL=udp

# ============================================================================
# Test Configuration
# ============================================================================

# Timeout for file write tests in CI (milliseconds)
# Increase if tests are failing due to slow file I/O
# Default: 300
# LOG_TEST_FILE_TIMEOUT=300