Hexabot
Go to websiteGitHub RepoDiscord
  • Welcome
  • Introduction
    • Overview
    • Features
  • Quickstart
    • Installation
    • Create your first flow
  • USER GUIDE
    • Visual Editor
      • Using the Visual Editor
      • Regular Blocks
        • Using Simple Text Block
        • Using Quick Replies Block
        • Using Buttons Block
        • Using Attachment Block
      • Using Advanced Blocks
    • Flows
    • NLU
      • Manage NLU Entities
      • NLU Engines
        • LLM NLU Engine
        • Ludwig NLU Engine
        • Tensorflow NLU Engine
    • Knowledge Base
      • Content Types
      • Manage Persistent Menu
      • Media Library
    • Localization
      • Languages
      • Translations
    • Users and Roles
      • Manage users
      • Manage roles
    • Manage Settings
      • Email
      • Chatbot Global Fallback
      • NLU Provider
      • Web Channel
      • Live chat widget
      • Facebook Messenger
    • Context Variables
    • Chat Inbox
    • Subscribers
    • Analytics Dashboard
  • FAQ
    • How can I deploy my Hexabot using NGINX ?
    • How can I add the Chatbot Widget to my Website?
  • Developer Guide
    • Contributors Installation Guide
    • CLI Command Reference
    • Setup Node.js with NVM
    • Setting Up Docker for Development and Production
    • SMTP Configuration and Emails
    • Extensions
    • Plugins
      • Hexabot Plugin Development
      • Build your First Plugin
    • Training custom NLU Models with Ludwig AI
Powered by GitBook
On this page
  • Prerequisites
  • Installation
  • Usage

Was this helpful?

Edit on GitHub
  1. Quickstart

Installation

PreviousFeaturesNextCreate your first flow

Last updated 4 months ago

Was this helpful?

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, Nginx, 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.

Do you want to install Hexabot on a Windows machine?
  1. Download and install Docker Desktop for Windows.

  2. During installation, ensure that you select the option to use WSL 2 as the default backend for Docker.

  3. After installation, start Docker Desktop and verify that WSL integration is enabled:

  4. Open Docker Desktop and go to Settings. Under the General tab, ensure that "Use the WSL 2 based engine" is selected. Under Resources > WSL Integration, enable integration with your installed Linux distribution (e.g., Ubuntu). Restart your machine to finalize the Docker installation.

  5. Open your WSL terminal (e.g., Ubuntu).

  6. Follow Hexabot steps below

Learn more :

Installation

  1. Install Hexabot CLI globally to have easy access to its commands:

npm install -g hexabot-cli
  1. Create a new project:

hexabot create my-chatbot
  1. Navigate to your project folder

cd my-chatbot/
  1. Install dependencies:

npm i
  1. Environment Setup:

To configure the environment variables, use the following command:

hexabot init

This will copy the .env.example file to .env in the ./docker directory if the file does not already exist.

  1. Run in development mode: Once your environment is set up, you can start the app. Use the following command:

hexabot dev --services ollama
docker exec -it ollama ollama pull tinyllama

Note: The first time you run the app, Docker will take some time to download all the required images

Usage

Username
admin@admin.admin
Password
adminadmin

Notice that we added an extra service called . Ollama makes it easy to get up and running with large language models locally. Make sure to SSH into the container and pull the model(s) you would like to use:

You can pull different models, a complete reference of all the Ollama models can be found here: .

UI Admin Panel is accessible via , the default credentials are

You can find more about the Hexabot CLI command .

Ollama
https://ollama.com/library
http://localhost:8080
here
Setting Up Docker for Development and Production
Setup Node.js with NVM
https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers
installation