README
¶
go-http-protomaps
Go HTTP middleware for the Protomaps Leaflet package.
Documentation
Documentation remains to be written. In the meantime have a look at the cmd/example/main.go application.
Tools
$> make cli
go build -mod vendor -o bin/example cmd/example/main.go
example
A simple example web application that uses the go-http-protomaps middleware and displays a map.
$> ./bin/example -h
Usage of ./bin/example:
-protomaps-tile-url string
A custom file://, http:// or https:// URI pointing to a valid Protomaps tiles bundle. (default "/sfo.pmtiles")
-server-uri string
A valid aaronland/go-http-server URI (default "http://localhost:8080")
The example application contains an embedded Protomaps tiles database file so the easiest way to test things is like this:
$> ./bin/example
2021/04/28 07:45:57 Listening for requests on http://localhost:8080
And then when you open the URL http://localhost:8080 in your web browser you should see something like this:
The example application also supports loading .pmtiles databases from remote locations. For example:
$> ./bin/example -protomaps-tile-url https://static.sfomuseum.org/pmtiles/sfo.pmtiles
2021/04/28 07:48:11 Listening for requests on http://localhost:8080
If you want to load a local file you'd do this:
$> ./bin/example -protomaps-tile-url file:///usr/local/data/sfo.pmtiles
2021/04/28 07:48:53 Listening for requests on http://localhost:8080
In the case of file:// URLs the example application will create an http.Dir handler for the root folder of the URL (/usr/local/data/) and then route the filename (/sfo.pmtiles) to that handler.
See also
Documentation
¶
Index ¶
- Variables
- func AppendAssetHandlers(mux *http.ServeMux) error
- func AppendAssetHandlersWithPrefix(mux *http.ServeMux, prefix string) error
- func AppendResourcesHandler(next http.Handler, opts *ProtomapsOptions) http.Handler
- func AppendResourcesHandlerWithPrefix(next http.Handler, opts *ProtomapsOptions, prefix string) http.Handler
- func AssetsHandler() (http.Handler, error)
- func AssetsHandlerWithPrefix(prefix string) (http.Handler, error)
- func FileHandlerFromPath(path string, prefix string) (string, http.Handler, error)
- type ProtomapsOptions
Constants ¶
This section is empty.
Variables ¶
var INCLUDE_LEAFLET = true
Functions ¶
func AppendAssetHandlers ¶
func AppendResourcesHandler ¶
func AppendResourcesHandler(next http.Handler, opts *ProtomapsOptions) http.Handler
func AssetsHandler ¶
func FileHandlerFromPath ¶ added in v0.0.3
FileHandlerFromPath will take a path and create a http.FileServer handler instance for the files in its root directory. The handler is returned with a relative URI for the filename in 'path' to be assigned to a net/http ServeMux instance.
Types ¶
type ProtomapsOptions ¶
func DefaultProtomapsOptions ¶
func DefaultProtomapsOptions() *ProtomapsOptions
Source Files
Directories