diff --git a/README.md b/README.md index a410355..3b22972 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Once installed, you can use it like the following examples. using a mbtiles file ```bash wget https://github.com/maptiler/tileserver-gl/releases/download/v1.3.0/zurich_switzerland.mbtiles -tileserver-gl --mbtiles zurich_switzerland.mbtiles +tileserver-gl --file zurich_switzerland.mbtiles [in your browser, visit http://[server ip]:8080] ``` @@ -44,7 +44,7 @@ An alternative to npm to start the packed software easier is to install [Docker] Example using a mbtiles file ```bash wget https://github.com/maptiler/tileserver-gl/releases/download/v1.3.0/zurich_switzerland.mbtiles -docker run --rm -it -v $(pwd):/data -p 8080:8080 maptiler/tileserver-gl --mbtiles zurich_switzerland.mbtiles +docker run --rm -it -v $(pwd):/data -p 8080:8080 maptiler/tileserver-gl --file zurich_switzerland.mbtiles [in your browser, visit http://[server ip]:8080] ``` diff --git a/docs/usage.rst b/docs/usage.rst index c81a110..474ec26 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -6,28 +6,32 @@ Getting started ====== :: - Usage: main.js tileserver-gl [mbtiles] [options] + Usage: main.js tileserver-gl [file] [options] Options: - - -h, --help output usage information - --mbtiles MBTiles file (uses demo configuration); - ignored if the configuration file is also specified - -c, --config Configuration file [config.json] - -b, --bind
Bind address - -p, --port Port [8080] - -C|--no-cors Disable Cross-origin resource sharing headers - -u|--public_url Enable exposing the server on subpaths, not necessarily the root of the domain - -V, --verbose More verbose output - -s, --silent Less verbose output - -v, --version Version info + --file MBTiles or PMTiles file + ignored if the configuration file is also specified + --mbtiles (DEPRECIATED) MBTiles file + ignored if file is also specified + ignored if the configuration file is also specified + -c, --config Configuration file [config.json] (default: "config.json") + -b, --bind
Bind address + -p, --port Port [8080] (default: 8080) + -C|--no-cors Disable Cross-origin resource sharing headers + -u|--public_url Enable exposing the server on subpaths, not necessarily the root of the domain + -V, --verbose More verbose output + -s, --silent Less verbose output + -l|--log_file output log file (defaults to standard out) + -f|--log_format define the log format: https://github.com/expressjs/morgan#morganformat-options + -v, --version output the version number + -h, --help display help for command Default preview style and configuration ====== - If no configuration file is specified, a default preview style (compatible with openmaptiles) is used. -- If no mbtiles file is specified (and is not found in the current working directory), a sample file is downloaded (showing the Zurich area) +- If no data file is specified (and is not found in the current working directory), a sample file is downloaded (showing the Zurich area) Reloading the configuration ======