config

Documentation

Overview

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

Index

• Constants
• Variables
• func Configure() error
• type EnvT

Constants

const APIURL = "/v1"

APIURL is the prefix for the Data Track API.

const ChronologicalURL = "/chronological"

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

const CountURL = "/count"

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

const ExplicitURL = "/explicit"

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

const ImplicitURL = "/implicit"

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

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

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

const ReverseURL = "/reverse"

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

const StaticPath = "static/"

StaticPath is the relative path to the static HTML folder.

Variables

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

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

Functions

func Configure

func Configure() error

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

Types

type EnvT

type EnvT struct {
	Debug          bool
	DatabasePath   string
	InsecureClient bool
}

EnvT is the type representing the configuration environment.