The Things Network Stack
The Things Network is a global open crowdsourced Internet of Things data network.
Getting Started With The Things Network
When you get started with The Things Network, you'll probably have some questions. Here are some things you can do to find the answer to them:
- Check out our website
- Read the official documentation
- Register on the forum and search around
- Join Slack and ask us what you want to know
- Read background information on the wiki
Installing and Running The Things Network Stack
Although we're all about building an open, public network, we understand that some people rather have everything privately on their own servers. On our website, you'll find some articles describing how you can set up a private routing environment and how you can deploy this environment using Docker.
Development
First, you'll have to prepare your development environment. Follow the steps below to set up your development machine.
- Make sure you have Go installed (version 1.8 or later).
- Set up your Go environment
- Install the protobuf compiler (
protoc
) - Install
make
. On Linux installbuild-essential
. On macOS,make
comes with XCode or the developer tools. On Windows you can getmake
from https://gnuarmeclipse.github.io/windows-build-tools/ - Make sure you have Redis and RabbitMQ installed and running.
On a fresh installation you might need to install the MQTT plugin for RabbitMQ.
If you're on Linux, you probably know how to do that. On a Mac, just runbrew bundle
. The Windows installer will setup and start RabbitMQ as a service. Use theRabbitMQ Command Prompt (sbin dir)
to run commands, i.e. to enable plugins. - Declare a RabbitMQ exchange
ttn.handler
of typetopic
. Using the management plugin, declare the exchange in the web interfacehttp://server-name:15672
or using the management cli, runrabbitmqadmin declare exchange name=ttn.handler type=topic auto_delete=false durable=true
. If your handler's user has sufficient permissions on RabbitMQ, it will attempt to create the exchange if not present.
Next, you can clone this repository and set up the TTN part:
- Fork this repository
- Clone your fork:
git clone --branch develop https://github.com/YOURUSERNAME/ttn.git $GOPATH/src/github.com/TheThingsNetwork/ttn
cd $GOPATH/src/github.com/TheThingsNetwork/ttn
- Install the dependencies for development:
make dev-deps
- Run the tests:
make test
- Run
make build
to build bothttn
andttnctl
from source. - Run
make dev
to install the go binaries into$GOPATH/bin/
- Optionally on Linux or Mac you can use
make link
to link them to$GOPATH/bin/
(In order to run the commands, you should haveexport PATH="$GOPATH/bin:$PATH"
in your profile).
- Optionally on Linux or Mac you can use
- Configure your
ttnctl
with the settings in.env/ttnctl.yml.dev-example
by copying that file to~/.ttnctl.yml
. - Trust the CA certificate of your local discovery server by copying
.env/discovery/server.cert
to~/.ttnctl/ca.cert
.
You can check your ttnctl
configuration by running ttnctl config
. It should look like this:
INFO Using config:
config file: /home/your-user/.ttnctl.yml
data dir: /home/your-user/.ttnctl
auth-server: https://account.thethingsnetwork.org
discovery-address: localhost:1900
router-id: dev
handler-id: dev
mqtt-address: localhost:1883
NOTE: From now on you should run all commands from the $GOPATH/src/github.com/TheThingsNetwork/ttn
directory.
License
Source code for The Things Network is released under the MIT License, which can be found in the LICENSE file. A list of authors can be found in the AUTHORS file.