beacon.api

command module
v0.0.0-...-a16d91a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 21, 2018 License: GPL-3.0 Imports: 24 Imported by: 0

README

beacon.api

travis-img codecov-img version-img docker-img docs-img reportcard

The golang api server for the beacon blink(1) platform.

Setup

To get started locally, you will need to have a running redis server. The connection used by the application at runtime can be configured using the REDIS_URI environment variable or the -redisuri command line argument (env var will take precedence).

Server & Device Keys

Communication between the server and prospective devices leverage rsa public & private keys to authenticate with one another. The server loads this key at runtime and will provide the devices with a public version of it on "welcome".

To generate the server key:

mkdir .keys
openssl genrsa -des3 -out .keys/private.pem 2048
openssl rsa -in .keys/private.pem -outform PEM -pubout -out .keys/public.pem

Contributing

All contributions welcome.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
beacon
bg
net

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL