Skip to content

Outdated documentation

You are reading outdated documentation. This page documents ChirpStack v3. ChirpStack v4 is the latest version.

Source

Source-code can be found at https://github.com/brocaar/chirpstack-application-server.

Building

With Docker

The easiest way to get started is by using the provided Docker Compose environment. To start a bash shell within the docker-compose environment, execute the following command from the root of this project:

docker-compose run --rm chirpstack-application-server bash

Without Docker

It is possible to build ChirpStack Application Server without Docker. However this requires to install a couple of dependencies (depending your platform, there might be pre-compiled packages available):

Go

Make sure you have Go installed (1.11+). As ChirpStack Application Server uses Go modules, the repository must be cloned outside the $GOPATH.

Node.js

Make sure you have a recent version of Node.js installed, as Node.js is used to compile the front-end code.

Go protocol buffer support

Install the C++ implementation of protocol buffers and Go support by following the GO support for Protocol Buffers installation instructions.

Example commands

A few example commands that you can run:

# install all requirements
make dev-requirements ui-requirements

# cleanup workspace
make clean

# run the tests
make test

# compile (this will also compile the ui and generate the static files)
make build

# compile snapshot builds for supported architectures (this will also compile the ui and generate the static files)
make snapshot