panel/.env.example at main · PasarGuard/panel · 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
UVICORN_HOST = "0.0.0.0"
UVICORN_PORT = 8000
# ALLOWED_ORIGINS=http://localhost,http://localhost:8000,http://example.com

## We highly recommend add admin using `pasarguard cli` tool and do not use
## the following variables which is somehow hard codded infrmation.
# SUDO_USERNAME = "admin"
# SUDO_PASSWORD = "admin"

# UVICORN_UDS = "/run/pasarguard.socket"
# UVICORN_SSL_CERTFILE = "/var/lib/pasarguard/certs/example.com/fullchain.pem"
# UVICORN_SSL_KEYFILE = "/var/lib/pasarguard/certs/example.com/key.pem"
# UVICORN_SSL_CA_TYPE = "public"
# UVICORN_WORKERS = 4

# DASHBOARD_PATH = "/dashboard/"

# SUBSCRIPTION_PATH = "sub"
# USER_SUBSCRIPTION_CLIENTS_LIMIT = 10

# CUSTOM_TEMPLATES_DIRECTORY="/var/lib/pasarguard/templates/"
# CLASH_SUBSCRIPTION_TEMPLATE="clash/my-custom-template.yml"
# SUBSCRIPTION_PAGE_TEMPLATE="subscription/index.html"
# HOME_PAGE_TEMPLATE="home/index.html"
# XRAY_SUBSCRIPTION_TEMPLATE="xray/default.json"
# SINGBOX_SUBSCRIPTION_TEMPLATE="singbox/default.json"

## External config to import into v2ray format subscription
# EXTERNAL_CONFIG = "config://..."

# SQLALCHEMY_DATABASE_URL = "sqlite+aiosqlite:///db.sqlite3"
# SQLALCHEMY_DATABASE_URL="postgresql+asyncpg://postgres:DB_PASSWORD@localhost:5432/pasarguard"
# SQLALCHEMY_DATABASE_URL="mysql+asyncmy://root:[email protected]/pasarguard"
# this is per worker pool size, not total pool size. So if you have 4 workers and set this to 10, you can have up to 40 connections in total.
# SQLALCHEMY_POOL_SIZE = 10
# SQLALCHEMY_MAX_OVERFLOW = 30

# NATS_ENABLED = 0
# NATS_URL = "nats://nats:4222"
# NATS_WORKER_SYNC_SUBJECT = "pasarguard.worker_sync"
# NATS_NODE_COMMAND_SUBJECT = "pasarguard.node.command"
# NATS_NODE_RPC_SUBJECT = "pasarguard.node.rpc"
# NATS_SCHEDULER_RPC_SUBJECT = "pasarguard.scheduler.rpc"
# NATS_NODE_LOG_SUBJECT = "pasarguard.node.logs"
# NATS_NODE_RPC_TIMEOUT = 30.0
# NATS_SCHEDULER_RPC_TIMEOUT = 5.0

# NATS KV buckets and streams for coordination
# NATS_TELEGRAM_KV_BUCKET = "pasarguard_telegram"
# NATS_NOTIFICATION_STREAM = "NOTIFICATIONS"
# NATS_NOTIFICATION_SUBJECT = "notifications.queue"
# NATS_NOTIFICATION_CONSUMER = "notification_workers"
# NATS_WEBHOOK_STREAM = "WEBHOOK_NOTIFICATIONS"
# NATS_WEBHOOK_SUBJECT = "notifications.webhook"
# NATS_WEBHOOK_CONSUMER = "webhook_workers"

# ROLE = "all-in-one"  # backend | node | scheduler | all-in-one

### Use negative values to disable auto-delete by default
# USERS_AUTODELETE_DAYS = -1
# USER_AUTODELETE_INCLUDE_LIMITED_ACCOUNTS = false

### for developers
# DOCS=True
# DEBUG=True
# DO_NOT_LOG_TELEGRAM_BOT=True
# SAVE_LOGS_TO_FILE=False
# LOG_FILE_PATH="pasarguard.log"
# LOG_BACKUP_COUNT=72
# LOG_ROTATION_ENABLED=False
# LOG_ROTATION_INTERVAL=1
# LOG_ROTATION_UNIT="H" # "S", "M", "H", "D", "W0"-"W6", "midnight"
# LOG_MAX_BYTES=10485760 # 10 MB
# LOG_LEVEL="INFO"
# ECHO_SQL_QUERIES=False
# VITE_BASE_API="https://example.com/"
# JWT_ACCESS_TOKEN_EXPIRE_MINUTES=1440

# due to high amount of data, this job is only available for postgresql and timescaledb
# ENABLE_RECORDING_NODES_STATS = False

# JOB_CORE_HEALTH_CHECK_INTERVAL = 10
# JOB_RECORD_NODE_USAGES_INTERVAL = 30
# JOB_RECORD_USER_USAGES_INTERVAL = 10
# JOB_REVIEW_USERS_INTERVAL = 30
# JOB_SEND_NOTIFICATIONS_INTERVAL = 30
# JOB_GATHER_NODES_STATS_INTERVAL = 25
# JOB_REMOVE_OLD_INBOUNDS_INTERVAL = 600
# JOB_REMOVE_EXPIRED_USERS_INTERVAL = 3600
# JOB_RESET_USER_DATA_USAGE_INTERVAL = 600
# JOB_RESET_NODE_USAGE_INTERVAL = 60
# JOB_CHECK_NODE_LIMITS_INTERVAL = 60
# JOB_CLEANUP_SUBSCRIPTION_UPDATES_INTERVAL = 600

# DISABLE_RECORDING_NODE_USAGE = False
# ENABLE_RECORDING_NODES_STATS = False  # Only available for postgresql and timescaledb

# ALLOWED_ORIGINS = "*"

## Experimental featueres
# STOP_NODES_ON_SHUTDOWN = True