mirror of
https://github.com/hexastack/hexabot
synced 2025-06-26 18:27:28 +00:00
GITBOOK-131: Update Pages Icons
This commit is contained in:
parent
e0754db955
commit
595887bc5b
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: rectangle-terminal
|
||||
---
|
||||
|
||||
# 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.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: handshake-angle
|
||||
---
|
||||
|
||||
# Contributers Installation Guide
|
||||
|
||||
## Prerequisites
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: box-open-full
|
||||
---
|
||||
|
||||
# Extensions
|
||||
|
||||
Hexabot supports **extensions**, which are modular pieces of code that add new capabilities, features, or integrations to your Hexabot instance. Extensions allow you to customize and enhance your Conversational AI by adding functionality beyond the default setup. They can be categorized into three main types: Channels, Plugins, and Helpers.
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
hidden: true
|
||||
icon: server
|
||||
---
|
||||
|
||||
# Hexabot API
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
hidden: true
|
||||
icon: message
|
||||
---
|
||||
|
||||
# Hexabot Live Chat Widget
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
hidden: true
|
||||
icon: brain-circuit
|
||||
---
|
||||
|
||||
# Hexabot NLU Engine
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
hidden: true
|
||||
icon: browser
|
||||
---
|
||||
|
||||
# Hexabot UI Admin Panel
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
icon: cube
|
||||
icon: puzzle-piece
|
||||
---
|
||||
|
||||
# Plugins
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: docker
|
||||
---
|
||||
|
||||
# Setting Up Docker for Development and Production
|
||||
|
||||
Hexabot uses Docker for development purposes as well as streamline deployment, running essential services like the API, frontend, and MongoDB in containers. The provided Docker Compose setup ensures quick and consistent startup, eliminating manual configuration complexities.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: node
|
||||
---
|
||||
|
||||
# Setup Node.js with NVM
|
||||
|
||||
Node.js is a pre-requisite to run both the Hexabot CLI and a Hexabot project since the API is built on NestJS. Using [NVM](https://github.com/nvm-sh/nvm) (Node Version Manager) simplifies managing the required Node.js version. When creating a new Hexabot project, the structure includes source folders like **extensions** to add custom plugins, helpers and channels, making Node.js essential tool for smooth development and customization.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: envelope
|
||||
---
|
||||
|
||||
# SMTP Configuration and Emails
|
||||
|
||||
{% hint style="info" %}
|
||||
@ -11,7 +15,7 @@ You have two options for handling email functionality during development:
|
||||
1. **Without SMTP**:\
|
||||
You can run the app without using SMTP by setting the environment variable `EMAIL_SMTP_ENABLED=false`. Simply run `hexabot start` and invite a new user. The app will behave as though it is sending emails, but nothing will happen in the background.
|
||||
2. **Using smtp4dev for Testing**:\
|
||||
We use `smtp4dev` for email testing in the development environment. To use this service, set the `EMAIL_SMTP_ENABLED` to `true` in the `.env` file and restart the app. Then, invite a new user or reset a password and check whether emails are received in the smtp4dev UI interface at [http://localhost:9002/](http://localhost:9002/). This also applies to other scenarios like the confirmation email after signup and the password reset email.
|
||||
We use `smtp4dev` for email testing in the development environment. To use this service, set the `EMAIL_SMTP_ENABLED` to `true` in the `.env` file and restart the app using the command `hexabot start --services smtp4dev`. Then, invite a new user or reset a password and check whether emails are received in the smtp4dev UI interface at [http://localhost:9002/](http://localhost:9002/). This also applies to other scenarios like the confirmation email after signup and the password reset email.
|
||||
|
||||
**SMTP Config (Local Dev)**
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: comment-dots
|
||||
---
|
||||
|
||||
# How can I add the Chatbot Widget to my Website?
|
||||
|
||||
The [Hexabot](https://hexabot.ai/) Live Chat Widget is a React-based embeddable widget that allows you to integrate real-time chat functionality into your website. This guide will walk you through how to add the widget to your website, customize it to fit your needs, and manage its settings.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: arrow-up-from-square
|
||||
---
|
||||
|
||||
# How can I deploy my Hexabot using NGINX ?
|
||||
|
||||
### Introduction
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: chart-line
|
||||
---
|
||||
|
||||
# Analytics Dashboard
|
||||
|
||||
{% hint style="info" %}
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: inbox-full
|
||||
---
|
||||
|
||||
# Chat Inbox
|
||||
|
||||
The Chat Inbox in Hexabot is your central hub for monitoring all conversations between your chatbot and users. This comprehensive view allows you to track interactions, review past conversations, and intervene in real-time when necessary.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: brackets-curly
|
||||
---
|
||||
|
||||
# Context Variables
|
||||
|
||||
<figure><img src="../.gitbook/assets/image (21).png" alt=""><figcaption><p>Manage Context Variables</p></figcaption></figure>
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: diagram-project
|
||||
---
|
||||
|
||||
# Flows
|
||||
|
||||
Hexabot's Flows feature allows you to organize your chatbot's conversation flows into different sections, creating dedicated tabs within the Visual Editor. This makes it easier to manage complex chatbots with multiple topics or functionalities.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: books
|
||||
---
|
||||
|
||||
# Knowledge Base
|
||||
|
||||
Hexabot's built-in Knowledge Base is where you store and manage all the information your chatbot uses to interact with users. Think of it as a centralized knowledge base that keeps all your chatbot's responses accurate, consistent, and up-to-date.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: language
|
||||
---
|
||||
|
||||
# Localization
|
||||
|
||||
Hexabot's chatbot builder allows you to create multilingual chatbots by managing languages within the platform. This feature enables you to define the languages your chatbot will support and handle translations for blocks, messages, quick replies, buttons, and more.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: gear
|
||||
---
|
||||
|
||||
# Manage Settings
|
||||
|
||||
This guide will walk you through the various settings available within the Hexabot platform, empowering you to tailor your chatbot's behavior, appearance, and integrations to suit your specific needs and goals.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: brain-circuit
|
||||
---
|
||||
|
||||
# NLU
|
||||
|
||||
### What is NLU?
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: users-between-lines
|
||||
---
|
||||
|
||||
# Subscribers
|
||||
|
||||
In Hexabot, we define a subscriber as then end-user who will ultimately interact with the chatbot. The Subscriber Management features allow you to effectively track, organize, and interact with the users who engage with your chatbot. This guide will walk you through the process of managing your subscriber base, segmenting them using labels, and leveraging subscriber data for improved communication and targeted interactions.
|
||||
|
@ -1,4 +1,8 @@
|
||||
# Manage User and Roles
|
||||
---
|
||||
icon: users-gear
|
||||
---
|
||||
|
||||
# Users and Roles
|
||||
|
||||
Hexabot offers robust user and role management features to streamline collaboration and ensure security within your chatbot projects. Whether you're working with a team of developers, content creators, or marketing professionals, Hexabot makes it easy to grant the right access levels to the right people.
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
icon: table-columns
|
||||
---
|
||||
|
||||
# Visual Editor
|
||||
|
||||
<figure><img src="../../.gitbook/assets/mediamodifier_image.png" alt=""><figcaption></figcaption></figure>
|
||||
|
Loading…
Reference in New Issue
Block a user