vix/.env.example at main · vixcpp/vix · 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
# =========================================================
# Vix example environment configuration
# Copy this file to ".env" and adjust values as needed.
# =========================================================

# =========================================================
# Database configuration
# Supported engines:
#   - sqlite
#   - mysql
# =========================================================
DATABASE_ENGINE=sqlite

# SQLite configuration
DATABASE_SQLITE_PATH=vix.db

# MySQL configuration
# Used only if DATABASE_ENGINE=mysql
DATABASE_DEFAULT_HOST=127.0.0.1
DATABASE_DEFAULT_PORT=3306
DATABASE_DEFAULT_USER=root
DATABASE_DEFAULT_PASSWORD=
DATABASE_DEFAULT_NAME=vix

# =========================================================
# Server configuration
# =========================================================
SERVER_PORT=8080
SERVER_REQUEST_TIMEOUT=2000
SERVER_IO_THREADS=0
SERVER_SESSION_TIMEOUT_SEC=20
SERVER_BENCH_MODE=false

# =========================================================
# TLS / HTTPS configuration
# =========================================================
# TLS is disabled by default.
#
# When SERVER_TLS_ENABLED=true, both SERVER_TLS_CERT_FILE and
# SERVER_TLS_KEY_FILE must be set.
#
# Important:
# This enables HTTPS directly inside the Vix HTTP server.
# If you already terminate TLS with Nginx, Caddy, Traefik, or another reverse
# proxy, keep SERVER_TLS_ENABLED=false here.
SERVER_TLS_ENABLED=false
SERVER_TLS_CERT_FILE=
SERVER_TLS_KEY_FILE=

# Example with Let's Encrypt:
# SERVER_TLS_ENABLED=true
# SERVER_TLS_CERT_FILE=/etc/letsencrypt/live/example.com/fullchain.pem
# SERVER_TLS_KEY_FILE=/etc/letsencrypt/live/example.com/privkey.pem

# Example with local development certificates:
# SERVER_TLS_ENABLED=true
# SERVER_TLS_CERT_FILE=certs/local.crt
# SERVER_TLS_KEY_FILE=certs/local.key

# =========================================================
# Logging configuration
# =========================================================
LOGGING_ASYNC=true
LOGGING_QUEUE_MAX=20000
LOGGING_DROP_ON_OVERFLOW=true

# =========================================================
# WAF configuration
# Modes:
#   - off
#   - basic
#   - strict
# =========================================================
WAF_MODE=basic
WAF_MAX_TARGET_LEN=4096
WAF_MAX_BODY_BYTES=1048576

# =========================================================
# WebSocket configuration
# =========================================================
WEBSOCKET_MAX_MESSAGE_SIZE=65536
WEBSOCKET_IDLE_TIMEOUT=60
WEBSOCKET_ENABLE_DEFLATE=true
WEBSOCKET_PING_INTERVAL=30
WEBSOCKET_AUTO_PING_PONG=true

# =========================================================
# MySQL example
# Uncomment this block to use MySQL instead of SQLite
# =========================================================
# DATABASE_ENGINE=mysql
# DATABASE_DEFAULT_HOST=127.0.0.1
# DATABASE_DEFAULT_PORT=3306
# DATABASE_DEFAULT_USER=root
# DATABASE_DEFAULT_PASSWORD=
# DATABASE_DEFAULT_NAME=vixdb