View All Documentation

Stella AI Chatbot: Installation and User Guide for Websites

Stella AI Chatbot for Websites and Customer Support

Stella AI Chatbot installation and user guide covering FAQ automation, lead capture, AI conversations, RAG, human handoff, and Pro analytics for websites.

This guide covers both Free and Pro editions in one place. Where a feature is Pro-only, it is marked (Pro).

1. Installation

1.1 Requirements

  1. Node.js 18+ - Required runtime to run the chatbot backend server.
  2. npm - Required to install project dependencies.
  3. Modern browser - Required to access admin panel and test widget behavior.
  4. PostgreSQL 13+ (Pro optional) - Required only if you choose PostgreSQL storage mode.
  5. pgvector (Pro optional) - Required for PostgreSQL vector similarity search in RAG mode.
  6. Ollama (Pro optional) - Required only if you want local embedding generation with zero API cost.

1.2 Download and Prepare

  1. Extract package - Unzip either stella-ai-chatbot-free or stella-ai-chatbot-pro.
  2. Open folder in terminal - Run all install/start commands from this directory.
  3. Install dependencies - Downloads all required backend libraries.
npm install

1.3 Configure Environment

  1. Create .env - Copy .env.example to .env.
  2. Set required variables:
    • NODE_ENV - Defines runtime mode (development or production).
    • APP_SECRET - Used to sign/verify secure tokens and sessions.
    • ADMIN_USER - Admin login username.
    • ADMIN_PASS - Admin login password.
    • INSTALL_TOKEN - Protects installer from unauthorized access.
    • CORS_ORIGINS / ALLOWED_ORIGINS - Controls which origins can call APIs.
    • DATA_ENCRYPTION_KEY - Used for encryption of sensitive data (if supported in your edition).
  3. Optional variables:
    • PORT - Server port (platform can override dynamically).
    • TRUST_PROXY=true - Enable correct IP detection behind reverse proxy/CDN.

1.4 Start Application

npm start
  • /install - First-time setup wizard.
  • /admin - Admin login and dashboard.

1.5 Installer Steps

  1. Open installer - /install Initializes chatbot system.
  2. Enter install token - Confirms authorized installation.
  3. Select storage mode:
    • Free: JSON storage.
    • Pro: JSON or PostgreSQL.
  4. Complete install - Creates required defaults/settings.
  5. install.lock generated - Prevents accidental reinstallation and it is present in the data folder.

1.6 Embed Widget on Any Website

  1. Open Embed Code section - Generates script for frontend integration.
  2. Copy script - Includes widget loader and API base URL.
  3. Paste before </body> - Ensures widget loads after page content.
  4. Refresh site - Verifies chatbot appears and works.

1.7 Production Checklist

  1. Enable HTTPS - Protects traffic and credentials.
  2. Use strong secrets - Prevents token/session compromise.
  3. Restrict domains - Prevents widget/API misuse on unauthorized sites.
  4. Protect installer - Blocks public reinstall attacks.
  5. Enable CSRF/security controls - Protects admin write actions.
  6. Set retention policy - Keeps logs manageable and compliant.

2. User Guide (Step-by-Step)

2.1 Admin Login

  1. Open /admin - Access admin entry page.
  2. Sign in - Uses credentials from .env.
  3. Navigate menu - Overview, Settings, FAQs, Logs.

2.2 Overview Page

  1. Usage stats - Shows chatbot activity summary.
  2. Matched vs unmatched - Shows answer quality trend.
  3. Top matched keywords - Identifies what users ask successfully.
  4. Top unmatched questions - Shows FAQ/AI content gaps to improve.

2.3 Settings Page

A. Core Identity

  1. Chatbot Name - Display title shown in the chat header.
  2. Avatar Upload - Brand image shown in widget launcher and chat.
  3. Avatar Shape - Controls whether avatar appears round or square.
  4. Show Live Preview - Toggles real-time preview in admin settings page.

B. Messaging & Engagement

  1. Welcome Message - Message shown when a user opens the chatbox.
  2. No Match Message - Fallback response when no answer is found.
  3. Fuzzy Match - Matches similar keywords/questions even if not exact.
  4. Fuzzy Threshold - Controls strictness of fuzzy matching.
  5. Lead Capture - Collects visitor name/email before or during chat.
  6. Lead Capture Prompt - Message shown when asking for user details.

C. Widget Appearance

  1. Widget Position - Places launcher on left or right side.
  2. Widget Size - Controls launcher diameter/visual footprint.
  3. Brand/Theme Colors - Matches widget with your site branding.
  4. Avatar Size - Controls bot avatar size inside chat UI.
  5. Animation - Adds attention effects like pulse/shake/float.
  6. Chatbox Width/Height - Controls conversation panel dimensions.

