docs: update usage of --file
Signed-off-by: Andrew Calcutt <acalcutt@techidiots.net>
This commit is contained in:
parent
883a449a9e
commit
9a9ddb788f
2 changed files with 20 additions and 16 deletions
|
@ -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]
|
||||
```
|
||||
|
||||
|
|
|
@ -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 <file> MBTiles file (uses demo configuration);
|
||||
--file <file> MBTiles or PMTiles file
|
||||
ignored if the configuration file is also specified
|
||||
-c, --config <file> Configuration file [config.json]
|
||||
--mbtiles <file> (DEPRECIATED) MBTiles file
|
||||
ignored if file is also specified
|
||||
ignored if the configuration file is also specified
|
||||
-c, --config <file> Configuration file [config.json] (default: "config.json")
|
||||
-b, --bind <address> Bind address
|
||||
-p, --port <port> Port [8080]
|
||||
-p, --port <port> Port [8080] (default: 8080)
|
||||
-C|--no-cors Disable Cross-origin resource sharing headers
|
||||
-u|--public_url <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
|
||||
-l|--log_file <file> output log file (defaults to standard out)
|
||||
-f|--log_format <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
|
||||
======
|
||||
|
|
Loading…
Reference in a new issue