Queen-Riam/.env.example at main · Dev-Kango/Queen-Riam · 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
# ============================================================
#              Queen Riam - Environment Configuration
#
# VPS / local / Pterodactyl:
#   cp .env.example .env
#   Then fill in the required values and keep .env private.
#
# Hosted platforms:
#   Set these variables in the platform's secret/environment UI.
#   Do not commit or upload .env.
# ============================================================

# -- Bot identity ------------------------------------------------------------
# Display name used in menus, online messages, and help text.
BOT_NAME=Queen Riam
# Human owner name shown by owner/help/about commands.
BOT_OWNER=Your Name
# Sticker pack name and author metadata.
PACK_NAME=Queen Riam
PACK_AUTHOR=Your Name

# -- Owner and pairing -------------------------------------------------------
# WhatsApp owner number in international format: digits only, no +, spaces,
# dashes, or brackets. It is also used for automatic pairing when no session
# is supplied. Example: 233509977126
OWNER_NUMBER=

# Optional exported session. Leave blank on a VPS if you want the bot to use
# the existing backend session or generate a pairing code automatically.
# Supported formats in the current code:
#   RIAM~<base64-encoded-session-json>
#   Queen~<MEGA-file-id>
SESSION_ID=

# -- Core behavior -----------------------------------------------------------
# Command prefix, for example .ping or !ping.
PREFIX=.
# IANA timezone used in logs, menus, welcome messages, and timestamps.
TIMEZONE=Africa/Accra
# public = everyone can use public commands; private = owner/sudo only.
COMMAND_MODE=public

# -- Automatic features ------------------------------------------------------
# Use the literal strings true or false.
# These values are defaults/identity settings; the interactive auto-feature
# commands persist their live state in data/config.json or data/config_<id>.json.
AUTO_STATUS_REACT=false
AUTO_STATUS_REPLY=false
AUTO_STATUS_MSG=Status Viewed Queen Riam
AUTOREAD=false
AUTOTYPE=false
AUTORECORD=false
AUTORECORDTYPE=false

# -- Optional API keys -------------------------------------------------------
# Required only by commands/features that use Giphy. Leave blank otherwise.
GIPHY_API_KEY=

# -- Session storage backend -------------------------------------------------
# Current supported values: blank, sqlite, postgres/postgresql, mysql/mariadb,
# mongodb/mongo, supabase, or redis.
# For this VPS, sqlite is the active backend.
DB_TYPE=sqlite

# Used only when DB_TYPE=sqlite. Defaults to ./data/session.db.
SQLITE_PATH=./data/session.db

# Used only when DB_TYPE=postgres, postgresql, mysql, or mariadb.
# DATABASE_URL=postgresql://user:password@host:5432/database
# DATABASE_URL=mysql://user:password@host:3306/database
DATABASE_URL=

# Used only when DB_TYPE=mongodb or mongo.
# MONGO_URI=mongodb+srv://user:password@cluster.mongodb.net/queenriam
MONGO_URI=

# Used only when DB_TYPE=supabase. Use the direct PostgreSQL URI from the
# Supabase dashboard's Database connection settings.
# SUPABASE_DB_URL=postgresql://postgres:password@db.project-ref.supabase.co:5432/postgres
SUPABASE_DB_URL=

# Used only when DB_TYPE=redis. Supports redis:// and rediss:// URLs.
# REDIS_URL=redis://default:password@host:6379
REDIS_URL=

# Notes:
# - Keep .env at permission 600 on a VPS; never share its values in chat.
# - Only the connection variable required by DB_TYPE should be populated.
# - If SESSION_ID is blank, OWNER_NUMBER must be set for automatic pairing.