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:
committed by
gitbook-bot
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)**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user