D. System & Performance

  1. Items Per Page - Pagination size for admin tables.
  2. Log Retention Days - Days to keep logs before cleanup.
  3. Auto Cleanup - Automatically deletes old data by retention rule.
  4. Enforce HTTPS - Blocks insecure non-HTTPS requests (non-localhost).
  5. Enforce Admin CSRF - Requires CSRF token for admin write operations.

E. Categories

  1. Add Category - Creates new grouping for FAQ/chat flows.
  2. Recommended Categories - Up to 3 categories shown first in widget.
  3. Delete Category - Removes unused category (or merge/reassign logic applies).

F. Embed Code

  1. API Base URL - Defines backend URL used by widget script.
  2. Allowed Widget Domains - Restricts where widget can run.
  3. Widget Domain Policy - restricted enforces allowed domain list.
  4. Regenerate / Copy Code - Refreshes and copies embed script.

2.4 Pro Features in Settings (Pro)

A. Human Handoff (Pro)

  1. Enable Handoff - Activates escalation to human support.
  2. Escalate After Unmatched - Number of failed matches before handoff.
  3. Handoff Message - Message shown when escalation triggers.
  4. Support URL - Link users click to contact human support.
  5. Business Hours - Optional time window to trigger handoff behavior.

B. AI Powered Responses (Pro)

  1. AI Provider - Selects backend LLM service.
  2. API Key - Auth key for selected provider.
  3. Load Models - Fetches available models for that provider/key.
  4. AI Model - Model used for response generation.
  5. Test Connection - Validates key/model/provider setup.
  6. Max Tokens - Maximum response output length from AI model.
  7. System Instructions - Defines bot behavior/tone/rules.
  8. AI Disclaimer - Optional caution text shown under AI answers.

C. Vector Retrieval (RAG) (Pro)

  1. Enable RAG - Allows retrieval from indexed website content.
  2. Use PostgreSQL pgvector - Enables scalable vector storage/search.
  3. Embedding Provider - Service used to convert text to vectors.
  4. Embedding API Key - Authentication for embedding provider.
  5. Fetch Models - Loads available embedding models.
  6. Embedding Model - Model used for indexing and query embeddings.
  7. Test Embedding Connection - Verifies embedding endpoint works.
  8. Crawl Root URL / Sitemap - Defines crawl starting points.
  9. Max Pages / Max Depth - Controls crawl size and recursion depth.
  10. Chunk Size / Overlap - Controls text segmentation for retrieval quality.
  11. Include / Exclude Patterns - Fine control over crawled URLs.
  12. Resume Mode - Skips already indexed URLs during recrawl.
  13. Crawl Website Content - Starts indexing job.
  14. RAG Ranking Mode - Controls ranking strategy (Balanced / Exact Product First).

2.5 FAQs Page

  1. Add FAQ - Manual Q&A creation with unique keyword.
  2. Edit/Delete FAQ - Maintain and correct existing responses.
  3. Import File - Bulk upload FAQs from TXT/CSV/CSB/DOCX.
  4. Delimiter Option - Parses custom file formats (:, ,, |, etc).
  5. Duplicate Keyword Handling - Skip or suffix duplicates during import.
  6. Category Handling - Create missing categories or use fallback category.
  7. Import Summary - Shows added/rejected/duplicate counts.

2.6 Logs Page

  1. Session Filters - Search by session key, name, or email.
  2. Show Chat - Opens chat history for selected session only.
  3. Leads Table - Displays captured visitor contact details.
  4. Pagination - Navigate large datasets efficiently from top/bottom controls.

2.7 Frontend Behavior

  1. Widget Open - User opens launcher and enters chat.
  2. Welcome/Categories - Intro and recommendations appear (if enabled).
  3. User Query Handling:
    • Free: FAQ + fuzzy match flow.
    • Pro: FAQ + AI + RAG + handoff rules.
  4. Lead Collection - Name/email prompt appears when enabled.
  5. Logging - Session/messages/leads saved for analytics.

2.8 Troubleshooting

  1. Widget not visible - Validate embed code, domain policy, and browser console.
  2. Short AI answers - Try another model/provider, raise max tokens, test provider response metadata.
  3. RAG not answering - Confirm crawl success, embedding config, and ranking mode.
  4. Install blocked - Verify install token and lock/maintenance behavior.

2.9 Recommended Rollout Path

  1. Start with FAQ + categories - Build reliable baseline answers.
  2. Enable fuzzy match - Improve question tolerance.
  3. Enable lead capture - Start collecting qualified contacts.
  4. (Pro) Enable AI - Handle broader natural-language queries.
  5. (Pro) Enable RAG - Ground answers in your own site content.
  6. (Pro) Enable handoff - Escalate complex user needs to humans.
  7. Finalize security + deploy - Lock policy and go production.