Installation
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.
Installation
Install Hexabot CLI globally to have easy access to its commands:
npm install -g hexabot-cli
Create a new project:
hexabot create my-chatbot
Navigate to your project folder
cd my-chatbot/
Install dependencies:
npm i
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.
Run in development mode: Once your environment is set up, you can start the app. Use the following command:
hexabot dev --services ollama
Notice that we added an extra service called Ollama. 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:
docker exec -it ollama ollama pull tinyllama
You can pull different models, a complete reference of all the Ollama models can be found here: https://ollama.com/library.
Usage
UI Admin Panel is accessible via http://localhost:8080, the default credentials are
adminadmin
Last updated
Was this helpful?