Hexastack · marrouchi · Sep 13, 2024 · Sep 13, 2024 · Sep 13, 2024 · Sep 13, 2024
diff --git a/docs/.gitbook/assets/1.png b/docs/.gitbook/assets/1.png
diff --git a/docs/.gitbook/assets/2.png b/docs/.gitbook/assets/2.png
diff --git a/docs/.gitbook/assets/3.png b/docs/.gitbook/assets/3.png
diff --git a/docs/.gitbook/assets/4.png b/docs/.gitbook/assets/4.png
diff --git a/docs/.gitbook/assets/Mockup 01.png b/docs/.gitbook/assets/Mockup 01.png
diff --git a/docs/.gitbook/assets/Screenshot 2024-10-14 at 12.41.53 PM.png b/docs/.gitbook/assets/Screenshot 2024-10-14 at 12.41.53 PM.png
diff --git a/docs/.gitbook/assets/Untitled.png b/docs/.gitbook/assets/Untitled.png
diff --git a/docs/.gitbook/assets/WorkWithPassionBg.7161134c.png b/docs/.gitbook/assets/WorkWithPassionBg.7161134c.png
diff --git a/docs/.gitbook/assets/image (1) (1) (1) (1) (1) (1).png b/docs/.gitbook/assets/image (1) (1) (1) (1) (1) (1).png
diff --git a/docs/.gitbook/assets/image (1) (1) (1) (1) (1).png b/docs/.gitbook/assets/image (1) (1) (1) (1) (1).png
diff --git a/docs/.gitbook/assets/image (1) (1) (1) (1).png b/docs/.gitbook/assets/image (1) (1) (1) (1).png
diff --git a/docs/.gitbook/assets/image (1) (1) (1).png b/docs/.gitbook/assets/image (1) (1) (1).png
diff --git a/docs/.gitbook/assets/image (1) (1).png b/docs/.gitbook/assets/image (1) (1).png
diff --git a/docs/.gitbook/assets/image (1).png b/docs/.gitbook/assets/image (1).png
diff --git a/docs/.gitbook/assets/image (10).png b/docs/.gitbook/assets/image (10).png
diff --git a/docs/.gitbook/assets/image (11).png b/docs/.gitbook/assets/image (11).png
diff --git a/docs/.gitbook/assets/image (12).png b/docs/.gitbook/assets/image (12).png
diff --git a/docs/.gitbook/assets/image (13).png b/docs/.gitbook/assets/image (13).png
diff --git a/docs/.gitbook/assets/image (14).png b/docs/.gitbook/assets/image (14).png
diff --git a/docs/.gitbook/assets/image (15).png b/docs/.gitbook/assets/image (15).png
diff --git a/docs/.gitbook/assets/image (16).png b/docs/.gitbook/assets/image (16).png
diff --git a/docs/.gitbook/assets/image (17).png b/docs/.gitbook/assets/image (17).png
diff --git a/docs/.gitbook/assets/image (18).png b/docs/.gitbook/assets/image (18).png
diff --git a/docs/.gitbook/assets/image (19).png b/docs/.gitbook/assets/image (19).png
diff --git a/docs/.gitbook/assets/image (2) (1) (1).png b/docs/.gitbook/assets/image (2) (1) (1).png
diff --git a/docs/.gitbook/assets/image (2) (1).png b/docs/.gitbook/assets/image (2) (1).png
diff --git a/docs/.gitbook/assets/image (2).png b/docs/.gitbook/assets/image (2).png
diff --git a/docs/.gitbook/assets/image (20).png b/docs/.gitbook/assets/image (20).png
diff --git a/docs/.gitbook/assets/image (21).png b/docs/.gitbook/assets/image (21).png
diff --git a/docs/.gitbook/assets/image (22).png b/docs/.gitbook/assets/image (22).png
diff --git a/docs/.gitbook/assets/image (23).png b/docs/.gitbook/assets/image (23).png
diff --git a/docs/.gitbook/assets/image (24).png b/docs/.gitbook/assets/image (24).png
diff --git a/docs/.gitbook/assets/image (25).png b/docs/.gitbook/assets/image (25).png
diff --git a/docs/.gitbook/assets/image (26).png b/docs/.gitbook/assets/image (26).png
diff --git a/docs/.gitbook/assets/image (27).png b/docs/.gitbook/assets/image (27).png
diff --git a/docs/.gitbook/assets/image (28).png b/docs/.gitbook/assets/image (28).png
diff --git a/docs/.gitbook/assets/image (3) (1).png b/docs/.gitbook/assets/image (3) (1).png
diff --git a/docs/.gitbook/assets/image (3).png b/docs/.gitbook/assets/image (3).png
diff --git a/docs/.gitbook/assets/image (4) (1).png b/docs/.gitbook/assets/image (4) (1).png
diff --git a/docs/.gitbook/assets/image (4).png b/docs/.gitbook/assets/image (4).png
diff --git a/docs/.gitbook/assets/image (5).png b/docs/.gitbook/assets/image (5).png
diff --git a/docs/.gitbook/assets/image (6).png b/docs/.gitbook/assets/image (6).png
diff --git a/docs/.gitbook/assets/image (7).png b/docs/.gitbook/assets/image (7).png
diff --git a/docs/.gitbook/assets/image (8).png b/docs/.gitbook/assets/image (8).png
diff --git a/docs/.gitbook/assets/image (9).png b/docs/.gitbook/assets/image (9).png
diff --git a/docs/.gitbook/assets/image.png b/docs/.gitbook/assets/image.png
diff --git a/docs/.gitbook/assets/mediamodifier_image.png b/docs/.gitbook/assets/mediamodifier_image.png
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,58 @@
+---
+icon: house-window
+layout:
+  title:
+    visible: true
+  description:
+    visible: false
+  tableOfContents:
+    visible: true
+  outline:
+    visible: true
+  pagination:
+    visible: true
+---
+
+# Welcome
+
+Welcome to the Hexabot Documentation! Hexabot is a powerful and versatile open-source chatbot platform designed to simplify the creation and management of intelligent conversational chatbots. Whether you're a business owner seeking to automate customer interactions, an organization looking to engage your audience, or a developer wanting to integrate conversational AI into your applications, Hexabot provides the tools and flexibility you need.
+
+<figure><img src=".gitbook/assets/Mockup 01.png" alt=""><figcaption><p>A preview of Hexabot visual editor</p></figcaption></figure>
+
+## Key Features
+
+Hexabot comes equipped with a comprehensive suite of features to empower your chatbot development:
+
+* **Intuitive Visual Editor:** Build complex conversation flows without coding using our drag-and-drop interface and a diverse library of pre-built blocks.
+* **NLU Engine:** Leverage state-of-the-art NLU technology to understand user intent, extract key information, and deliver personalized responses.
+* **Flexible Deployment Options:** Deploy your chatbots on various platforms, including Facebook Messenger, web widgets, and custom integrations.
+* **Comprehensive Analytics and Reporting:** Track key metrics, monitor chatbot performance, and gain valuable insights into user interactions.
+* **And More:** Discover a range of additional features, including user segmentation, content management, and third-party integrations.
+
+## Who Should Use This Documentation
+
+This documentation is a valuable resource for:
+
+* **New Users:** Get started with Hexabot, learn the basics of chatbot creation, and build your first conversational chatbot.
+* Experienced Users: Explore advanced features, optimize your existing chatbots, and discover best practices for chatbot development.
+* Developers: Integrate Hexabot with your applications, leverage our APIs, and extend the platform's functionality by developing add-ons for Hexabot.
+* Administrators: Manage users, configure settings, and ensure the smooth operation of Hexabot within your organization.
+
+## How to Use This Documentation
+
+To navigate this documentation effectively:
+
+* Search: Use the search bar to quickly find information on specific topics or keywords.
+* Navigation: Browse through the table of contents to explore different sections and find the information you need.
+* Links: Follow links to related articles and resources for in-depth explanations and examples.
+
+Feedback: We encourage you to provide feedback and suggestions for improvement. Your input helps us make this documentation even better.
+
+## Contacting Support
+
+If you encounter any issues or have questions not addressed in this documentation, our dedicated support team is here to assist you. Please contact us at [hello@hexabot.ai](mailto:hello@hexabot.ai)
+
+### Jump right in
+
+<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting Started</strong></td><td>Install Hexabot and create your first flow</td><td><a href=".gitbook/assets/1.png">1.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>Product overview</strong></td><td>Key Features and Capabilities</td><td><a href=".gitbook/assets/4.png">4.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>User Guide</strong></td><td>Learn the basics of Hexabot</td><td><a href=".gitbook/assets/2.png">2.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>Developer Guide</strong></td><td>Learn how to develop for Hexabot</td><td><a href=".gitbook/assets/3.png">3.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>Key Concepts</strong></td><td>Understanding the Fundamentals of Chatbot Building</td><td><a href=".gitbook/assets/3.png">3.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr></tbody></table>
+
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -0,0 +1,69 @@
+# Table of contents
+
+* [Welcome](README.md)
+
+## Introduction
+
+* [Overview](introduction/overview.md)
+* [Features](introduction/features.md)
+
+## Quickstart
+
+* [Installation](quickstart/installation.md)
+* [Create your first flow](quickstart/create-your-first-flow.md)
+
+## USER GUIDE
+
+* [Visual Editor](user-guide/visual-editor/README.md)
+  * [Using the Visual Editor](user-guide/visual-editor/using-the-visual-editor.md)
+  * [Regular Blocks](user-guide/visual-editor/regular-blocks/README.md)
+    * [Using Simple Text Block](user-guide/visual-editor/regular-blocks/using-simple-text-block.md)
+    * [Using Quick Replies Block](user-guide/visual-editor/regular-blocks/using-quick-replies-block.md)
+    * [Using Buttons Block](user-guide/visual-editor/regular-blocks/using-buttons-block.md)
+    * [Using Attachment Block](user-guide/visual-editor/regular-blocks/using-attachment-block.md)
+  * [Using Advanced Blocks](user-guide/visual-editor/using-advanced-blocks.md)
+* [Flows](user-guide/flows.md)
+* [NLU Training](user-guide/nlu-training.md)
+* [Knowledge Base](user-guide/knowledge-base/README.md)
+  * [Content Types](user-guide/knowledge-base/content-types.md)
+  * [Manage Persistent Menu](user-guide/knowledge-base/manage-persistent-menu.md)
+  * [Media Library](user-guide/knowledge-base/media-library.md)
+* [Localization](user-guide/localization/README.md)
+  * [Languages](user-guide/localization/languages.md)
+  * [Translations](user-guide/localization/translations.md)
+* [Users and Roles](user-guide/users-and-roles/README.md)
+  * [Manage users](user-guide/users-and-roles/manage-users.md)
+  * [Manage roles](user-guide/users-and-roles/manage-roles.md)
+* [Manage Settings](user-guide/manage-settings/README.md)
+  * [Email](user-guide/manage-settings/email.md)
+  * [Chatbot Global Fallback](user-guide/manage-settings/chatbot-global-fallback.md)
+  * [NLU Provider](user-guide/manage-settings/nlu-provider.md)
+  * [Web Channel](user-guide/manage-settings/web-channel.md)
+  * [Live chat widget](user-guide/manage-settings/live-chat-widget.md)
+  * [Facebook Messenger](user-guide/manage-settings/facebook-messenger.md)
+* [Context Variables](user-guide/context-variables.md)
+* [Chat Inbox](user-guide/chat-inbox.md)
+* [Subscribers](user-guide/subscribers.md)
+* [Analytics Dashboard](user-guide/analytics-dashboard.md)
+
+## FAQ
+
+* [How can I add the Chatbot Widget to my Website?](faq/how-can-i-add-the-chatbot-widget-to-my-website.md)
+
+## Developer Guide
+
+* [CLI Command Reference](developer-guide/cli-command-reference.md)
+* [Contributers Installation Guide](developer-guide/contributers-installation-guide.md)
+* [Hexabot UI Admin Panel](developer-guide/hexabot-ui-admin-panel.md)
+* [Hexabot Live Chat Widget](developer-guide/hexabot-live-chat-widget.md)
+* [Hexabot API](developer-guide/hexabot-api.md)
+* [Hexabot NLU Engine](developer-guide/hexabot-nlu-engine.md)
+* [Plugins](developer-guide/integrations/README.md)
+  * [Build Your First plugin](developer-guide/integrations/build-your-first-plugin.md)
+  * [RAG Plugin](developer-guide/integrations/openapi.md)
+* [SMTP Configuration and Emails](developer-guide/smtp-configuration-and-emails.md)
+
+## Key Concepts
+
+* [NLU](key-concepts/nlu.md)
+* [Intent](key-concepts/intent.md)
diff --git a/docs/developer-guide/cli-command-reference.md b/docs/developer-guide/cli-command-reference.md
@@ -0,0 +1,159 @@
+# CLI Command Reference
+
+Hexabot CLI is a powerful command-line tool to help manage your Hexabot chatbot instance. With it, you can create new projects, initialize environments, start services in various modes, run database migrations, and more. The CLI aims to make managing your chatbot seamless and intuitive.
+
+Not yet familiar with [Hexabot](https://hexabot.ai/)? It's a open-source chatbot / agent solution that allows users to create and manage AI-powered, multi-channel, and multilingual chatbots with ease. If you would like to learn more, please visit the [official github repo](https://github.com/Hexastack/Hexabot/).
+
+### Getting Started
+
+#### Prerequisites
+
+* Node.js >= 18.17.0
+* npm (Node Package Manager)
+* Docker installed
+
+#### Installation
+
+Install Hexabot CLI globally to have easy access to its commands:
+
+```
+npm install -g hexabot-cli
+```
+
+#### Usage
+
+Once installed, you can use the `hexabot` command in your terminal. Here are some of the available commands:
+
+#### Commands
+
+**`create <projectName>`**
+
+Create a new Hexabot project.
+
+```
+hexabot create my-chatbot
+```
+
+Options:
+
+* `--template <template>`: Specify a GitHub repository in the format `GITHUB_USERNAME/GITHUB_REPO` to use a custom template.
+
+Example:
+
+```
+hexabot create my-chatbot --template myusername/my-template-repo
+```
+
+**`init`**
+
+Initialize the environment by copying `.env.example` to `.env`.
+
+```
+hexabot init
+```
+
+**`dev`**
+
+Start specified services in development mode with Docker Compose.
+
+```
+hexabot dev --services nlu,ollama
+```
+
+Options:
+
+* `--services <services>`: Comma-separated list of services to enable.
+
+**`start`**
+
+Start specified services with Docker Compose.
+
+```
+hexabot start --services api,nlu
+```
+
+Options:
+
+* `--services <services>`: Comma-separated list of services to enable.
+
+**`migrate [args...]`**
+
+Run database migrations.
+
+```
+hexabot migrate
+```
+
+You can also pass additional arguments to the migration command.
+
+**`start-prod`**
+
+
+
+Start specified services in production mode with Docker Compose.
+
+```
+hexabot start-prod --services api,nlu
+```
+
+Options:
+
+* `--services <services>`: Comma-separated list of services to enable.
+
+**`stop`**
+
+Stop specified Docker Compose services.
+
+```
+hexabot stop --services api,nlu
+```
+
+Options:
+
+* `--services <services>`: Comma-separated list of services to stop.
+
+**`destroy`**
+
+Destroy specified Docker Compose services and remove volumes.
+
+```
+hexabot destroy --services api,nlu
+```
+
+Options:
+
+* `--services <services>`: Comma-separated list of services to destroy.
+
+### Example Workflow
+
+1.  **Create a new project**:
+
+    ```
+    hexabot create my-chatbot
+    ```
+
+    This will create a new folder `my-chatbot` with all necessary files to get started.
+2.  **Navigate to your project folder**:
+
+    ```
+    cd my-chatbot
+    ```
+3.  **Install dependencies**:
+
+    ```
+    npm install
+    ```
+4.  **Initialize environment**:
+
+    ```
+    hexabot init
+    ```
+
+    This command copies the `.env.example` file to `.env`, which you can edit to customize your configuration.
+5.  **Run in development mode**:
+
+    ```
+    hexabot dev --services nlu,ollama
+    ```
+
+    This starts the required services in development mode.
diff --git a/docs/developer-guide/contributers-installation-guide.md b/docs/developer-guide/contributers-installation-guide.md
@@ -0,0 +1,53 @@
+# Contributers Installation Guide
+
+## Prerequisites
+
+To ensure Hexabot runs smoothly, you'll need the following:
+
+* **Docker:** We recommend using Docker to start the app since multiple services are required (MongoDB, Redis, Prometheus, etc.). All the necessary Docker Compose files are located in the docker folder.
+* **Node.js:** For development purposes, ensure you have Node.js >= v18.17.0 installed. We recommend using nvm (Node Version Manager) to easily manage and update your Node.js versions.
+
+### Installation
+
+1. **Clone the Repository:**
+
+```
+$ git clone https://github.com/hexastack/hexabot.git
+```
+
+2. **Installation:**
+
+Install Hexabot CLI and node dependencies:
+
+```
+$ npm i -g hexabot-cli
+$ cd hexabot/
+$ npm i
+```
+
+2. **Environment Setup:**&#x20;
+
+To configure the environment variables, use the Makefile at the root folder for initialization:
+
+```
+$ hexabot init
+```
+
+This will copy the `.env.example` file to `.env` in the `./docker` directory if the file does not already exist.
+
+3. **Running the Application in development mode:** Once your environment is set up, you can start the app. Use the following command:
+
+```
+$ hexabot dev --enable nlu,widget
+```
+
+**Note:** The first time you run the app, Docker will take some time to build all the required Docker images cache the layers.
+
+### Usage
+
+UI Admin Panel is accessible via [http://localhost:8080](http://localhost:8080), the default credentials are :
+
+* **Username:** [admin@admin.admin](mailto:admin@admin.admin)
+* **Password:** adminadmin
+
+Live Chat Widget is accessible via [http://localhost:5173](http://localhost:5173)