Sign In

💬 OctoberCMS Support Plugin #

A comprehensive support integration plugin for OctoberCMS that provides feedback forms, phone support requests, and live chat functionality through Slack integration and Cobrowse.io screen sharing.

✨ Key Features #

  • 💭 Feedback System - Submit feedback directly from the backend (all users)
  • 📞 Phone Support - Request phone callbacks with screen sharing (paid plans)
  • 💬 Live Chat Support - Real-time bidirectional chat with support agents (paid plans)
  • 🕐 Business Hours - Configurable chat availability with automatic messages
  • 🖥️ Screen Sharing - Integrated Cobrowse.io for remote assistance
  • 👑 Premium Features - Plan-based access control with upgrade prompts
  • 💾 Persistent Sessions - Chat sessions survive page refreshes
  • 🚀 Modern UI - Works with Turbo navigation and dark mode

🎯 Plan-Based Access #

This plugin integrates with the SaasBase plugin to provide different support levels:

  • Free Plans: Feedback only, with upgrade prompts for premium features
  • Paid Plans: Full access to phone support, chat support, and screen sharing

📚 Documentation #

Getting Started #

  1. Installation Guide - Requirements, installation steps, and initial setup

    • System requirements and dependencies
    • Step-by-step installation process
    • Initial configuration and verification
    • Next: Configuration →

  2. Configuration - Environment variables, config files, and customization options

    • Environment variable setup
    • Business hours configuration
    • Path filtering and UI customization
    • Next: Slack Setup →

  3. Slack Setup - Complete guide to configuring Slack integration

    • Webhook creation for feedback and phone support
    • Slack app setup for chat functionality
    • Channel configuration and testing
    • Next: Plan Access Control →

Core Features #

  1. Plan-Based Access Control - How the premium feature system works

    • Free vs paid plan differences
    • SaasBase plugin integration
    • Access control implementation
    • Next: Usage Guide →

  2. Usage Guide - User experience and support agent workflows

    • User journey for both plan types
    • Support agent workflow and best practices
    • Business hours and availability
    • Next: Advanced Features →

  3. Advanced Features - Detailed feature documentation and technical details

    • Session persistence and message system
    • UI customization and performance features
    • Technical architecture details
    • Next: Troubleshooting →

Support & Development #

  1. Troubleshooting - Common issues and solutions

    • Step-by-step diagnostic procedures
    • Common problems and fixes
    • Debug tools and techniques
    • Next: Development Guide →

  2. Development Guide - File structure, contributing, and technical details

    • Plugin architecture and file structure
    • Contributing guidelines and standards
    • Extension points and customization
    • Back to: Installation →

🚀 Quick Start #

  1. Install the plugin and SaasBase dependency
  2. Configure your environment variables for Slack integration
  3. Set up Cobrowse.io for screen sharing
  4. Customize chat availability and UI settings
  5. Test with both free and paid plan users

📋 Requirements Summary #

  • OctoberCMS: 2.x or 3.x
  • PHP: 7.4+
  • Dependencies: Albrightlabs SaasBase plugin
  • External Services: Slack workspace, Cobrowse.io account

📝 License & Support #

License: Proprietary - Albright Labs LLC. All Rights Reserved.

Support: For issues or questions, check the troubleshooting guide or enable debug mode for detailed logging.

This plugin requires the SaasBase plugin for organization and plan management.