Appearance

Configuration Settings ​

The Configuration Settings allow you to configure various system-level settings including reCAPTCHA, API keys, security settings, cache management, and other advanced configurations.

Table of Contents ​

  1. Overview
  2. Accessing Configuration Settings
  3. reCAPTCHA Configuration
  4. API Keys
  5. Security Settings
  6. Cache Settings
  7. Slack Webhook Configuration
  8. Other Configurations
  9. Best Practices

Overview ​

Features ​

  • ✅ reCAPTCHA setup
  • ✅ API key management
  • ✅ Security configurations
  • ✅ Cache management
  • ✅ Slack webhook setup
  • ✅ System configurations
  • ✅ Advanced settings

Admin Routes ​

  • Configuration Settings: /admin/settings/general/configurations

Accessing Configuration Settings ​

From Admin Panel ​

  1. Log in to admin panel
  2. Navigate to Settings → General → Configurations
  3. Or go directly to: /admin/settings/general/configurations

Permissions Required ​

  • Manage Settings: manage-settings permission

reCAPTCHA Configuration ​

What is reCAPTCHA? ​

reCAPTCHA protects your website from spam and abuse by verifying that users are human, not bots.

Setting Up reCAPTCHA ​

Get reCAPTCHA Keys ​

  1. Go to Google reCAPTCHA:

  2. Create Site:

    • Click + to create new site
    • Enter site details:
      • Label: Site name
      • reCAPTCHA Type: v2 or v3
      • Domains: Your domain(s)

  3. Get Keys:

    • Site Key: Public key (visible to users)
    • Secret Key: Private key (server-side)
    • Copy both keys

Configure in Admin ​

  1. Enter Site Key:

    • Paste Site Key
    • Used in frontend forms

  2. Enter Secret Key:

    • Paste Secret Key
    • Used for verification

  3. Select reCAPTCHA Version:

    • v2 Checkbox: "I'm not a robot" checkbox
    • v2 Invisible: Invisible verification
    • v3: Score-based verification

  4. Save Settings:

    • Click Save
    • reCAPTCHA enabled
    • Active on forms

reCAPTCHA Types ​

reCAPTCHA v2 ​

Checkbox Version:

  • Users click "I'm not a robot"
  • May require image challenge
  • Most user-friendly

Invisible Version:

  • No user interaction
  • Background verification
  • Seamless experience

reCAPTCHA v3 ​

Score-Based:

  • No user interaction
  • Returns risk score (0.0-1.0)
  • Lower score = more likely bot
  • Configure threshold

Testing reCAPTCHA ​

Test Mode ​

  1. Use Test Keys:

    • Google provides test keys
    • Always pass verification
    • For development

  2. Test Keys:

    • Site Key: 6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI
    • Secret Key: 6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe

Production Testing ​

  1. Test Forms:

    • Submit contact forms
    • Test registration
    • Verify working

  2. Check Logs:

    • Review verification logs
    • Check for errors
    • Monitor success rate

API Keys ​

Managing API Keys ​

Adding API Keys ​

  1. Navigate to Configuration:

    • Go to Configuration Settings
    • Find API Keys section

  2. Add Key:

    • Click Add API Key
    • Enter:
      • Name: Key identifier
      • Key: API key value
      • Service: Service name
      • Description: Optional description

  3. Save:

    • Click Save
    • Key stored securely
    • Available for use

Common API Keys ​

Google Services:

  • Maps API Key: Google Maps integration
  • Analytics Key: Google Analytics
  • Fonts API Key: Google Fonts

Social Media:

  • Facebook App ID: Facebook integration
  • Twitter API Key: Twitter integration
  • LinkedIn API Key: LinkedIn integration

Payment Services:

  • Stripe API Key: Stripe payments
  • PayPal Client ID: PayPal payments

Other Services:

  • Mailchimp API Key: Email marketing
  • SendGrid API Key: Email service
  • AWS Access Key: AWS services

API Key Security ​

Best Practices ​

  1. Never Expose Keys:

    • Don't commit to version control
    • Use environment variables
    • Restrict access

  2. Rotate Regularly:

    • Change keys periodically
    • Revoke old keys
    • Update in admin

  3. Use Different Keys:

    • Separate keys for test/production
    • Different keys per environment
    • Limit key permissions

Security Settings ​

Security Configuration ​

Password Requirements ​

Settings:

  • Minimum Length: Minimum password length
  • Require Uppercase: Must contain uppercase
  • Require Lowercase: Must contain lowercase
  • Require Numbers: Must contain numbers
  • Require Symbols: Must contain symbols

Configuration:

  1. Set Requirements:

    • Configure password rules
    • Set minimum length
    • Enable requirements

  2. Save:

    • Click Save
    • Requirements enforced
    • Applied to new passwords

Session Settings ​

Configuration:

  • Session Lifetime: Session duration (minutes)
  • Remember Me Duration: Remember me duration (days)
  • Session Timeout: Inactivity timeout

