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. Developer Guide

Contributors 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
  1. Installation:

Install Hexabot CLI and node dependencies:

$ npm i -g hexabot-cli
$ cd hexabot/
$ npm i
  1. Environment Setup:

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.

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

$ hexabot dev

Note:

  • The first time you run the app, Docker will take some time to build all the required Docker images and cache the layers.

  • The "--services" allows you to add additional services comma separated. For each service, there needs to be a Docker compose file under the "docker/" directory. For instance, if you do "--services nginx" you will need to have a docker compose file for that service "docker/docker-compose.nginx.yml"

Usage

  • Password: adminadmin

PreviousHow can I add the Chatbot Widget to my Website?NextCLI Command Reference

Last updated 3 months ago

Was this helpful?

UI Admin Panel is accessible via , the default credentials are :

Username:

Live Chat Widget is accessible via

http://localhost:8080
admin@admin.admin
http://localhost:5173