WordPress.org
Get WordPress

Plugin Directory

Changeset 3396309


Ignore:
Timestamp:
11/15/2025 05:51:29 PM (4 months ago)
Author:
ishchai
Message:

Updated installation instructions and added YouTube tutorial link.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • bitbloom-chatbot-for-chatkit/trunk/readme.txt

    r3396302 r3396309  
    2929
    3030== Installation ==
    31 1. Go to **Plugins → Add New → Upload Plugin** and upload the ZIP (or install from the directory when available).
     311. Download the ZIP and upload it via **Plugins → Add New → Upload Plugin**,
     32   or install it directly from the WordPress Plugin Directory.
     33
    32342. Activate **BitBloom Chatbot for Chatkit**.
    33 3. Go to **BitBloom Chatbot for Chatkit** (left menu) and set:
    34    - **Workflow ID** (Agent Builder → Publish / Get Code)
    35    - **Domain Public Key** (Security → Domain allowlist)
    36 4. (Optional) Adjust theme, greeting, and layout.
     35
     363. Add your OpenAI API key to wp-config.php:
     37
     38   define('OPENAI_API_KEY', 'sk-proj-xxxxxxxxxxxxxxxx');
     39
     40   This key must NOT be placed in the plugin settings screen for security reasons.
     41
     424. Go to **BitBloom Chatbot for Chatkit** in the WordPress admin menu and configure:
     43
     44   - **Workflow ID** 
     45     (Found in OpenAI → Agent Builder → Publish → Get Code)
     46
     47   - **Domain Public Key** 
     48     (Found in OpenAI → Agent Builder → Security → Domain allowlist)
     49
     505. (Optional) Customize theme settings:
     51   - Color scheme (light/dark)
     52   - Accent color
     53   - Corner radius
     54   - Density
     55   - Font
     56
     576. (Optional) Enable **Auto-inject** to display the floating chat launcher on all pages.
     58
     597. (Optional) To embed the chat inline inside a single page or post, use the shortcode:
     60   
     61   [bitbloom_chatbot_for_chatkit]
     62
     638. For a full video walkthrough of the installation and setup process:
     64   https://youtu.be/PstZVUaumw8
    3765
    3866== Usage ==
    … …  
    5078== Frequently Asked Questions ==
    5179
    52 = The chat opens but doesn’t answer. =
    53 Most common causes:
    54 - Workflow is not **published**.
    55 - No **credits** in your OpenAI account.
    56 - Domain not on the **allowlist** / wrong **Domain Public Key**.
     80= The chat opens but doesn’t reply. What should I check? =
     81The most common causes are:
     82- The workflow is not **published** in OpenAI’s Agent Builder.
     83- The site domain is missing from the **Domain allowlist**.
     84- Incorrect or missing **Domain Public Key**.
     85- No available **OpenAI credits** in your account.
    5786
    58 = Does the plugin store chat history on my server? =
    59 No. The plugin does not store conversation data server-side.
     87= Where do I put my OpenAI API key? =
     88Add it to your wp-config.php file:
     89define('OPENAI_API_KEY', 'sk-proj-xxxxxxxx');
     90Do not place the API key in the browser or inside the plugin settings.
    6091
    61 = Can I change how the chat looks? =
    62 Yes—choose light/dark, accent color, radius, density, and font from the settings page.
     92= Does the plugin store chat history or user messages? =
     93No. The plugin does not store any conversation data on your server. 
     94All communication is handled directly through the session created when the chat loads.
    6395
    64 = Where’s the code? =
    65 GitHub: https://github.com/BitBloom-HQ/bitbloom-chatbot-for-chatkit
     96= Does the plugin send my API key to the browser? =
     97No. The API key remains server-side. 
     98All browser requests use a WordPress REST route protected by a nonce.
     99
     100= Can I embed the chat inside a page instead of using the floating launcher? =
     101Yes. Use the shortcode:
     102[bitbloom_chatbot_for_chatkit]
     103
     104= Can I customize the look of the chat? =
     105Yes. You can change the color scheme (light/dark), accent color, radius, density, and font.
     106
     107= The chat window shows an error when loading. What causes this? =
     108Usually one of the following:
     109- Missing or invalid **Workflow ID**
     110- Incorrect **Domain Public Key**
     111- The WordPress site is blocking REST requests
     112- A security plugin is blocking nonces or AJAX
     113
     114= Does the plugin support caching plugins? =
     115Yes. The launcher and UI are safe to cache, but the REST endpoints should remain uncached. 
     116If you use aggressive caching (e.g., LiteSpeed, Cloudflare APO), exclude:
     117- /wp-json/bitbloom-chatbot-for-chatkit/*
     118
     119= Can I use multiple workflows on the same site? =
     120Yes. The shortcode supports multiple instances when placed on different pages.
     121
     122= Does the plugin work on multisite? =
     123Yes, but each subsite must configure its own Workflow ID and Domain Public Key.
     124
     125= Is this plugin GDPR-compliant? =
     126The plugin does not store personal data, but the site owner is responsible for ensuring:
     127- A proper privacy notice
     128- Compliance with data handling when using OpenAI services
    66129
    67130== Screenshots ==
Note: See TracChangeset for help on using the changeset viewer.