| 1 |
aaa3b54 |
Erfan |
1y ago |
# Marzneshin Environment Variables |
| 2 |
a47eb4c |
Dawsh |
2y ago |
|
| 3 |
aaa3b54 |
Erfan |
1y ago |
## Deprecated |
| 4 |
aaa3b54 |
Erfan |
1y ago |
# THE FOLLOWING TWO VARIABLES ARE NOT SUPPORTED ANYMORE, USE merzneshin cli. |
| 5 |
aaa3b54 |
Erfan |
1y ago |
# SUDO_USERNAME="admin" |
| 6 |
aaa3b54 |
Erfan |
1y ago |
# SUDO_PASSWORD="admin" |
| 7 |
a47eb4c |
Dawsh |
2y ago |
|
| 8 |
aaa3b54 |
Erfan |
1y ago |
## Server Configuration |
| 9 |
aaa3b54 |
Erfan |
1y ago |
UVICORN_HOST="0.0.0.0" |
| 10 |
aaa3b54 |
Erfan |
1y ago |
UVICORN_PORT=8000 |
| 11 |
aaa3b54 |
Erfan |
1y ago |
# UVICORN_UDS="/run/marzneshin.socket" |
| 12 |
aaa3b54 |
Erfan |
1y ago |
# UVICORN_SSL_CERTFILE="/var/lib/marzneshin/certs/example.com/fullchain.pem" |
| 13 |
aaa3b54 |
Erfan |
1y ago |
# UVICORN_SSL_KEYFILE="/var/lib/marzneshin/certs/example.com/key.pem" |
| 14 |
a0e778c |
Mrdn |
2y ago |
|
| 15 |
aaa3b54 |
Erfan |
1y ago |
## Dashboard |
| 16 |
aaa3b54 |
Erfan |
1y ago |
# DASHBOARD_PATH="/dashboard/" |
| 17 |
a47eb4c |
Dawsh |
2y ago |
|
| 18 |
aaa3b54 |
Erfan |
1y ago |
## Database |
| 19 |
aaa3b54 |
Erfan |
1y ago |
# SQLALCHEMY_DATABASE_URL="sqlite:///db.sqlite3" |
| 20 |
aaa3b54 |
Erfan |
1y ago |
# SQLALCHEMY_CONNECTION_POOL_SIZE=10 |
| 21 |
aaa3b54 |
Erfan |
1y ago |
# SQLALCHEMY_CONNECTION_MAX_OVERFLOW=-1 |
| 22 |
a47eb4c |
Dawsh |
2y ago |
|
| 23 |
aaa3b54 |
Erfan |
1y ago |
## Subscription |
| 24 |
aaa3b54 |
Erfan |
1y ago |
# SUBSCRIPTION_URL_PREFIX="https://example.com" |
| 25 |
a47eb4c |
Dawsh |
2y ago |
|
| 26 |
aaa3b54 |
Erfan |
1y ago |
## Authentication |
| 27 |
aaa3b54 |
Erfan |
1y ago |
# JWT_ACCESS_TOKEN_EXPIRE_MINUTES=1440 |
| 28 |
aaa3b54 |
Erfan |
1y ago |
# AUTH_GENERATION_ALGORITHM=xxh128 |
| 29 |
a47eb4c |
Dawsh |
2y ago |
|
| 30 |
aaa3b54 |
Erfan |
1y ago |
## Telegram Bot |
| 31 |
aaa3b54 |
Erfan |
1y ago |
# TELEGRAM_API_TOKEN="123456789:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" |
| 32 |
aaa3b54 |
Erfan |
1y ago |
# TELEGRAM_ADMIN_ID="987654321, 123456789" |
| 33 |
aaa3b54 |
Erfan |
1y ago |
# TELEGRAM_LOGGER_CHANNEL_ID=-1234567890123 |
| 34 |
aaa3b54 |
Erfan |
1y ago |
# TELEGRAM_PROXY_URL="http://localhost:8080" |
| 35 |
a47eb4c |
Dawsh |
2y ago |
|
| 36 |
aaa3b54 |
Erfan |
1y ago |
## Webhook |
| 37 |
aaa3b54 |
Erfan |
1y ago |
# WEBHOOK_ADDRESS="http://127.0.0.1:9000/" |
| 38 |
aaa3b54 |
Erfan |
1y ago |
# WEBHOOK_SECRET="something-very-very-secret" |
| 39 |
a47eb4c |
Dawsh |
2y ago |
|
| 40 |
aaa3b54 |
Erfan |
1y ago |
## Custom Templates |
| 41 |
5c78ce8 |
Dawsh |
2y ago |
# CUSTOM_TEMPLATES_DIRECTORY="/var/lib/marzneshin/templates/" |
| 42 |
aaa3b54 |
Erfan |
1y ago |
# HOME_PAGE_TEMPLATE="home/index.html" |
| 43 |
aaa3b54 |
Erfan |
1y ago |
# SUBSCRIPTION_PAGE_TEMPLATE="subscription/index.html" |
| 44 |
406d607 |
dawsh |
2y ago |
# CLASH_SUBSCRIPTION_TEMPLATE="/var/lib/marzneshin/templates/clash.yml" |
| 45 |
406d607 |
dawsh |
2y ago |
# SINGBOX_SUBSCRIPTION_TEMPLATE="/var/lib/marzneshin/templates/sing-box.json" |
| 46 |
406d607 |
dawsh |
2y ago |
# XRAY_SUBSCRIPTION_TEMPLATE="/var/lib/marzneshin/templates/xray.json" |
| 47 |
7caa138 |
BrainFuck Developer |
1y ago |
|
| 48 |
aaa3b54 |
Erfan |
1y ago |
## Scheduled Tasks Interval (in seconds) |
| 49 |
7caa138 |
BrainFuck Developer |
1y ago |
# TASKS_RECORD_USER_USAGES_INTERVAL=30 |
| 50 |
7caa138 |
BrainFuck Developer |
1y ago |
# TASKS_REVIEW_USERS_INTERVAL=30 |
| 51 |
7caa138 |
BrainFuck Developer |
1y ago |
# TASKS_EXPIRE_DAYS_REACHED_INTERVAL=30 |
| 52 |
7caa138 |
BrainFuck Developer |
1y ago |
# TASKS_RESET_USER_DATA_USAGE=3600 |
| 53 |
aaa3b54 |
Erfan |
1y ago |
# DISABLE_RECORDING_NODE_USAGE=false |
| 54 |
aaa3b54 |
Erfan |
1y ago |
|
| 55 |
aaa3b54 |
Erfan |
1y ago |
## Recurrent Notifications |
| 56 |
aaa3b54 |
Erfan |
1y ago |
# RECURRENT_NOTIFICATIONS_TIMEOUT=180 |
| 57 |
aaa3b54 |
Erfan |
1y ago |
# NUMBER_OF_RECURRENT_NOTIFICATIONS=3 |
| 58 |
aaa3b54 |
Erfan |
1y ago |
# NOTIFY_REACHED_USAGE_PERCENT=80 |
| 59 |
aaa3b54 |
Erfan |
1y ago |
# NOTIFY_DAYS_LEFT=3 |
| 60 |
aaa3b54 |
Erfan |
1y ago |
|
| 61 |
aaa3b54 |
Erfan |
1y ago |
## For Developers |
| 62 |
aaa3b54 |
Erfan |
1y ago |
# DEBUG=true |
| 63 |
aaa3b54 |
Erfan |
1y ago |
# DOCS=true |
| 64 |
aaa3b54 |
Erfan |
1y ago |
# VITE_BASE_API="https://example.com/api/" |