README

A Flarum extension that provides AI-powered discussion summarization with real-time streaming.

Features

• 🤖 AI-powered discussion summaries
• ⚡ Real-time streaming display
• 🎨 HTML formatted output
• 📌 Draggable popup with position memory
• � Multiple LLM providers (OpenAI, Gemini, etc.)
• ⚙️ Customizable prompts and settings

Requirements

• Flarum 1.2+
• PHP 8.1+
• datlechin/flarum-ai extension (required dependency)
• An AI provider configured (OpenAI, Anthropic, Google Gemini, etc.)

Installation

Install with composer:

composer require datlechin/flarum-ai-summarize

Configuration

1. Install and configure datlechin/flarum-ai extension
2. Set up an LLM provider (OpenAI, Anthropic, Google Gemini, etc.)
3. Configure settings in Admin Panel → Extensions → AI Summarize
4. Set permissions in Admin Panel → Permissions

Usage

Accessing the Feature

The AI Summarize button appears in the discussion controls for discussions that meet the minimum post requirement.

To generate a summary:

1. Open any discussion with enough posts (default: 3 or more)
2. Click the discussion controls dropdown (•••)
3. Select "Summarize with AI"

The Summary Popup

A draggable popup appears at the top-right showing the summary in real-time.

Features:

• Real-time streaming with blinking cursor
• HTML formatted text (bold, italic, lists)
• Drag to move anywhere on screen
• Position is remembered
• Minimize/maximize button
• Close button

Customization

Custom System Prompts

You can customize the AI prompt in admin settings to influence summary style and content.

Example custom prompt:

You are an AI assistant summarizing forum discussions.
Create a concise summary (100-150 words) that:
- Highlights the main topic and key arguments
- Mentions important conclusions or consensus
- Uses clear, neutral language
- Focuses on content, not participants
Avoid greetings and meta-commentary.

Prompt Tips:

• Define desired length and style
• Specify tone (neutral, formal, casual)
• Mention what to focus on (key points, debates, conclusions)
• Set boundaries (what to exclude)

Links

• Packagist
• GitHub Repository
• Flarum Community
• Report Issues

Sponsor

If you find this extension helpful, you can support ongoing development through GitHub Sponsors.