config

package

v0.0.0-...-13997a8 Latest Latest Go to latest Published: Sep 2, 2016 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package config parses the configuration from the environment and stores it in the Env variable.

View Source

const APIURL = "/v1"

APIURL is the prefix for the Data Track API.

View Source

const ChronologicalURL = "/chronological"

ChronologicalURL is the API pattern for requesting that replies are sorted chronologically.

View Source

const CountURL = "/count"

CountURL is the API suffix for only returning the count of an API query.

View Source

const ExplicitURL = "/explicit"

ExplicitURL is the API pattern for requesting only explicitly disclosed data.

View Source

const ImplicitURL = "/implicit"

ImplicitURL is the API pattern for requesting only implicitly disclosed data.

View Source

const RangeURL = "/range/:first/:last"

RangeURL is the API suffix pattern for requesting a range of replies.

View Source

const ReverseURL = "/reverse"

ReverseURL is the API pattern for requesting that replies have their output reversed.

View Source

const StaticPath = "static/"

StaticPath is the relative path to the static HTML folder.

View Source

var Env = EnvT{
	Debug:          false,
	DatabasePath:   "datatrack.db",
	InsecureClient: true,
}

Env is the parsed environment set when the Data Track was started.

func Configure() error

Configure reads the configuration from the environment into the Env variable.

type EnvT struct {
	Debug          bool
	DatabasePath   string
	InsecureClient bool
}

EnvT is the type representing the configuration environment.