Comps.gg Documentation

Appearance

Site Settings ​

Configure global settings for your Comps.gg platform.

Site Settings

Route ​

/admin/settings

Overview ​

The Settings page allows you to configure essential site-wide settings including branding, contact information, and third-party integrations.

Tabs ​

The Settings page is organized into tabs:

  • General - Basic site information and configuration
  • Referrals - Referral program settings

General Tab ​

Basic Information ​

Basic Settings

  • Site Name - Your platform's display name
  • Site Tagline - Brief description or slogan
  • Logo - Upload your site logo
  • Favicon - Upload your site favicon

Contact Information ​

Configure email addresses for platform communications:

  • Contact Email - General inquiries email
  • Support Email - Customer support email
  • Additional Recipients - CC addresses for notifications

Analytics Integration ​

Umami Analytics ​

Umami Settings

Configure Umami analytics integration:

  • Share Token - Your Umami share token for embedded analytics
  • Website ID - Your Umami website identifier

Once configured, analytics will be available at /admin/website-analytics.

Featured Competitions

Control which competitions appear as featured on the homepage:

  • Featured Competition IDs - Comma-separated list of competition IDs to feature
  • Display Order - Competitions appear in the order specified
  1. Find the competition IDs you want to feature (from competition URLs or list)
  2. Enter IDs separated by commas (e.g., 123,456,789)
  3. Save settings
  4. Featured competitions will appear on the public homepage
  5. Public API endpoint: GET /api/v1/competitions/featured

Note: Only active competitions will be shown, even if their IDs are in the featured list.

Winner Instructions ​

Winner Instructions

Configure custom instructions that appear in prize notification emails sent to winners:

  • Winner Instructions - Custom text displayed in winner notification emails
  • Use to communicate:
    • ID verification requirements
    • Wait period information (e.g., "Please allow 14 days for processing")
    • Bank details collection for cash prizes
    • Prize claim procedures

If left blank, a default message is used in notification emails.

System Configuration ​

Additional system-wide settings:

  • Maintenance Mode - Enable/disable site access
  • Registration - Allow/restrict new user signups
  • Email Notifications - Configure notification preferences
  • Feature Flags - Enable/disable platform features

Referrals Tab ​

Referrals Settings

Configure the referral program that rewards users for bringing new customers.

Referral Settings ​

  • Enable Referrals - Toggle the referral program on/off
  • Qualifying Amount - Minimum purchase amount for a referral to qualify (e.g., £10.00)
  • Reward Amount - Wallet credit given to referrer when referral qualifies (e.g., £5.00)
  • Max Referrals Per User - Limit on how many referrals a single user can make

Fraud Warning ​

  • Fraud Warning Message - Optional warning text displayed on referral pages
  • Use to warn users about prohibited behaviors (e.g., self-referrals, fake accounts)
  • Leave blank to show no warning

How Referrals Work ​

  1. Existing users share their referral code or link
  2. New users register using the referral code
  3. When the new user makes a qualifying purchase, the referrer earns reward credit
  4. Reward is added to referrer's wallet balance

Settings Behavior ​

  • Settings are locked (read-only) when referral system is disabled
  • Enable the system to modify settings
  • Changes take effect immediately for new referrals

See Referrals Management for managing referrals and viewing statistics.

Usage ​

Updating Settings ​

  1. Navigate to /admin/settings
  2. Modify the desired settings
  3. Click "Save Changes"
  4. Changes take effect immediately

Logo and Favicon ​

To update branding:

  1. Prepare your images (PNG or SVG recommended)
  2. Click the upload button in the respective section
  3. Select your image file
  4. Preview the uploaded image
  5. Save changes

Recommended Sizes:

  • Logo: 200x50px (transparent PNG)
  • Favicon: 32x32px or 64x64px

Configuring Umami Analytics ​

  1. Create an Umami analytics account
  2. Set up your website in Umami
  3. Generate a share token
  4. Copy the share token and website ID
  5. Paste into the Umami settings section
  6. Save settings
  7. Access analytics at /admin/website-analytics

Cache Invalidation ​

When you update site settings, the frontend cache is automatically invalidated to ensure changes appear immediately for users.

How It Works ​

  1. Settings are saved in the database
  2. Backend sends cache invalidation request to frontend
  3. Frontend clears its site settings cache
  4. Next user request fetches fresh settings

Technical Details ​

  • Frontend caches site settings for 5 minutes
  • Cache invalidation is triggered automatically on save
  • Requires CACHE_INVALIDATION_SECRET to be configured in both backend and frontend .env
  • Fallback: Cache expires naturally after 5 minutes if invalidation fails

Configuration ​

Ensure these environment variables are set:

Backend .env:

CACHE_INVALIDATION_SECRET=your-secret-key-here

Frontend .env:

CACHE_INVALIDATION_SECRET=your-secret-key-here  # Must match backend

For more details, see Cache Invalidation Documentation.

Tips ​

  • Keep contact emails current and monitored
  • Test logo and favicon on different devices
  • Verify Umami integration after configuration
  • Review settings periodically for accuracy
  • Changes take effect immediately due to automatic cache invalidation