Skip to content

versatiles-org/node-versatiles-server

Repository files navigation

Code Coverage GitHub Workflow Status)

VersaTiles - Server

A Node.js server for VersaTiles containers.

Install globally

npm i -g @versatiles/server

Run

versatiles-server --help

This will show you how to use the server with all options and arguments.

For example:

versatiles-server planet.versatiles

Options

$ versatiles-server
Usage: versatiles-server [options] <source>

Simple VersaTiles server

Arguments:
  source                   VersaTiles container, can be a URL or filename of a
                           "*.versatiles" file

Options:
  -b, --base-url <url>     Base URL for the server (default:
                           "http://localhost:<port>/")
  -c, --compress           Reduces traffic by recompressing data, but responses
                           take longer. Perfect if behind CDN.
  -h, --host <hostnameip>  Hostname or IP to bind the server to (default:
                           "0.0.0.0")
  -o, --open               Open map in web browser
  -p, --port <port>        Port to bind the server to (default: 8080)
  -q, --quiet              be quiet
  -s, --static <folder>    Path to a folder with static files
  -t, --tms                Use TMS tile order (flip y axis)
  -v, --verbose            be verbose
  --help                   display help for command

License

Unlicense