Developers 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
Clone the Repository:
Installation:
Install node dependencies:
Environment Setup:
To configure the environment variables, use the Makefile at the root folder for initialization:
This will copy the .env.example file to .env in the ./docker directory if the file does not already exist.
Running the Application in development mode: Once your environment is set up, you can start the app. Use either of the following commands:
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, the default credentials are :
Username: admin@admin.admin
Password: adminadmin
Live Chat Widget is accessible via http://localhost:5173
Useful Commands
npx hexabot init: Copies the .env.example file to .env in the ./docker directory if .env does not exist. This is usually used for initial setup.npx hexabot dev: Builds the Docker images locally before starting the services in development mode. It first checks the .env file for completeness against .env.example.npx hexabot start: Starts the app by pulling the Docker images from Docker Hub. This target also checks the .env file for required variables.npx hexabot stop: Stops all running Docker services defined in the compose files.npx hexabot destroy: Stops all services and removes all volumes associated with the Docker compose setup, ensuring a clean state.
Example on how to start the stack by adding the Nginx service :
Last updated