ReplyRabbit Documentation
ReplyRabbit is the AI draft-reply module for the FreeScout help desk. These guides walk you through installing it, connecting an AI provider, and getting your first draft reply.
Start here
Getting startedInstall ReplyRabbit, connect an AI provider, and generate your first draft reply in FreeScout in about ten minutes.What is FreeScout?FreeScout is a free, self-hosted, open-source help desk and shared-inbox platform. Here is what it does and who it is for.What is ReplyRabbit?ReplyRabbit is a FreeScout module that drafts customer replies with AI for agents to review and send, adds next actions, and files bugs as tracker issues.Why use AI?Why FreeScout teams should use AI: a reviewed draft on every ticket cuts typing without giving up control, and ReplyRabbit adds it to FreeScout in minutes.
Install & setup
Install FreeScoutA step-by-step overview of installing the self-hosted FreeScout help desk, with links to the official requirements and installer.Install ReplyRabbitInstall the ReplyRabbit module in FreeScout: download the right build for your licence, add it to your Modules folder, activate it in the admin, and clear the cache.Free vs paid buildsReplyRabbit ships two module builds. See what the free build includes, which features only exist in the paid build, and how to upgrade without losing settings.Set up ReplyRabbitConfigure your AI provider and API key, mailbox settings, company context, AI Signals, Workflow Tags, issue tracker, and optional Slack notifications.Linear integrationConnect ReplyRabbit to Linear so FreeScout support conversations can become structured engineering issues with context and status.GitHub Issues integrationConnect ReplyRabbit to GitHub Issues so FreeScout conversations can become linked issues with repository routing, labels, assignees, and status follow-up.Anthropic integrationConnect Anthropic to ReplyRabbit for FreeScout with your own API key, model selection, prompt caching behavior, token budget, and troubleshooting.Workflows integrationConfigure ReplyRabbit Workflow Tags so AI signals, draft state, no-reply decisions, and Linear links become FreeScout tags for workflow recipes.Jira integrationConnect ReplyRabbit to Jira Cloud so FreeScout conversations can become structured Jira issues with status sync and follow-up drafts.OpenAI integrationConnect OpenAI to ReplyRabbit for FreeScout draft generation with your own API key, model selection, prompt cache routing, token budgets, licensed semantic retrieval notes, and troubleshooting.Slack integrationSet up ReplyRabbit Slack notifications for FreeScout with an incoming webhook, test message, issue tracker alerts, and safe troubleshooting.Gemini integrationConnect Google AI Studio and Gemini models to ReplyRabbit for FreeScout with your own API key, model choice, cache token reporting, and setup checks.Ollama integrationConfigure Ollama as a local ReplyRabbit AI provider for FreeScout with localhost setup, model selection, testing, and troubleshooting.MCP clientsEnable the ReplyRabbit MCP endpoint, create a scoped bearer token, and connect approved MCP clients to safe FreeScout support context.OpenRouter integrationConnect OpenRouter to ReplyRabbit for FreeScout with your own API key, auto-router or model ID, cache reporting behavior, setup checks, and troubleshooting.WooCommerce connectorConnect WooCommerce to FreeScout with REST API keys so conversations show matched customer orders and purchase context, including full order history, line items, financials, and AI product-ownership.Magento connectorConnect Magento 2 or Adobe Commerce to FreeScout so conversations show matched customer orders and purchase context, including full order history, line items, financials, and AI product-ownership.Shopify connectorConnect Shopify to FreeScout with a custom app access token so conversations show matched customer orders and purchase context, including full order history, line items, financials, and AI product-ownership.Stripe ConnectorConnect Stripe to FreeScout with a restricted read-only API key and see recent customer payment details beside each support conversation.Semantic SearchInstall and set up the Semantic Search module for FreeScout. Multi-word searches work out of the box, and with your own OpenAI, Gemini, or compatible key it finds conversations by meaning and shows similar conversations in the sidebar.Connect FreeScout KBTurn on the FreeScout Knowledge Base source so ReplyRabbit drafts use your own help articles and link customers to the one that answers their question.Connect Outline KBConnect your Outline wiki to ReplyRabbit so drafts can draw on your team's knowledge base without sharing it with customers.Custom AI endpointSet up ReplyRabbit with your own OpenAI-compatible chat endpoint, optional bearer token, and separate models for embeddings and vision.Upgrade to PHP 8.5A checklist for moving a self-hosted FreeScout help desk to PHP 8.5, including why deprecation notices break FreeScout modules and how to check extensions, workers, and logs.Opportunity SuggestionsWeave relevant offering suggestions into drafts at natural sales moments like cancellations and pre-sales questions, with strict guardrails to protect tone and accuracy.
Reference
Choosing a providerCompare cloud, local, and custom OpenAI-compatible AI providers for ReplyRabbit, including privacy, model setup, and prompt caching.FAQAnswers to common questions about ReplyRabbit: data privacy, costs, prompt caching, supported models, local AI, Workflow Tags, and how drafts are generated.Built-in AIHow ReplyRabbit's built-in AI works on Pro and Team, its monthly fair-use allowance, what happens when it runs out, how to switch to your own key, and how support content is handled.TroubleshootingFixes for common ReplyRabbit issues: no draft generated, provider errors, errors after a PHP upgrade, missing menu, issue tracker tickets, Workflow Tags, knowledge sources, FreeScout cache, and prompt caching.Per-task AI modelsPick a separate provider, model, and API key for drafts, embeddings, mailbox previews, and attachment vision so routine tasks run on a cheaper model.PHP 8.5 errorsAfter upgrading to PHP 8.5, FreeScout modules can fail with "Function curl_close() is deprecated since 8.5". Find the module in the log, update it, and restart workers.Learning from past repliesWhat ReplyRabbit reads before it drafts a reply, how many past replies it searches per customer, how it learns your style, and what it doesn't use.Answers to other customersLet ReplyRabbit check each draft against answers your team already sent to other customers. How to turn it on step by step, what's stored, and what never carries over.Order context for supportGive FreeScout agents the order context they need to answer Shopify and WooCommerce questions accurately, without asking customers to repeat themselves.