Skip to content

Latest commit

 

History

History
 
 

server

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
bindata
bindata
 
 
testcert
testcert
 
 
README.md
README.md
 
 
handle_capabilities.go
handle_capabilities.go
 
 
handle_capabilities_test.go
handle_capabilities_test.go
 
 
handle_map_capabilities.go
handle_map_capabilities.go
 
 
handle_map_capabilities_test.go
handle_map_capabilities_test.go
 
 
handle_map_layer_zxy.go
handle_map_layer_zxy.go
 
 
handle_map_layer_zxy_test.go
handle_map_layer_zxy_test.go
 
 
handle_map_style.go
handle_map_style.go
 
 
handle_map_style_internal_test.go
handle_map_style_internal_test.go
 
 
handle_map_style_test.go
handle_map_style_test.go
 
 
middleware_gzip.go
middleware_gzip.go
 
 
middleware_gzip_internal_test.go
middleware_gzip_internal_test.go
 
 
middleware_gzip_test.go
middleware_gzip_test.go
 
 
middleware_headers.go
middleware_headers.go
 
 
middleware_headers_test.go
middleware_headers_test.go
 
 
middleware_tile_cache.go
middleware_tile_cache.go
 
 
middleware_tile_cache_internal_test.go
middleware_tile_cache_internal_test.go
 
 
middleware_tile_cache_test.go
middleware_tile_cache_test.go
 
 
server.go
server.go
 
 
server_cors_test.go
server_cors_test.go
 
 
server_internal_test.go
server_internal_test.go
 
 
server_test.go
server_test.go
 
 
viewer.go
viewer.go
 
 
viewer_disabled.go
viewer_disabled.go
 
 
viewer_gen.go
viewer_gen.go
 
 
viewer_gen_debug.go
viewer_gen_debug.go
 
 

README.md

Server

The server package is responsible for handling webserver requests for map tiles and various JSON endpoints describing the configured server. Example config:

[webserver]
port = ":9090"              # set something different than default ":8080"
ssl_cert = "fullchain.pem"  # ssl cert for serving by https
ssl_key = "privkey.pem"     # ssl key for serving by https


[webserver.headers]
Access-Control-Allow-Origin = "*"

Config properties

  • port (string): [Optional] Port and bind string. For example ":9090" or "127.0.0.1:9090". Defaults to ":8080"
  • hostname (string): [Optional] The hostname to use in the various JSON endpoints. This is useful if tegola is behind a proxy and can't read the API consumer's request host directly.
  • uri_prefix (string): [Optional] A prefix to add to all API routes. This is useful when tegola is behind a proxy (i.e. example.com/tegola). The prexfix will be added to all URLs included in the capabilities endpoint responses.
  • ssl_cert (string): [Optional, unless ssl_key provided] Path to a certificate file for serving through HTTPS
  • ssl_key (string): [Optional, unless ssl_cert provided] Path to a private key file for serving through HTTPS

Local development of the embedded viewer

Tegola's built in viewer code is stored in the ui/ directory. In order to embed the static files into the tegola binary the package go-bindata is used. To insatll go-bindata run the following command from the repository root:

go install -mod=vendor github.com/jteeuwen/go-bindata/go-bindata

Once go-bindata is installed the following command can be run from the repository root to generate a .go file for inclusion in the tegola binary:

go generate ./server

go-bindata also supports a debug mode which is descried as "Do not embed the assets, but provide the embedding API. Contents will still be loaded from disk." This mode is ideal for development and can be configured using the following command:

go generate -tags bindataDebug ./server

Important: Once updates to the viewer are complete, go generate ./server should be run and the bindata output should be committed to the repository.

Disabling the viewer

The viewer can be excluded during building by using the build flag noViewer. For example, building tegola from the cmd/tegola directory:

go build -tags "noViewer"