Install Hexabot

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.

$ git clone https://github.com/hexastack/hexabot.git

Environment Setup:
To configure the environment variables, use the Makefile at the root folder for initialization:

$ make init

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

Running the Application: Once your environment is set up, you can start the app. Use either of the following commands:

$ make start

or for development mode:

$ make dev

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

UI Admin Panel is accessible via http://localhost:8080, the default credentials are :

Live Chat Widget is accessible via http://localhost:5173

make init : Copies the .env.example file to .env in the ./docker directory if .env does not exist. This is usually used for initial setup.
make dev : Starts all configured Docker services in development mode. It first checks the .env file for completeness against .env.example.
make start : Similar to dev, but explicitly builds the Docker images before starting the services. This target also checks the .env file for required variables.
make stop : Stops all running Docker services defined in the compose files.
make destroy : Stops all services and removes all volumes associated with the Docker compose setup, ensuring a clean state.
make check-env : Checks if the ./docker/.env file exists and contains all the necessary environment variables as defined in ./docker/.env.example. If the file does not exist, it is created from the example. It also lists missing variables if any.

Example on how to start the stack by adding the Nginx service :

make start NGINX=1