Skip to content

environment-variables.md

Latest commit

 

History

History
314 lines (226 loc) · 8.2 KB

environment-variables.md

File metadata and controls

314 lines (226 loc) · 8.2 KB

Environment Variables Documentation

This document lists all supported environment variables for the WorldGuessr project. Environment variables should be set in a .env.local file in the project root for local development, or configured in your deployment environment.

🚨 Required Variables

These variables are essential for the application to function properly:

Database Configuration

# MongoDB connection string
MONGODB=mongodb://localhost:27017/worldguessr
# OR for MongoDB Atlas:
# MONGODB=mongodb+srv://username:password@cluster.mongodb.net/worldguessr

# Redis connection string for caching and sessions
REDIS_URI=redis://localhost:6379
# OR for Redis Cloud:
# REDIS_URI=redis://username:password@host:port

Google Authentication (Required for multiplayer)

# Google OAuth Client ID (publicly visible)
NEXT_PUBLIC_GOOGLE_CLIENT_ID=your_google_client_id.apps.googleusercontent.com

# Google OAuth Client Secret (server-side only)
GOOGLE_CLIENT_SECRET=your_google_client_secret

🌐 Server Configuration

Port Configuration

# API server port (default: 3001)
API_PORT=3001

# WebSocket server port (default: 3002)
WS_PORT=3002

# Next.js development server runs on port 3000 by default

Environment Mode

# Node.js environment mode
NODE_ENV=development
# OR
NODE_ENV=production

🌍 Client Configuration (Public Variables)

These variables are exposed to the browser and must be prefixed with NEXT_PUBLIC_:

API Endpoints

# API server URL (publicly visible)
NEXT_PUBLIC_API_URL=localhost:3001
# OR for production:
# NEXT_PUBLIC_API_URL=api.yourwebite.com

# WebSocket server host (publicly visible)
NEXT_PUBLIC_WS_HOST=localhost:3002
# OR for production:
# NEXT_PUBLIC_WS_HOST=ws.yourwebsite.com

Platform Integrations

# Enable CoolMath Games mode
NEXT_PUBLIC_COOLMATH=true

# Enable Poki.com integration
NEXT_PUBLIC_POKI=true

# Maps.co API key for geocoding (if using)
NEXT_PUBLIC_MAPSCO=your_mapsco_api_key

🔧 Optional Features

Discord Integration

# Discord webhook URL for main server notifications
DISCORD_WEBHOOK=https://discord.com/api/webhooks/your_webhook_url

# Discord webhook URL for WebSocket server notifications
DISCORD_WEBHOOK_WS=https://discord.com/api/webhooks/your_ws_webhook_url

AI Features (Currently Disabled)

# OpenAI API key for AI-generated clues (feature currently commented out)
# OPENAI_API_KEY=your_openai_api_key

Maintenance Mode

# Secret key for enabling/disabling maintenance mode
MAINTENANCE_SECRET=your_secure_maintenance_secret

📱 Platform-Specific Configuration

CoolMath Games

When deploying to CoolMath Games, set:

NEXT_PUBLIC_COOLMATH=true

This enables:

  • CoolMath Games specific UI modifications
  • Ad integration handling
  • Username filtering and guest name handling
  • Disabled community features

Poki.com

When deploying to Poki.com, set:

NEXT_PUBLIC_POKI=true

This enables:

  • Poki SDK integration
  • Poki-specific ad handling
  • Platform-appropriate UI modifications

CrazyGames

CrazyGames integration is detected automatically via URL parameters (?crazygames=true), no environment variable needed.

🚀 Example Configuration Files

Development (.env.local)

# Database
MONGODB=mongodb://localhost:27017/worldguessr
REDIS_URI=redis://localhost:6379

# Google Auth
NEXT_PUBLIC_GOOGLE_CLIENT_ID=123456789-abcdefghijk.apps.googleusercontent.com
GOOGLE_CLIENT_SECRET=GOCSPX-your_client_secret

# Server Configuration
API_PORT=3001
WS_PORT=3002
NODE_ENV=development

# Client Configuration
NEXT_PUBLIC_API_URL=localhost:3001
NEXT_PUBLIC_WS_HOST=localhost:3002

# Optional: Discord notifications
DISCORD_WEBHOOK=https://discord.com/api/webhooks/your_webhook_url
DISCORD_WEBHOOK_WS=https://discord.com/api/webhooks/your_ws_webhook_url

# Optional: Maintenance mode
MAINTENANCE_SECRET=your_secure_secret

Production (.env.production)

# Database (production URLs)
MONGODB=mongodb+srv://username:password@cluster.mongodb.net/worldguessr
REDIS_URI=redis://username:password@redis-host:port

