nuntius

module
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Apr 25, 2022 License: GPL-3.0

README

nuntius

nuntius is the feeder accumulating data from several sources and sending it to the data server

Running in production (Docker)

To run nuntius in production, we strongly recommend simply using our stable Docker images released to GHCR.

To make the setup more straightforward, an example docker-compose.yml is provided.

Running in development (local)

To run a local development copy, simply clone the commit/branch you want to run and create a .env file in the same directory you run the go run or binary command.

See the example .env for a quick overview.

Configuration variables

Environment variable Type Default Description
SBF_ENVIRONMENT prod or dev prod Whether the worker starts in development or production mode
SBF_API_ADDRESS URL http://localhost:8082 The URL of the data API to feed the data into
SBF_API_KEY string <none> The API key to use for the data API (unlimited quota & rate limit is required)
SBF_FEED_METARS bool false Whether or not to feed METARs

Directories

Path Synopsis
cmd
internal
set

Jump to

Keyboard shortcuts

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