Skip to content
group-ride

Configuration

All configuration is done through environment variables. Copy .env.example to .env and fill in your values.

Discord

Section titled “Discord”
Terminal window
ADAPTER=discord                                      # "discord" or "telegram"
DISCORD_TOKEN=your_bot_token                         # Bot tab → Reset Token
DISCORD_CLIENT_ID=your_client_id                     # OAuth2 tab → Client ID
DISCORD_GUILD_ID=your_server_id                      # Right-click server → Copy Server ID
DISCORD_ANNOUNCEMENT_CHANNEL_ID=your_channel_id      # Announcement text channel
DISCORD_FORUM_CHANNEL_ID=your_forum_channel_id       # Forum channel for ride threads

Telegram

Section titled “Telegram”
Terminal window
ADAPTER=telegram
TELEGRAM_TOKEN=your_bot_token                        # From @BotFather
TELEGRAM_GROUP_CHAT_ID=-100XXXXXXXXX                 # Negative number from getUpdates

Database

Section titled “Database”
Terminal window
DATABASE_PATH=./data/group-ride.db                   # SQLite file path (default)
# DATABASE_URL=postgres://user:password@host:5432/db  # Set this to use PostgreSQL instead

When DATABASE_URL is set, the bot uses PostgreSQL. When unset, it uses SQLite.

For PostgreSQL, run migrations manually before the first start:

Terminal window
psql $DATABASE_URL -f src/adapters/database/postgres/migrations/001_initial.sql

Timezone

Section titled “Timezone”
Terminal window
TZ=Europe/Paris   # Must match your group's local timezone

The TZ variable controls when reminders fire. The day-before reminder sends on the first scheduler tick between 9am and 10pm local time (this window exists to avoid nighttime notifications), and the hour-before reminder sends 1 hour before the ride start on the day of the ride.

Set it to your group’s timezone — e.g. Europe/London, America/New_York, Asia/Tokyo.

Language

Section titled “Language”
Terminal window
LANG=fr   # "en" (default) or "fr"

Controls the language of all user-facing bot messages — notifications, reminders, and command replies. Log messages always stay in English regardless of this setting.

Value Language
en English (default)
fr French

Weather forecasts

Section titled “Weather forecasts”
Terminal window
WEATHER_ENABLED=false   # Set to "false" to disable weather forecasts (default: enabled)

When enabled, the day-before reminder includes a weather forecast. The forecast shows temperature range, sky conditions, wind speed/gusts/direction, and precipitation chance (and volume, if any is expected) for the ride day, using the wttr.in service — no API key required.

Wind direction is shown as an arrow (⬆️↗️➡️↘️⬇️↙️⬅️↖️) rather than a text abbreviation, so it needs no translation between locales.

Which location is used for the forecast?

Section titled “Which location is used for the forecast?”

The ride’s meeting point is a free-text field (e.g. “in front of the bakery”) and is often not a real, geocodable address. To get a reliable forecast, the bot picks a location in this order:

  1. The start coordinates of an imported GPX track, if the ride was created from a .gpx file or link — or from a .gpx posted afterward in the ride’s Discord thread (see Commands → GPX upload after creation) — most accurate, set automatically.
  2. The ride’s weather city — an optional field (e.g. “Paris”) settable via /edit, for rides without a GPX import.
  3. The meeting point text itself, as a last resort — same as before, works when it happens to be a real place name.

If the weather service is unavailable, the reminder is still sent without a forecast.

The forecast is also available on demand — use /weather inside a ride thread/topic to fetch it at any time, without waiting for the day-before reminder.

Example message:

🌤️ Forecast: Sunny, 14–22°C, 💨 15 km/h ↖️ (gusts 22 km/h), 🌧️ 10% chance of rain

Summary

Section titled “Summary”
Variable Required Default Description
ADAPTER No discord discord or telegram
DISCORD_TOKEN Discord — Bot token
DISCORD_CLIENT_ID Discord — Application client ID
DISCORD_GUILD_ID Discord — Server (guild) ID
DISCORD_ANNOUNCEMENT_CHANNEL_ID Discord — Text channel for announcements
DISCORD_FORUM_CHANNEL_ID Discord — Forum channel for ride threads
TELEGRAM_TOKEN Telegram — Bot token from BotFather
TELEGRAM_GROUP_CHAT_ID Telegram — Supergroup chat ID
DATABASE_PATH No ./data/group-ride.db SQLite file path
DATABASE_URL No — PostgreSQL connection URL
TZ No System default Timezone for reminders
LANG No en Bot message language (en or fr)
WEATHER_ENABLED No true Set to false to disable weather forecast