installation.md

Installation

Client & server

Binaries

Please have a look at the Releases page for the most up-to-date client and server binaries.

From source

If you'd like to compile Bolt from source, please follow the steps below:

Prerequisites

• Git
• Go (v1.15.6)

Cloning & installing

git clone git@github.com:boltchat/bolt.git
cd bolt
go get github.com/magefile/mage
go install github.com/magefile/mage

Building

Run mage to see all available targets.

Server

Docker (preferred)

If you'd like to run the server in a Docker container, you should use the most up-to-date image from Docker Hub. The following command should get you up and running within seconds:

docker run -p 3300:3300 --tty boltchat/server:latest

Docker Compose

Sample configuration can be found here.

Daemon

You can also run the server as a daemon. Service files can be found below:

• systemd service
• runit service