# Google Auth (production credentials)
NEXT_PUBLIC_GOOGLE_CLIENT_ID=prod_client_id.apps.googleusercontent.com
GOOGLE_CLIENT_SECRET=prod_client_secret

# Server Configuration
API_PORT=3001
WS_PORT=3002
NODE_ENV=production

# Client Configuration (production URLs)
NEXT_PUBLIC_API_URL=api.worldguessr.com
NEXT_PUBLIC_WS_HOST=ws.worldguessr.com

# Discord notifications
DISCORD_WEBHOOK=https://discord.com/api/webhooks/prod_webhook
DISCORD_WEBHOOK_WS=https://discord.com/api/webhooks/prod_ws_webhook

# Maintenance mode
MAINTENANCE_SECRET=production_maintenance_secret

Platform-Specific: CoolMath Games

# All standard variables plus:
NEXT_PUBLIC_COOLMATH=true

# Note: Some features are automatically disabled in CoolMath mode:
# - Community maps
# - Chat functionality
# - User-generated content features

🛠️ Variable Usage by Component

Server Components (server.js)

  • MONGODB - Database connection
  • API_PORT - Server port
  • NODE_ENV - Environment mode
  • DISCORD_WEBHOOK - Discord notifications
  • NEXT_PUBLIC_GOOGLE_CLIENT_ID - OAuth validation
  • GOOGLE_CLIENT_SECRET - OAuth server-side

WebSocket Server (ws/ws.js)

  • MONGODB - Database connection
  • REDIS_URI - Session storage
  • WS_PORT - WebSocket port
  • NODE_ENV - Environment mode
  • DISCORD_WEBHOOK_WS - WebSocket notifications
  • MAINTENANCE_SECRET - Maintenance mode control

Client Configuration (clientConfig.js)

  • NEXT_PUBLIC_API_URL - API endpoint
  • NEXT_PUBLIC_WS_HOST - WebSocket endpoint

Authentication (api/googleAuth.js)

  • NEXT_PUBLIC_GOOGLE_CLIENT_ID - OAuth client ID
  • GOOGLE_CLIENT_SECRET - OAuth validation

Platform Integration (components/headContent.js)

  • NEXT_PUBLIC_COOLMATH - CoolMath Games mode
  • NEXT_PUBLIC_POKI - Poki.com integration

🔍 Debugging Environment Issues

Common Issues

  1. Database Connection Failed

    • Check MONGODB connection string
    • Ensure database is running and accessible
    • Verify network connectivity

  2. Authentication Not Working

    • Verify NEXT_PUBLIC_GOOGLE_CLIENT_ID is set
    • Check GOOGLE_CLIENT_SECRET is correct
    • Ensure Google OAuth is configured properly

  3. WebSocket Connection Issues

    • Check WS_PORT matches client expectations
    • Verify NEXT_PUBLIC_WS_HOST is accessible
    • Ensure REDIS_URI is working for session storage

  4. Platform-Specific Features Not Working

    • Verify platform environment variables are set correctly
    • Check if features are properly gated behind environment checks

Environment Validation

The application will log warnings for missing critical environment variables:

  • [MISSING-ENV WARN] MONGODB env variable not set
  • [MISSING-ENV WARN] REDIS_URI env variable not set
  • [MISSING-ENV WARN] NEXT_PUBLIC_GOOGLE_CLIENT_ID env variable not set
  • [MISSING-ENV WARN] GOOGLE_CLIENT_SECRET env variable not set

Maintenance Mode Usage

To enable maintenance mode (requires MAINTENANCE_SECRET to be set):

# Enable maintenance mode
curl http://your-ws-server.com/setmaintenance/your_secret/true

# Disable maintenance mode
curl http://your-ws-server.com/setmaintenance/your_secret/false

📋 Quick Setup Checklist

For a minimal working setup, ensure these variables are set:

  • MONGODB - Database connection
  • REDIS_URI - Redis connection
  • NEXT_PUBLIC_GOOGLE_CLIENT_ID - Google OAuth client
  • GOOGLE_CLIENT_SECRET - Google OAuth secret
  • NEXT_PUBLIC_API_URL - API server URL
  • NEXT_PUBLIC_WS_HOST - WebSocket server URL

Optional but recommended:

  • DISCORD_WEBHOOK - For monitoring and notifications
  • MAINTENANCE_SECRET - For emergency maintenance mode

🔐 Security Notes

  • Never commit .env files to version control
  • Use different credentials for development and production
  • Rotate secrets regularly, especially MAINTENANCE_SECRET
  • Monitor Discord webhooks for unusual activity
  • Ensure GOOGLE_CLIENT_SECRET is never exposed to clients

For additional help with environment configuration, check the application startup logs for specific warnings about missing or misconfigured variables.