Server :: tilegroxy Docs

Configuration

Parameter Description Type Required Default

Parameter	Description	Type	Required	Default
`BindHost`	IP address to bind HTTP server to	string	No	127.0.0.1
`Port`	Port to bind HTTP server to	int	No	8080
`RootPath`	The root HTTP Path to serve all requests under.	string	No	/
`TilePath`	The HTTP Path to serve tiles under in addition to RootPath. The defaults will result in a path that looks like /tiles/{layer}/{z}/{x}/{y}	string	No	tiles
`DocsPath`	The HTTP Path to serve the documentation website under in addition to RootPath. Supply an empty string to disable serving documentation. Ignored when Production is set	string	No	docs
`Headers`	Include these headers in all response from server. For cross-origin headers prefer CORS, which can vary the response by request origin. For `Cache-Control` prefer Cache Control, which derives the value from the layer	map[string]string	No	None
`Production`	Hardens operation for usage in production. For instance, controls serving splash page, documentation, the layer preview page, x-powered-by header.	bool	No	true
`Timeout`	How long (in seconds) a request can be in flight before we cancel it and return an error	uint	No	60
`Gzip`	Whether to gzip compress HTTP responses	bool	No	false
`ShutdownTimeout`	How long (in seconds) the whole shutdown sequence gets. See Shutdown	uint	No	Timeout plus DrainDelay
`DrainDelay`	How long (in seconds) to report unready before draining requests. See Shutdown	uint	No	5
`Encrypt`	Configuration for enabling TLS (HTTPS). Don’t specify to operate without encryption (the default)	Encryption	No	None
`TileJSON`	Configuration to turn on endpoints that describe layers using the TileJSON format	TileJSON	No	None
`CORS`	Configuration for returning cross-origin resource sharing headers so browsers on other origins can use the tiles	CORS	No	None
`CacheControl`	Configuration for returning a `Cache-Control` header so browsers and CDNs can reuse a tile without asking again	Cache Control	No	None

BindHost

IP address to bind HTTP server to

string

127.0.0.1

Port

Port to bind HTTP server to

int

8080

RootPath

The root HTTP Path to serve all requests under.

string

TilePath

The HTTP Path to serve tiles under in addition to RootPath. The defaults will result in a path that looks like /tiles/{layer}/{z}/{x}/{y}

string

tiles

DocsPath

The HTTP Path to serve the documentation website under in addition to RootPath. Supply an empty string to disable serving documentation. Ignored when Production is set

string

docs

Headers

Include these headers in all response from server. For cross-origin headers prefer CORS, which can vary the response by request origin. For Cache-Control prefer Cache Control, which derives the value from the layer

map[string]string

None

Production

Hardens operation for usage in production. For instance, controls serving splash page, documentation, the layer preview page, x-powered-by header.

bool

true

Timeout

How long (in seconds) a request can be in flight before we cancel it and return an error

uint

Gzip

Whether to gzip compress HTTP responses

bool

false

ShutdownTimeout

How long (in seconds) the whole shutdown sequence gets. See Shutdown

uint

Timeout plus DrainDelay

DrainDelay

How long (in seconds) to report unready before draining requests. See Shutdown

uint

Encrypt

Configuration for enabling TLS (HTTPS). Don’t specify to operate without encryption (the default)

Encryption

None

TileJSON

Configuration to turn on endpoints that describe layers using the TileJSON format

TileJSON

None

CORS

Configuration for returning cross-origin resource sharing headers so browsers on other origins can use the tiles

CORS

None

CacheControl

Configuration for returning a Cache-Control header so browsers and CDNs can reuse a tile without asking again

Cache Control

None

Environment variables
Configuration Parameter	Environment Variable
`BindHost`	`SERVER_BINDHOST`
`Port`	`SERVER_PORT`
`RootPath`	`SERVER_ROOTPATH`
`TilePath`	`SERVER_TILEPATH`
`DocsPath`	`SERVER_DOCSPATH`
`Production`	`SERVER_PRODUCTION`
`Timeout`	`SERVER_TIMEOUT`
`Gzip`	`SERVER_GZIP`
`ShutdownTimeout`	`SERVER_SHUTDOWNTIMEOUT`
`DrainDelay`	`SERVER_DRAINDELAY`