Skip to content

Installation and Setup Guide

Jump to bottom
Kazuo Kashima edited this page Jul 30, 2025 · 6 revisions

WP RAG Installation and Setup Guide

This guide will walk you through the process of installing and setting up the WP RAG plugin, which enables RAG (Retrieval-Augmented Generation) functionality using your WordPress post data.

📹 Video Walkthrough

For a visual demonstration of the installation and setup process, watch our step-by-step video guide: Watch Installation & Setup Demo →

Installation

  1. Download the plugin source code from the GitHub repository:
    https://github.com/mobalab/wp-rag/releases

  2. Upload the plugin to your WordPress installation:

    • Extract the downloaded source code
    • Upload the wp-rag directory to <WordPress root>/wp-content/plugins/
    • The final path should look like: <WordPress root>/wp-content/plugins/wp-rag/

  3. Navigate to the WordPress plugins page in your admin dashboard and activate the WP RAG plugin.

    wp-rag-plugin-list

Configuration

Step 1: Register Your Site

  1. In the WordPress admin dashboard, click on "WP RAG" in the left menu.

  2. Go to "General Settings".

  3. Click the "Register" button to initiate site verification.

    wp-rag-before-registration

    Note: The verification process may take a few seconds as our API server validates your WordPress site.

  4. After successful verification, check the System Status on the main plugin page. You should see a green checkmark indicating "This WordPress site is verified."

    wp-rag-status-1

Step 2: Configure AI Settings

  1. Navigate to "AI Configuration" from the left menu.

  2. Enter your OpenAI API Key.

  3. Click "Submit" to save the configuration.

    wp-rag-set-openai-api-key

Step 3: Import and Process Content

  1. Return to the main plugin page.
  2. Click the "Import" button to fetch posts from your WordPress site.
  3. After the import completes, click the "Embed" button to generate embeddings for the imported posts.

Step 4: Test and Deploy

  1. Use the "Test Query" section on the main plugin page to verify that the chatbot is working correctly.
  2. Once testing is successful, you can add the chatbot to any post or page using the following shortcode: 
    [wp_rag_chat]
    wp-rag-shortcode

System Status Checklist

Before deploying the chatbot, ensure all these items show green checkmarks in the System Status:

  • WordPress site verification
  • OpenAI API Key configuration
  • Post import completion
  • Embedding generation completion
wp-rag-status-4

Support

If you encounter any issues during installation or setup, please open an issue on our GitHub repository.

Clone this wiki locally