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-network-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-network-server bash

Without Docker

It is possible to build ChirpStack Network 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 Network Server uses Go modules, the repository must be cloned outside $GOPATH.

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 development requirements
make dev-requirements

# run the tests
make test

# compile
make build

# compile snapshot builds for supported architectures
make snapshot