Settings:

  • Default: 120 minutes
  • Extended: 1440 minutes (24 hours)
  • Custom: Set custom duration

Login Security ​

Settings:

  • Max Login Attempts: Maximum failed attempts
  • Lockout Duration: Account lockout time
  • Two-Factor Auth: Enable 2FA (if available)

Configuration:

  1. Set Limits:

    • Configure max attempts
    • Set lockout duration
    • Enable 2FA

  2. Save:

    • Click Save
    • Security enforced
    • Active immediately

File Upload Security ​

Allowed File Types ​

Configuration:

  • Images: JPG, PNG, GIF, SVG
  • Documents: PDF, DOC, DOCX
  • Videos: MP4, MOV, AVI
  • Custom: Add custom types

File Size Limits ​

Settings:

  • Max Upload Size: Maximum file size
  • Image Max Size: Image size limit
  • Document Max Size: Document size limit

Configuration:

  • Default: 10MB
  • Images: 5MB
  • Documents: 20MB
  • Custom: Set custom limits

Cache Settings ​

Cache Management ​

Cache Types ​

Available Caches:

  • Application Cache: Application data
  • Route Cache: Route definitions
  • Config Cache: Configuration files
  • View Cache: Compiled views
  • Query Cache: Database queries

Clearing Cache ​

Manual Clear:

  1. Go to Configuration:

    • Navigate to Configuration Settings
    • Find Cache section

  2. Clear Cache:

    • Click Clear All Cache
    • Or clear specific cache type
    • Cache cleared immediately

Cache Options:

  • Clear Application Cache
  • Clear Route Cache
  • Clear Config Cache
  • Clear View Cache
  • Clear All Caches

Cache Configuration ​

Settings:

  • Cache Driver: Cache storage method
  • Cache Duration: How long to cache
  • Cache Prefix: Cache key prefix

Drivers:

  • File: File-based cache
  • Database: Database cache
  • Redis: Redis cache (if available)
  • Memcached: Memcached (if available)

Slack Webhook Configuration ​

Setting Up Slack Webhook ​

Create Webhook ​

  1. Go to Slack:

    • Open Slack workspace
    • Go to Apps → Incoming Webhooks

  2. Create Webhook:

    • Click Add to Slack
    • Select channel
    • Authorize app
    • Copy webhook URL

Configure in Admin ​

  1. Enter Webhook URL:

    • Paste webhook URL
    • Test connection
    • Verify working

  2. Configure Settings:

    • Channel: Default channel
    • Username: Bot username
    • Icon: Bot icon URL

  3. Save:

    • Click Save
    • Webhook active
    • Notifications sent

Webhook Usage ​

Use Cases:

  • System Notifications: System alerts
  • Error Reports: Error notifications
  • Activity Logs: Activity summaries
  • Custom Notifications: Custom alerts

Other Configurations ​

System Settings ​

Timezone ​

Configuration:

  • Default Timezone: System timezone
  • User Timezone: User-specific timezone
  • Date Format: Date display format
  • Time Format: Time display format

Locale Settings ​

Configuration:

  • Default Language: System language
  • Supported Languages: Available languages
  • Currency: Default currency
  • Number Format: Number formatting

Integration Settings ​

Third-Party Services ​

Available Integrations:

  • Analytics: Google Analytics, etc.
  • Email Services: Mailchimp, SendGrid
  • Social Media: Facebook, Twitter
  • Payment Gateways: Stripe, PayPal

Configuration:

  1. Select Service:

    • Choose integration
    • Enter credentials
    • Configure settings

  2. Test Connection:

    • Test integration
    • Verify working
    • Save settings

Best Practices ​

Security ​

  1. Protect API Keys:

    • Never expose in code
    • Use environment variables
    • Rotate regularly

  2. Enable reCAPTCHA:

    • Protect forms from spam
    • Use appropriate version
    • Monitor effectiveness

  3. Strong Passwords:

    • Enforce requirements
    • Regular password changes
    • Enable 2FA if available

Performance ​

  1. Use Caching:

    • Enable appropriate caches
    • Clear when needed
    • Monitor cache performance

  2. Optimize Settings:

    • Configure for your needs
    • Balance security/performance
    • Test thoroughly

Maintenance ​

  1. Regular Updates:

    • Update API keys
    • Review security settings
    • Check integrations

  2. Monitor Logs:

    • Review error logs
    • Check security logs
    • Monitor activity

Troubleshooting ​

reCAPTCHA Not Working ​

Solutions:

  1. Verify keys are correct
  2. Check domain matches
  3. Verify reCAPTCHA version
  4. Test with test keys
  5. Check browser console

API Keys Not Working ​

Solutions:

  1. Verify key is correct
  2. Check key permissions
  3. Verify service is active
  4. Check API limits
  5. Review error logs

Cache Issues ​

Solutions:

  1. Clear all caches
  2. Check cache driver
  3. Verify permissions
  4. Check disk space
  5. Review cache settings

Last Updated: [Date will be updated during final review]

Released under the MIT License.

Copyright © 2024 OmniSuite CMS