server

package

v1.3.1 Latest Latest Go to latest Published: Dec 29, 2023 License: BSD-3-Clause Imports: 17 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

Repository

github.com/sfomuseum/go-sfomuseum-pmtiles

Links

Open Source Insights

Documentation ¶

Overview ¶

Package server implements a web application for serving Protomaps tiles.

Index ¶

func DefaultFlagSet() *flag.FlagSet
func Run(ctx context.Context, logger *log.Logger) error
func RunWithFlagSet(ctx context.Context, fs *flag.FlagSet, logger *log.Logger) error
func RunWithOptions(ctx context.Context, opts *RunOptions) error
type RunOptions
- func RunOptionsWithFlagSet(fs *flag.FlagSet, logger *log.Logger) (*RunOptions, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DefaultFlagSet ¶

func DefaultFlagSet() *flag.FlagSet

DefaultFlagSet returns a `flag.FlagSet` instance configured with the default flags necessary for the server application.

func Run ¶

func Run(ctx context.Context, logger *log.Logger) error

RunWithFlagSet runs the server application using a default flagset.

func RunWithFlagSet ¶

func RunWithFlagSet(ctx context.Context, fs *flag.FlagSet, logger *log.Logger) error

RunWithFlagSet runs the server application using flags derived from 'fs'.

func RunWithOptions ¶ added in v1.2.0

func RunWithOptions(ctx context.Context, opts *RunOptions) error

Types ¶

type RunOptions ¶ added in v1.2.0

type RunOptions struct {
	ServerURI string
	Logger    *log.Logger

	EnableCORS           bool
	CORSOrigins          []string
	CORSAllowCredentials bool
	CORSDebug            bool

	EnableExample    bool
	ExampleDatabase  string
	ExampleLatitude  float64
	ExampleLongitude float64
	ExampleZoom      int

	PMTilesURI         string
	PMTilesFS          fs.FS
	PMTilesPrefix      string
	PMTilesCacheSize   int
	PMTilesHostname    string
	PMTilesStripPrefix string
}

func RunOptionsWithFlagSet ¶ added in v1.2.0

func RunOptionsWithFlagSet(fs *flag.FlagSet, logger *log.Logger) (*RunOptions, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL