Skip to main content

Setting up Google reCAPTCHA

Google reCAPTCHA prevents automated bots from abusing your panel registration, login, and voucher redemption endpoints.

1. Create reCAPTCHA API Keys​

  1. Visit the Google reCAPTCHA Admin Console.
  2. Click the + (Create) button to register a new site.
  3. Fill in the required fields:
    • Label: Cyrus Panel (or your brand name)
    • reCAPTCHA type: Choose reCAPTCHA v2 (e.g. "I'm not a robot" Checkbox).
    • Domains: Add the exact domain where your panel is hosted (e.g. panel.yourdomain.com).
  4. Accept the Terms of Service and click Submit.
  5. Copy both the Site Key (Public Key) and Secret Key.
Authorized Domain Notice

Ensure your domain name (without https:// or ports) is added to the Authorized Domains list in Google's console. If testing on localhost, add localhost as an authorized domain.

2. Apply Keys to Cyrus Panel​

Via Interactive CLI Wizard​

During initial setup with npm run start, select Yes when prompted:

? Enable Google reCAPTCHA verification? [y/N]: y
? reCAPTCHA Public (Site) Key: <your-site-key>
? reCAPTCHA Secret Key: <your-secret-key>

Via .env Configuration File​

If you already completed setup, you can update your .env file directly:

RECAPTCHA_ENABLED=true
RECAPTCHA_PUBLIC_KEY=6LeIxAcTAAAAAJcZVRqyCQ_XXX...
RECAPTCHA_SECRET_KEY=6LeIxAcTAAAAAGG-vFI1TnRW_XXX...

Restart your Cyrus Panel instance after editing .env for changes to take effect.