hambot/env.example at main · alekm/hambot · 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
# Hambot Discord Bot Environment Variables
# Copy this file to .env and fill in your actual values

# ===========================================
# REQUIRED: Discord Bot Configuration
# ===========================================
# Your Discord bot token from https://discordapp.com/developers/applications/
DISCORD_TOKEN=your_discord_bot_token_here

# Your Discord user ID (numeric) - used for bot owner commands
DISCORD_OWNER_ID=your_discord_user_id_here

# Your Discord bot's client ID (numeric) - used for invite links
DISCORD_CLIENT_ID=your_discord_bot_client_id_here

# ===========================================
# REQUIRED: HamQTH API Configuration
# ===========================================
# Your HamQTH account credentials from https://hamqth.com
HAMQTH_USERNAME=your_hamqth_username
HAMQTH_PASSWORD=your_hamqth_password

# ===========================================
# OPTIONAL: Additional Configuration
# ===========================================
# Discord guild ID for guild-specific commands (leave empty for global)
DISCORD_GUILD_ID=

# Embed color in hex format (default: 0x31a896)
EMBED_COLOR=0x31a896

# ===========================================
# OPTIONAL: Database Configuration (for alert features)
# ===========================================
# PostgreSQL connection string (required for alert features)
# Format: postgresql://user:password@host:port/database
# Leave empty to disable alert features
DATABASE_URL=

# Polling interval for spot sources in minutes (default: 5)
# PSKReporter recommends querying no more than once every 5 minutes to avoid rate limiting
# Setting this too low (e.g., 2 minutes) may cause 503 errors
PSKREPORTER_POLL_INTERVAL=5

# Alert expiration days (default: 30)
ALERT_EXPIRATION_DAYS=30

# Alert cooldown in minutes (default: 5) - prevents spam from same alert
ALERT_COOLDOWN_MINUTES=5

# Maximum alerts per user per hour (default: 20) - rate limiting
MAX_ALERTS_PER_USER_PER_HOUR=20

# Comma-separated default modes for PSKReporter alerts (default: FT8,FT4,PSK31,CW,RTTY)
DEFAULT_MODES_PSKREPORTER=FT8,FT4,PSK31,CW,RTTY

# Comma-separated list of enabled spot sources (default: pskreporter,dxcluster)
# Options: pskreporter,dxcluster
# Example: ENABLED_DATA_SOURCES=pskreporter,dxcluster
# Leave empty or set to both to monitor all available sources
ENABLED_DATA_SOURCES=pskreporter,dxcluster

# ===========================================
# OPTIONAL: DX Cluster Configuration
# ===========================================
# DX Cluster server hostname (default: dxmaps.com)
# Some known public DX Cluster servers:
#   - dxmaps.com:7300 (requires registration for sending spots, read-only OK)
#   - 9m2pju.hamradio.my:7300
#   - dxcluster.oevsv.at:7300
# You may need to test different servers to find one that works
DXCLUSTER_HOST=dxmaps.com

# DX Cluster server port (default: 7300)
# Common ports: 7300 (DXSpider), 23 (telnet), 8000 (some servers)
# Try different ports if connection fails
DXCLUSTER_PORT=7300

# Callsign for DX Cluster login (required for most servers)
# Most DX Cluster servers require a callsign to connect
DXCLUSTER_CALLSIGN=

# ===========================================
# OPTIONAL: Reporting to hambot.net
# ===========================================
# URL for the hambot.net reporting API (leave empty to disable)
REPORT_URL=https://hambot.net/api/bot

# API key for authentication with hambot.net (generate with: openssl rand -hex 32)
REPORT_API_KEY=your_secure_api_key_here

# ===========================================
# SYSTEM CONFIGURATION (Docker only)
# ===========================================
# User and group IDs for file permissions (Docker)
PUID=1000
PGID=1000

# Timezone (Docker)
TZ=America/New_York