Compare commits

...

56 Commits

Author SHA1 Message Date
Petr Sloup
098f057e55 Update package version to 1.1.3 2016-09-30 09:51:20 +02:00
Petr Sloup
18ba6f5059 Ignore tiling scheme of the source for internal meta urls (#54) 2016-09-30 09:50:05 +02:00
Petr Sloup
820dbdd3dd Update package version to 1.1.2 2016-09-27 17:34:39 +02:00
Petr Sloup
acd7683f18 Update dependencies 2016-09-27 17:30:24 +02:00
Petr Sloup
09859c10c1 Serve any vector/raster mbtiles, use styles only for osm2vt (close #51, #52) 2016-09-27 17:26:05 +02:00
Petr Sloup
f201deecdc Merge pull request #48 from rastapasta/patch-1
adding info for OSX setup
2016-09-22 08:55:41 +02:00
Petr Pridal
b49521d2ed Update README.md 2016-09-01 17:53:15 +02:00
Michael Straßburger
30c9bc8979 adding info for OSX setup 2016-08-29 12:31:33 +02:00
Petr Sloup
69340bbc83 Update package version to 1.1.1 2016-08-25 12:52:51 +02:00
Petr Sloup
ff9d5a8e5d Update READMEs and descriptions 2016-08-25 12:52:32 +02:00
Petr Sloup
23c2aa54d0 Update tests 2016-08-25 11:09:01 +02:00
Petr Sloup
a8fd1b38b7 Return 404 for negative zoom levels on static endpoint 2016-08-25 11:08:19 +02:00
Petr Sloup
7c28bf2b21 Update version to 1.1.0 2016-08-25 10:49:27 +02:00
Petr Sloup
f9f26f0d65 Indicate clearly when running light version on index.html 2016-08-25 10:44:29 +02:00
Petr Sloup
de60a0a076 Disable png quantization by default for now 2016-08-25 10:23:42 +02:00
Petr Sloup
90b9af3d95 Allow max image side length to be configurable 2016-08-25 09:41:33 +02:00
Petr Sloup
78aea26318 Allow @4x requests 2016-08-25 09:38:03 +02:00
Petr Sloup
292b1b6b44 Update dependencies 2016-08-25 09:28:17 +02:00
Petr Sloup
de7f5f0366 Allow and use floating-point zoom levels in the static endpoints 2016-08-25 09:22:12 +02:00
Petr Sloup
161de17803 Update package version to 1.0.0 2016-08-24 17:05:23 +02:00
Petr Pridal
f9e5afbf49 Update index.tmpl 2016-08-24 16:29:49 +02:00
Petr Sloup
513e2dac8f Fix incorrect variable name 2016-08-24 16:28:41 +02:00
Petr Sloup
e428ab60f1 Update README.md 2016-08-24 14:22:19 +02:00
Petr Sloup
9d1a2bf995 Add note about tileserver-gl-light to docs 2016-08-24 14:20:42 +02:00
Petr Sloup
bbda49589c Add PUBLISHING.md 2016-08-24 14:20:16 +02:00
Petr Sloup
a571d5f39b Improve and rename publishing script for creating light version 2016-08-24 14:19:16 +02:00
Petr Sloup
68d997a655 Update to tileserver-gl-styles v0.3.0 2016-08-24 14:05:01 +02:00
Petr Sloup
7d2f8ab062 Add note about tileserver-gl-light to the docs 2016-08-24 13:50:47 +02:00
Petr Sloup
4c2157842c Minor fix for autodetected bounds in tilejson 2016-08-24 13:19:36 +02:00
Petr Sloup
25c87ccf23 Initial documentation (close #39) 2016-08-23 00:32:09 +02:00
Petr Sloup
97457a23f2 Update "sharp" dependency version to 0.16.0 2016-08-21 10:14:49 +02:00
Petr Sloup
e9cad399c9 New "mbtiles://{name}" reference syntax (#27) 2016-08-21 10:08:17 +02:00
Petr Sloup
ee1cb21dfd Use pngquant (close #43); rename option formatEncoding->formatQuality 2016-08-21 09:41:28 +02:00
Petr Sloup
f524f1465e Fix race condition 2016-08-20 14:29:10 +02:00
Petr Sloup
1004f4cce1 Add XYZ to the list of services (close #42) 2016-08-20 14:01:12 +02:00
Petr Sloup
b4d6490e00 Large refactoring of usage (only mbtiles, default styles, ...) (#27) 2016-08-20 13:31:11 +02:00
Petr Sloup
3cf8ce9903 Add mbtiles_data: "metaprotocol" 2016-08-20 10:28:45 +02:00
Petr Sloup
f21ee2691b Merge branch 'v2_tiles' 2016-08-19 08:28:19 +02:00
Petr Sloup
845e31b3f2 More sensible errors for non-existent mbtiles 2016-08-19 08:25:12 +02:00
Petr Sloup
c2a18d7329 Update mapbox-gl-js to v0.21.0 2016-08-10 11:40:34 +08:00
Petr Sloup
d120b46966 Update mapbox-gl-native to v3.3.2 2016-08-10 11:35:54 +08:00
Petr Sloup
afda5d00bc Merge pull request #36 from efi-the-forking-continues/master
new feature: command line option for bind address
2016-08-07 20:45:29 +08:00
Thomas Efer
b3cb047d3d set default binding to undefined
this will result in default behavior in app.listen within server.js
2016-08-07 11:34:46 +02:00
Petr Sloup
af47c9c23b Update package version to 0.9.1 2016-08-06 18:41:24 +08:00
Petr Sloup
2ab9d9e168 Print the package name on the index 2016-08-06 18:40:50 +08:00
Petr Sloup
8a7f44d4c2 Add script for building "tileserver-gl-light" package (#27) 2016-08-06 18:37:17 +08:00
Thomas Efer
aa9a469bb4 tell server to adhere to new option for network interface binding 2016-08-05 14:30:22 +02:00
Thomas Efer
53c1ef5786 Added option to specify network interface binding 2016-08-05 14:28:34 +02:00
Petr Pridal
8074cfb4c7 Documentation - the ReadTheDocs skeleton 2016-08-04 23:55:20 +02:00
Petr Pridal
ffc72789ae Update version to 0.9.0 2016-07-28 11:22:50 +02:00
Dalibor Janák
4fc76251c3 Responsive CSS for the web page - fixes (closes #33) 2016-07-27 17:56:54 +02:00
Dalibor Janák
b048990e14 Responsive CSS for the web page #33 2016-07-27 14:05:33 +02:00
Petr Sloup
b257855e38 Update version to 0.8.3 2016-07-27 12:33:19 +08:00
Petr Sloup
fb758be730 Update tests to use v0.8 dataset 2016-07-27 12:32:53 +08:00
Petr Sloup
7accdfa7da Very early CPU-cheap 304 based solely on last-modified 2016-07-27 12:31:47 +08:00
Petr Sloup
7efe22cf7f Minor typo fix 2016-07-26 19:02:44 +07:00
32 changed files with 1610 additions and 468 deletions

4
.gitignore vendored
View File

@@ -1,3 +1,7 @@
docs/_build
node_modules node_modules
test_data test_data
data
light
config.json config.json
*.mbtiles

View File

@@ -15,7 +15,7 @@ before_install:
- sudo apt-get install -qq xvfb - sudo apt-get install -qq xvfb
install: install:
- npm install - npm install
- wget -O test_data.zip https://github.com/klokantech/tileserver-gl-data/archive/v0.0.3.zip - wget -O test_data.zip https://github.com/klokantech/tileserver-gl-data/archive/v0.8.zip
- unzip -q test_data.zip -d tmp_test_data - unzip -q test_data.zip -d tmp_test_data
- mkdir test_data - mkdir test_data
- mv tmp_test_data/tileserver-gl-data-*/* -t test_data - mv tmp_test_data/tileserver-gl-data-*/* -t test_data

6
PUBLISHING.md Normal file
View File

@@ -0,0 +1,6 @@
# Publishing new version
- Update version in `package.json`
- `git tag vx.x.x`
- `git push --tags`
- `node publish.js` (publishes packages to npm)

View File

@@ -1,59 +1,46 @@
![tileserver-gl](https://cloud.githubusercontent.com/assets/59284/18173467/fa3aa2ca-7069-11e6-86b1-0f1266befeb6.jpeg)
# TileServer GL # TileServer GL
[![Build Status](https://travis-ci.org/klokantech/tileserver-gl.svg?branch=master)](https://travis-ci.org/klokantech/tileserver-gl) [![Build Status](https://travis-ci.org/klokantech/tileserver-gl.svg?branch=master)](https://travis-ci.org/klokantech/tileserver-gl)
[![Docker Hub](https://img.shields.io/badge/docker-hub-blue.svg)](https://hub.docker.com/r/klokantech/tileserver-gl/) [![Docker Hub](https://img.shields.io/badge/docker-hub-blue.svg)](https://hub.docker.com/r/klokantech/tileserver-gl/)
Vector and raster maps with GL styles. Server side rendering by Mapbox GL Native. Map tile server for Mapbox GL JS, Android, iOS, Leaflet, OpenLayers, GIS via WMTS, etc.
## Installation ## Get Started
### Docker Install `tileserver-gl` with server-side raster rendering of vector tiles with npm
- `docker run -it -v $(pwd):/data -p 8080:80 klokantech/tileserver-gl`
### Without docker ```bash
- Make sure you have Node v4 or higher (`nvm install 4`) npm install -g tileserver-gl
- `npm install` ```
- `node src/main.js`
## Sample data Now download vector tiles from [OSM2VectorTiles](http://osm2vectortiles.org/downloads/).
Sample data can be downloaded at https://github.com/klokantech/tileserver-gl-data/archive/master.zip
#### Usage ```bash
- unpack somewhere and `cd` to the directory curl -o zurich_switzerland.mbtiles https://osm2vectortiles-downloads.os.zhdk.cloud.switch.ch/v2.0/extracts/zurich_switzerland.mbtiles
- `docker run -it -v $(pwd):/data -p 8080:80 klokantech/tileserver-gl` ```
- (or `node path/to/repo/src/main.js`)
## Configuration Start `tileserver-gl` with the downloaded vector tiles.
Create `config.json` file in the root directory. ```bash
The config file can contain definition of several paths where the tiles will be served. tileserver-gl zurich_switzerland.mbtiles
```
### Example configuration file Alternatively, you can use the `tileserver-gl-light` package instead, which is pure javascript (does not have any native dependencies) and can run anywhere, but does not contain rasterization on the server side made with MapBox GL Native.
See https://github.com/klokantech/tileserver-gl-data/blob/master/config.json
**Note**: To specify local mbtiles as source of the vector tiles inside the style, use urls with `mbtiles` protocol with path relative to the `cwd + options.paths.root + options.paths.mbtiles`. (For example `mbtiles://switzerland.mbtiles`) ## Using Docker
## Available URLs An alternative to npm to start the packed software easier is to install [Docker](http://www.docker.com/) on your computer and then run in the directory with the downloaded MBTiles the command:
- If you visit the server on the configured port (default 8080) you should see your maps appearing in the browser. ```bash
- Style is served at `/styles/{id}.json` (+ array at `/styles.json`) docker run -it -v $(pwd):/data -p 8080:80 klokantech/tileserver-gl
- Sprites at `/styles/{id}/sprite[@2x].{format}` ```
- Fonts at `/fonts/{fontstack}/{start}-{end}.pbf`
- Rendered tiles are at `/styles/{id}/rendered/{z}/{x}/{y}[@2x].{format}` This will download and start a ready to use container on your computer and the maps are going to be available in webbrowser on localhost:8080.
- The optional `@2x` (or `@3x`) part can be used to render HiDPI (retina) tiles
- Available formats: `png`, `jpg` (`jpeg`), `webp` On laptop you can use [Docker Kitematic](https://kitematic.com/) and search "tileserver-gl" and run it, then drop in the 'data' folder the MBTiles.
- TileJSON at `/styles/{id}/rendered.json`
- Static images are rendered at: ## Documentation
- `/styles/{id}/static/{lon},{lat},{zoom}[@{bearing}[,{pitch}]]/{width}x{height}[@2x].{format}` (center-based)
- `/styles/{id}/static/{minx},{miny},{maxx},{maxy}/{width}x{height}[@2x].{format}` (area-based) You can read full documentation of this project at http://tileserver.readthedocs.io/.
- `/styles/{id}/static/auto/{width}x{height}[@2x].{format}` (autofit path -- see below)
- The static image endpoints additionally support following query parameters:
- `path` - comma-separated `lng,lat`, pipe-separated pairs
- e.g. `5.9,45.8|5.9,47.8|10.5,47.8|10.5,45.8|5.9,45.8`
- `latlng` - indicates the `path` coordinates are in `lat,lng` order rather than the usual `lng,lat`
- `fill` - color to use as the fill (e.g. `red`, `rgba(255,255,255,0.5)`, `#0000ff`)
- `stroke` - color of the path stroke
- `width` - width of the stroke
- `padding` - "percetange" padding for fitted endpoints (area-based and path autofit)
- value of `0.1` means "add 10% size to each side to make sure the area of interest is nicely visible"
- Source data at `/data/{mbtiles}/{z}/{x}/{y}.{format}`
- TileJSON at `/data/{mbtiles}.json`
- Array of all TileJSONs at `/index.json` (`/rendered.json`; `/data.json`)

17
README_light.md Normal file
View File

@@ -0,0 +1,17 @@
# TileServer GL light
[![Build Status](https://travis-ci.org/klokantech/tileserver-gl.svg?branch=master)](https://travis-ci.org/klokantech/tileserver-gl)
[![Docker Hub](https://img.shields.io/badge/docker-hub-blue.svg)](https://hub.docker.com/r/klokantech/tileserver-gl/)
Vector maps with GL styles. Map tile server for Mapbox Android, iOS, GL JS, Leaflet, OpenLayers, etc. without server side rendering.
## Quickstart
Use `npm install -g tileserver-gl-light` to install the package from npm.
Then you can simply run `tileserver-gl-light zurich_switzerland.mbtiles` to start the server for the given mbtiles.
See also `tileserver-gl` which contains server side rendering.
Prepared vector tiles can be downloaded from [OSM2VectorTiles](http://osm2vectortiles.org/).
## Documentation
You can read full documentation of this project at http://tileserver.readthedocs.io/.

177
docs/Makefile Normal file
View File

@@ -0,0 +1,177 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/TileServerGL.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/TileServerGL.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/TileServerGL"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TileServerGL"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

258
docs/conf.py Normal file
View File

@@ -0,0 +1,258 @@
# -*- coding: utf-8 -*-
#
# TileServer GL documentation build configuration file, created by
# sphinx-quickstart on Thu Aug 4 23:48:49 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'TileServer GL'
copyright = u'2016, Klokan Technologies GmbH'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1'
# The full version, including alpha/beta/rc tags.
release = '1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'TileServerGLdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'TileServerGL.tex', u'TileServer GL Documentation',
u'Klokan Technologies GmbH', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'tileservergl', u'TileServer GL Documentation',
[u'Klokan Technologies GmbH'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'TileServerGL', u'TileServer GL Documentation',
u'Klokan Technologies GmbH', 'TileServerGL', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False

121
docs/config.rst Normal file
View File

@@ -0,0 +1,121 @@
==================
Configuration file
==================
The configuration file defines the behavior of the application. It's a regular JSON file.
Example::
{
"options": {
"paths": {
"root": "",
"fonts": "glyphs",
"sprites": "sprites",
"styles": "styles",
"mbtiles": ""
},
"domains": [
"localhost:8080",
"127.0.0.1:8080"
],
"formatQuality": {
"jpeg": 80,
"webp": 90,
"pngQuantization": false,
"png": 90
},
"maxSize": 2048
},
"styles": {
"basic": {
"style": "basic.json",
"tilejson": {
"type": "overlay",
"bounds": [8.44806, 47.32023, 8.62537, 47.43468]
}
},
"hybrid": {
"style": "satellite-hybrid.json",
"serve_rendered": false,
"tilejson": {
"format": "webp"
}
}
},
"data": {
"zurich-vector": {
"mbtiles": "zurich.mbtiles"
}
}
}
``options``
===========
``paths``
---------
Defines where to look for the different types of input data.
The value of ``root`` is used as prefix for all data types.
``domains``
-----------
You can use this to optionally specify on what domains the rendered tiles are accessible. This can be used for basic load-balancing or to bypass browser's limit for the number of connections per domain.
``formatQuality``
-----------------
Quality of the compression of individual image formats. [0-100]
The value for ``png`` is only used when ``pngQuantization`` is ``true``.
``maxSize``
-----------
Maximum image side length to be allowed to be rendered (including scale factor). Default is ``2048``.
``styles``
==========
Each item in this object defines one style (map). It can have the following options:
* ``style`` -- name of the style json file [required]
* ``serve_rendered`` -- whether to render the raster tiles for this style or not
* ``serve_data`` -- whether to allow acces to the original tiles, sprites and required glyphs
* ``tilejson`` -- properties to add to the TileJSON created for the raster data
* ``format`` and ``bounds`` can be especially useful
``data``
========
Each item specifies one data source which should be made accessible by the server. It has the following options:
* ``mbtiles`` -- name of the mbtiles file [required]
The mbtiles file does not need to be specified here unless you explicitly want to serve the raw data.
Referencing local mbtiles from style
====================================
You can link various data sources from the style JSON (for example even remote TileJSONs).
To specify that you want to use local mbtiles, use to following syntax: ``mbtiles://switzerland.mbtiles``.
The TileServer-GL will try to find the file ``switzerland.mbtiles`` in ``root`` + ``mbtiles`` path.
For example::
"sources": {
"source1": {
"url": "mbtiles://switzerland.mbtiles",
"type": "vector"
}
}
Alternatively, you can use ``mbtiles://{zurich-vector}`` to reference existing data object from the config.
In this case, the server will look into the ``config.json`` to determine what mbtiles file to use.
For the config above, this is equivalent to ``mbtiles://zurich.mbtiles``.

15
docs/deployment.rst Normal file
View File

@@ -0,0 +1,15 @@
==========
Deployment
==========
Typically - you should use nginx/lighttpd/apache on the frontend - and the tileserver-gl server is hidden behind it in production deployment.
Caching
=======
There is a plenty of options you can use to create proper caching infrastructure: Varnish, CloudFlare, ...
Securing
========
Nginx can be used to add protection via https, password, referrer, IP address restriction, access keys, etc.

56
docs/endpoints.rst Normal file
View File

@@ -0,0 +1,56 @@
===================
Available endpoints
===================
If you visit the server on the configured port (default 8080) you can see your maps appearing in the browser.
Styles
======
* Styles are served at ``/styles/{id}.json`` (+ array at ``/styles.json``)
* Sprites at ``/styles/{id}/sprite[@2x].{format}``
* Fonts at ``/fonts/{fontstack}/{start}-{end}.pbf``
Rendered tiles
==============
* Rendered tiles are served at ``/styles/{id}/rendered/{z}/{x}/{y}[@2x].{format}``
* The optional ``@2x`` (or ``@3x``, ``@4x``) part can be used to render HiDPI (retina) tiles
* Available formats: ``png``, ``jpg`` (``jpeg``), ``webp``
* TileJSON at ``/styles/{id}/rendered.json``
* The rendered tiles are not available in the ``tileserver-gl-light`` version.
Static images
=============
* Several endpoints:
* ``/styles/{id}/static/{lon},{lat},{zoom}[@{bearing}[,{pitch}]]/{width}x{height}[@2x].{format}`` (center-based)
* ``/styles/{id}/static/{minx},{miny},{maxx},{maxy}/{width}x{height}[@2x].{format}`` (area-based)
* ``/styles/{id}/static/auto/{width}x{height}[@2x].{format}`` (autofit path -- see below)
* All the static image endpoints additionally support following query parameters:
* ``path`` - comma-separated ``lng,lat``, pipe-separated pairs
* e.g. ``5.9,45.8|5.9,47.8|10.5,47.8|10.5,45.8|5.9,45.8``
* ``latlng`` - indicates the ``path`` coordinates are in ``lat,lng`` order rather than the usual ``lng,lat``
* ``fill`` - color to use as the fill (e.g. ``red``, ``rgba(255,255,255,0.5)``, ``#0000ff``)
* ``stroke`` - color of the path stroke
* ``width`` - width of the stroke
* ``padding`` - "percetange" padding for fitted endpoints (area-based and path autofit)
* value of ``0.1`` means "add 10% size to each side to make sure the area of interest is nicely visible"
* The static images are not available in the ``tileserver-gl-light`` version.
Source data
===========
* Source data are served at ``/data/{mbtiles}/{z}/{x}/{y}.{format}``
* TileJSON at ``/data/{mbtiles}.json``
TileJSON arrays
===============
Array of all TileJSONs is at ``/index.json`` (``/rendered.json``; ``/data.json``)

28
docs/index.rst Normal file
View File

@@ -0,0 +1,28 @@
.. TileServer GL documentation master file, created by
sphinx-quickstart on Thu Aug 4 23:48:49 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to TileServer GL's documentation!
=========================================
Contents:
.. toctree::
:maxdepth: 2
installation
usage
config
deployment
endpoints
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

37
docs/installation.rst Normal file
View File

@@ -0,0 +1,37 @@
============
Installation
============
Docker
======
When running docker image, no special installation is needed -- the docker will automatically download the image if not present.
Just run ``docker run -it -v $(pwd):/data -p 8080:80 klokantech/tileserver-gl``.
npm
===
Just run ``npm install -g tileserver-gl``.
``tileserver-gl-light`` on npm
==============================
Alternatively, you can use ``tileserver-gl-light`` package instead, which is pure javascript (does not have any native dependencies) and can run anywhere, but does not contain rasterization features.
From source
===========
Make sure you have Node v4 or higher (nvm install 4) and run::
npm install
node .
On OSX
======
Make sure to have ``pkg-config`` and ``cairo`` installed::
brew install pkg-config cairo

28
docs/usage.rst Normal file
View File

@@ -0,0 +1,28 @@
=====
Usage
=====
Getting started
======
::
Usage: tileserver-gl [mbtiles] [options]
mbtiles MBTiles file (uses demo configuration);
ignored if the configuration file is also specified
Options:
-c, --config Configuration file [config.json]
-b, --bind Bind address
-p, --port Port [8080]
-V, --verbose More verbose output
-v, --version Version info
Default styles and configuration
======
- If no configuration file is specified, the default styles (compatible with osm2vectortiles) are used.
- If no mbtiles file is specified (and is not found in the current working directory), an extract is downloaded directly from osm2vectortiles.

View File

@@ -1,7 +1,7 @@
{ {
"name": "tileserver-gl", "name": "tileserver-gl",
"version": "0.8.2", "version": "1.1.3",
"description": "Map tile server for JSON GL styles - serverside generated raster tiles", "description": "Map tile server for JSON GL styles - vector and server side generated raster tiles",
"main": "src/main.js", "main": "src/main.js",
"bin": "src/main.js", "bin": "src/main.js",
"authors": [ "authors": [
@@ -19,20 +19,22 @@
"async": "2.0.1", "async": "2.0.1",
"advanced-pool": "0.3.2", "advanced-pool": "0.3.2",
"base64url": "2.0.0", "base64url": "2.0.0",
"canvas": "1.4.0", "canvas": "1.5.0",
"clone": "1.0.2", "clone": "1.0.2",
"color": "0.11.3", "color": "0.11.3",
"cors": "2.7.1", "cors": "2.8.1",
"express": "4.14.0", "express": "4.14.0",
"glyph-pbf-composite": "0.0.2", "glyph-pbf-composite": "0.0.2",
"handlebars": "4.0.5", "handlebars": "4.0.5",
"mapbox-gl-native": "3.2.1", "mapbox-gl-native": "3.3.3",
"mbtiles": "0.9.0", "mbtiles": "0.9.0",
"morgan": "1.7.0", "morgan": "1.7.0",
"node-pngquant-native": "1.0.4",
"nomnom": "1.8.1", "nomnom": "1.8.1",
"request": "2.74.0", "request": "2.75.0",
"sharp": "0.15.1", "sharp": "0.16.0",
"sphericalmercator": "1.0.5" "sphericalmercator": "1.0.5",
"tileserver-gl-styles": "0.3.0"
}, },
"devDependencies": { "devDependencies": {
"should": "^10.0.0", "should": "^10.0.0",

View File

@@ -36,6 +36,16 @@ a:hover{
font-size: 32px; font-size: 32px;
text-align:center; text-align:center;
margin:90px 0 0 0; margin:90px 0 0 0;
position:relative;
}
.title.light:after {
content: "light";
display: block;
position: absolute;
left: 50%;
bottom: -5px;
color: #499DCE;
font-size:.8em;
} }
section{ section{
margin: 15px auto; margin: 15px auto;
@@ -62,8 +72,7 @@ section{
} }
.item{ .item{
background:#fff; background:#fff;
height: 148px; height: 191px;
padding: 20px 30px 20px 188px;
border: 1px solid #ededed; border: 1px solid #ededed;
border-top:none; border-top:none;
} }
@@ -72,13 +81,15 @@ section{
} }
.item img{ .item img{
position: absolute; position: absolute;
margin: 10px 10px 15px -158px; margin: 30px;
width: 128px; width: 128px;
height: 128px; height: 128px;
border: 1px solid #ccc; border: 1px solid #ccc;
} }
.details { .details {
float:left; float:left;
height: 128px;
padding: 20px 30px 20px 188px;
} }
.details h3 { .details h3 {
font-size:18px; font-size:18px;
@@ -91,16 +102,18 @@ section{
.viewers { .viewers {
float:right; float:right;
text-align:center; text-align:center;
width:120px; width: 120px;
margin-top:25px; margin-top: 25px;
padding-right: 30px;
} }
.btn { .btn {
display:block; display:block;
margin:5px; margin: 0;
line-height: 36px;
} }
.btn:first-child { .btn:first-child {
position: relative; position: relative;
padding: 10px 0; padding: 0;
overflow: hidden; overflow: hidden;
border-radius:4px; border-radius:4px;
background-color: #499DCE; background-color: #499DCE;
@@ -152,4 +165,48 @@ body {
body { body {
background-image: url(/images/header-map-2560px.png); background-image: url(/images/header-map-2560px.png);
} }
}
/* Responsive */
@media (max-width: 950px) {
section{
margin: 0;
width: 96%;
padding: 2%;
}
}
@media (max-width: 600px) {
.title{
margin: 25px 0 0 0;
}
.title.light:after {
font-size:.6em;
}
.title img{
width: 200px;
}
.subtitle{
font-size: 20px;
margin: 0 0 35px 0;
}
.item{
height: 245px;
}
.viewers{
float: left;
text-align: left;
width: 100%;
margin-left: 30px;
margin-top: 15px;
}
.viewers a{
display: inline-block;
vertical-align: middle;
}
.btn{
margin: 0 20px 0 0;
}
.btn:first-child{
padding: 0 20px;
}
} }

View File

@@ -229,6 +229,13 @@
border-bottom-right-radius: 0; border-bottom-right-radius: 0;
} }
.mapboxgl-marker {
position: absolute;
top: 0;
left: 0;
will-change: transform;
}
.mapboxgl-crosshair, .mapboxgl-crosshair,
.mapboxgl-crosshair .mapboxgl-interactive, .mapboxgl-crosshair .mapboxgl-interactive,
.mapboxgl-crosshair .mapboxgl-interactive:active { .mapboxgl-crosshair .mapboxgl-interactive:active {

File diff suppressed because one or more lines are too long

View File

@@ -2,6 +2,7 @@
<html> <html>
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>{{name}} - TileServer GL</title> <title>{{name}} - TileServer GL</title>
{{#is_vector}} {{#is_vector}}
<link rel="stylesheet" type="text/css" href="/mapbox-gl.css{{&key_query}}" /> <link rel="stylesheet" type="text/css" href="/mapbox-gl.css{{&key_query}}" />

View File

@@ -2,13 +2,23 @@
<html> <html>
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<title>TileServerGL</title> <meta name="viewport" content="width=device-width, initial-scale=1">
<title>TileServer GL - Server for vector and raster maps with GL styles</title>
<link rel="stylesheet" type="text/css" href="/index.css{{&key_query}}" /> <link rel="stylesheet" type="text/css" href="/index.css{{&key_query}}" />
<script>
function toggle_xyz(id) {
var el = document.getElementById(id);
var s = el.style;
s.display = s.display == 'none' ? 'inline-block' : 'none';
el.setSelectionRange(0, el.value.length);
return false;
}
</script>
</head> </head>
<body> <body>
<section> <section>
<h1 class="title"><img src="/images/logo.png" alt="TileServerGL" /></h1> <h1 class="title {{#if is_light}}light{{/if}}"><img src="/images/logo.png" alt="TileServer GL" /></h1>
<h2 class="subtitle">Map Layers for web and mobile applications.</h2> <h2 class="subtitle">Vector {{#if is_light}}<s>and raster</s>{{else}}and raster{{/if}} maps with GL styles</h2>
<h2 class="box-header">Styles</h2> <h2 class="box-header">Styles</h2>
<div class="box"> <div class="box">
{{#each styles}} {{#each styles}}
@@ -24,9 +34,13 @@
<p class="services"> <p class="services">
{{#if serving_rendered}} {{#if serving_rendered}}
services: <a href="/styles/{{@key}}/rendered.json{{&../key_query}}">TileJSON</a> services: <a href="/styles/{{@key}}/rendered.json{{&../key_query}}">TileJSON</a>
{{#if wmts_link}} {{/if}}
| <a href="{{&wmts_link}}">WMTS</a> {{#if wmts_link}}
{{/if}} | <a href="{{&wmts_link}}">WMTS</a>
{{/if}}
{{#if xyz_link}}
| <a href="#" onclick="return toggle_xyz('xyz_style_{{@key}}');">XYZ</a>
<input id="xyz_style_{{@key}}" type="text" value="{{&xyz_link}}" style="display:none;" />
{{/if}} {{/if}}
</p> </p>
</div> </div>
@@ -63,6 +77,10 @@
{{#if wmts_link}} {{#if wmts_link}}
| <a href="{{&wmts_link}}">WMTS</a> | <a href="{{&wmts_link}}">WMTS</a>
{{/if}} {{/if}}
{{#if xyz_link}}
| <a href="#" onclick="return toggle_xyz('xyz_data_{{@key}}');">XYZ</a>
<input id="xyz_data_{{@key}}" type="text" value="{{&xyz_link}}" style="display:none;" />
{{/if}}
</p> </p>
</div> </div>
<div class="viewers"> <div class="viewers">
@@ -80,7 +98,7 @@
<footer> <footer>
<a href="https://www.klokantech.com/" target="_blank"><img src="/images/klokantech.png" /></a> <a href="https://www.klokantech.com/" target="_blank"><img src="/images/klokantech.png" /></a>
<p> <p>
<a href="https://github.com/klokantech/tileserver-gl" target="_blank">Powered by TileServer-GL v{{server_version}}</a> <a href="https://www.klokantech.com/" target="_blank">open-source project from Klokan Technologies GmbH 2016</a> <a href="https://github.com/klokantech/tileserver-gl" target="_blank">Powered by TileServer GL ({{server_version}})</a> <a href="https://www.klokantech.com/" target="_blank">open-source project from Klokan Technologies GmbH.</a>
</p> </p>
</footer> </footer>
</body> </body>

View File

@@ -2,6 +2,7 @@
<html> <html>
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>{{name}} - TileServer GL</title> <title>{{name}} - TileServer GL</title>
<link rel="stylesheet" type="text/css" href="/mapbox-gl.css{{&key_query}}" /> <link rel="stylesheet" type="text/css" href="/mapbox-gl.css{{&key_query}}" />
<script src="/mapbox-gl.js{{&key_query}}"></script> <script src="/mapbox-gl.js{{&key_query}}"></script>

45
publish.js Normal file
View File

@@ -0,0 +1,45 @@
#!/usr/bin/env node
'use strict';
/*
* This script creates `tileserver-gl-light` version
* (without native dependencies) and publishes
* `tileserver-gl` and `tileserver-gl-light` to npm.
*/
/* CREATE tileserver-gl-light */
// SYNC THE `light` FOLDER
require('child_process').execSync('rsync -av --exclude="light" --exclude=".git" --exclude="node_modules" --delete . light', {
stdio: 'inherit'
});
// PATCH `package.json`
var fs = require('fs');
var packageJson = require('./package');
packageJson.name += '-light';
packageJson.description = 'Map tile server for JSON GL styles - serving vector tiles';
delete packageJson.dependencies['canvas'];
delete packageJson.dependencies['mapbox-gl-native'];
delete packageJson.dependencies['node-pngquant-native'];
delete packageJson.dependencies['sharp'];
delete packageJson.devDependencies;
var str = JSON.stringify(packageJson, undefined, 2);
fs.writeFileSync('light/package.json', str);
fs.renameSync('light/README_light.md', 'light/README.md');
/* PUBLISH */
// tileserver-gl
require('child_process').execSync('npm publish .', {
stdio: 'inherit'
});
// tileserver-gl-light
require('child_process').execSync('npm publish light', {
stdio: 'inherit'
});

12
run.sh
View File

@@ -1,11 +1,3 @@
#!/bin/bash #!/bin/bash
if [ ! -f /data/config.json ]; then cd /data
echo "INFO: No config.json found! Downloading sample data..." xvfb-run -a -e /dev/stdout --server-args="-screen 0 1024x768x24" node /usr/src/app/ -p 80
echo "--------------------------------------------------------------------------------"
curl -L -o sample_data.zip https://github.com/klokantech/tileserver-gl-data/archive/v0.8.0.zip
unzip -q sample_data.zip -d sample_data
mv sample_data/tileserver-gl-data-*/* -t /data
rm sample_data.zip
rm -r sample_data
fi
xvfb-run -a -e /dev/stdout --server-args="-screen 0 1024x768x24" node /usr/src/app/src/main.js -p 80 -c /data/config.json

View File

@@ -2,27 +2,166 @@
'use strict'; 'use strict';
var fs = require('fs'),
path = require('path'),
request = require('request');
var mbtiles = require('mbtiles');
var packageJson = require('../package');
var opts = require('nomnom') var opts = require('nomnom')
.option('mbtiles', {
default: undefined,
help: 'MBTiles file (uses demo configuration);\n' +
'\t ignored if the configuration file is also specified',
position: 0
})
.option('config', { .option('config', {
abbr: 'c', abbr: 'c',
default: 'config.json', default: 'config.json',
help: 'Configuration file' help: 'Configuration file'
}) })
.option('bind', {
abbr: 'b',
default: undefined,
help: 'Bind address'
})
.option('port', { .option('port', {
abbr: 'p', abbr: 'p',
default: 8080, default: 8080,
help: 'Port' help: 'Port'
}) })
.option('verbose', {
abbr: 'V',
flag: true,
help: 'More verbose output'
})
.option('version', { .option('version', {
abbr: 'v', abbr: 'v',
flag: true, flag: true,
help: 'Version info', help: 'Version info',
callback: function() { callback: function() {
return 'version ' + require('../package.json').version; return packageJson.name + ' v' + packageJson.version;
} }
}).parse(); }).parse();
return require('./server')({
config: opts.config, console.log('Starting ' + packageJson.name + ' v' + packageJson.version);
port: opts.port
var startServer = function(configPath, config) {
return require('./server')({
configPath: configPath,
config: config,
bind: opts.bind,
port: opts.port
});
};
var startWithMBTiles = function(mbtilesFile) {
console.log('Automatically creating config file for ' + mbtilesFile);
mbtilesFile = path.resolve(process.cwd(), mbtilesFile);
var mbtilesStats = fs.statSync(mbtilesFile);
if (!mbtilesStats.isFile() || mbtilesStats.size === 0) {
console.log('ERROR: Not valid MBTiles file: ' + mbtilesFile);
process.exit(1);
}
var instance = new mbtiles(mbtilesFile, function(err) {
instance.getInfo(function(err, info) {
var bounds = info.bounds;
var styleDir = path.resolve(__dirname, "../node_modules/tileserver-gl-styles/");
var config = {
"options": {
"paths": {
"root": styleDir,
"fonts": "glyphs",
"sprites": "sprites",
"styles": "styles",
"mbtiles": path.dirname(mbtilesFile)
}
},
"styles": {},
"data": {}
};
if (info.format == 'pbf' &&
info.name.toLowerCase().indexOf('osm2vectortiles') > -1) {
config['data']['osm2vectortiles'] = {
"mbtiles": path.basename(mbtilesFile)
};
var styles = fs.readdirSync(path.resolve(styleDir, 'styles'));
for (var i = 0; i < styles.length; i++) {
var styleFilename = styles[i];
if (styleFilename.endsWith('.json')) {
var styleObject = {
"style": path.basename(styleFilename),
"tilejson": {
"bounds": bounds
}
};
config['styles'][path.basename(styleFilename, '.json')] =
styleObject;
}
}
} else {
console.log('WARN: MBTiles not in "osm2vectortiles" format. ' +
'Serving raw data only...');
config['data'][info.id || 'mbtiles'] = {
"mbtiles": path.basename(mbtilesFile)
};
}
if (opts.verbose) {
console.log(JSON.stringify(config, undefined, 2));
} else {
console.log('Run with --verbose to see the config file here.');
}
return startServer(null, config);
});
});
};
fs.stat(path.resolve(opts.config), function(err, stats) {
if (err || !stats.isFile() || stats.size === 0) {
var mbtiles = opts.mbtiles;
if (!mbtiles) {
// try to find in the cwd
var files = fs.readdirSync(process.cwd());
for (var i=0; i < files.length; i++) {
var filename = files[i];
if (filename.endsWith('.mbtiles')) {
var mbTilesStats = fs.statSync(filename);
if (mbTilesStats.isFile() && mbTilesStats.size > 0) {
mbtiles = filename;
break;
}
}
}
if (mbtiles) {
console.log('No MBTiles specified, using ' + mbtiles);
return startWithMBTiles(mbtiles);
} else {
var url = 'https://github.com/klokantech/tileserver-gl-styles/releases/download/v0.3.0/zurich_switzerland.mbtiles';
var filename = 'zurich_switzerland.mbtiles';
var stream = fs.createWriteStream(filename);
console.log('Downloading sample data (' + filename + ') from ' + url);
stream.on('finish', function() {
return startWithMBTiles(filename);
});
return request.get(url).pipe(stream);
}
}
if (mbtiles) {
return startWithMBTiles(mbtiles);
}
} else {
console.log('Using specified config file from ' + opts.config);
return startServer(opts.config, null);
}
}); });

View File

@@ -12,13 +12,17 @@ var utils = require('./utils');
module.exports = function(options, repo, params, id) { module.exports = function(options, repo, params, id) {
var app = express().disable('x-powered-by'); var app = express().disable('x-powered-by');
var mbtilesFile = path.join(options.paths.mbtiles, params.mbtiles); var mbtilesFile = path.resolve(options.paths.mbtiles, params.mbtiles);
var tileJSON = { var tileJSON = {
'tiles': params.domains || options.domains 'tiles': params.domains || options.domains
}; };
repo[id] = tileJSON; repo[id] = tileJSON;
var mbtilesFileStats = fs.statSync(mbtilesFile);
if (!mbtilesFileStats.isFile() || mbtilesFileStats.size == 0) {
throw Error('Not valid MBTiles file: ' + mbtilesFile);
}
var source = new mbtiles(mbtilesFile, function(err) { var source = new mbtiles(mbtilesFile, function(err) {
source.getInfo(function(err, info) { source.getInfo(function(err, info) {
tileJSON['name'] = id; tileJSON['name'] = id;
@@ -28,7 +32,7 @@ module.exports = function(options, repo, params, id) {
tileJSON['tilejson'] = '2.0.0'; tileJSON['tilejson'] = '2.0.0';
tileJSON['basename'] = id; tileJSON['basename'] = id;
tileJSON['filesize'] = fs.statSync(mbtilesFile)['size']; tileJSON['filesize'] = mbtilesFileStats['size'];
delete tileJSON['scheme']; delete tileJSON['scheme'];
Object.assign(tileJSON, params.tilejson || {}); Object.assign(tileJSON, params.tilejson || {});

View File

@@ -18,12 +18,13 @@ var Canvas = require('canvas'),
mercator = new (require('sphericalmercator'))(), mercator = new (require('sphericalmercator'))(),
mbgl = require('mapbox-gl-native'), mbgl = require('mapbox-gl-native'),
mbtiles = require('mbtiles'), mbtiles = require('mbtiles'),
pngquant = require('node-pngquant-native'),
request = require('request'); request = require('request');
var utils = require('./utils'); var utils = require('./utils');
var FLOAT_PATTERN = '[+-]?(?:\\d+|\\d+\.?\\d+)'; var FLOAT_PATTERN = '[+-]?(?:\\d+|\\d+\.?\\d+)';
var SCALE_PATTERN = '@[23]x'; var SCALE_PATTERN = '@[234]x';
var getScale = function(scale) { var getScale = function(scale) {
return (scale || '@1x').slice(1, 2) | 0; return (scale || '@1x').slice(1, 2) | 0;
@@ -35,7 +36,7 @@ mbgl.on('message', function(e) {
} }
}); });
module.exports = function(options, repo, params, id) { module.exports = function(options, repo, params, id, dataResolver) {
var app = express().disable('x-powered-by'); var app = express().disable('x-powered-by');
var lastModified = new Date().toUTCString(); var lastModified = new Date().toUTCString();
@@ -167,14 +168,31 @@ module.exports = function(options, repo, params, id) {
Object.keys(styleJSON.sources).forEach(function(name) { Object.keys(styleJSON.sources).forEach(function(name) {
var source = styleJSON.sources[name]; var source = styleJSON.sources[name];
var url = source.url; var url = source.url;
if (url.lastIndexOf('mbtiles:', 0) === 0) { if (url.lastIndexOf('mbtiles:', 0) === 0) {
// found mbtiles source, replace with info from local file // found mbtiles source, replace with info from local file
delete source.url; delete source.url;
var mbtilesFile = url.substring('mbtiles://'.length);
var fromData = mbtilesFile[0] == '{' &&
mbtilesFile[mbtilesFile.length - 1] == '}';
if (fromData) {
mbtilesFile = dataResolver(
mbtilesFile.substr(1, mbtilesFile.length - 2));
if (!mbtilesFile) {
console.log('ERROR: data "' + mbtilesFile + '" not found!');
process.exit(1);
}
}
queue.push(function(callback) { queue.push(function(callback) {
var mbtilesFile = url.substring('mbtiles://'.length); mbtilesFile = path.resolve(options.paths.mbtiles, mbtilesFile);
map.sources[name] = new mbtiles( var mbtilesFileStats = fs.statSync(mbtilesFile);
path.join(options.paths.mbtiles, mbtilesFile), function(err) { if (!mbtilesFileStats.isFile() || mbtilesFileStats.size == 0) {
throw Error('Not valid MBTiles file: ' + mbtilesFile);
}
map.sources[name] = new mbtiles(mbtilesFile, function(err) {
map.sources[name].getInfo(function(err, info) { map.sources[name].getInfo(function(err, info) {
var type = source.type; var type = source.type;
Object.assign(source, info); Object.assign(source, info);
@@ -184,6 +202,7 @@ module.exports = function(options, repo, params, id) {
// meta url which will be detected when requested // meta url which will be detected when requested
'mbtiles://' + name + '/{z}/{x}/{y}.' + (info.format || 'pbf') 'mbtiles://' + name + '/{z}/{x}/{y}.' + (info.format || 'pbf')
]; ];
delete source.scheme;
if (source.format == 'pbf') { if (source.format == 'pbf') {
map.sources[name].emptyTile = new Buffer(0); map.sources[name].emptyTile = new Buffer(0);
} else { } else {
@@ -221,6 +240,7 @@ module.exports = function(options, repo, params, id) {
map.renderers[1] = createPool(1, 4, 16); map.renderers[1] = createPool(1, 4, 16);
map.renderers[2] = createPool(2, 2, 8); map.renderers[2] = createPool(2, 2, 8);
map.renderers[3] = createPool(3, 2, 4); map.renderers[3] = createPool(3, 2, 4);
map.renderers[4] = createPool(4, 2, 4);
}); });
repo[id] = tileJSON; repo[id] = tileJSON;
@@ -235,7 +255,7 @@ module.exports = function(options, repo, params, id) {
return res.status(400).send('Invalid center'); return res.status(400).send('Invalid center');
} }
if (Math.min(width, height) <= 0 || if (Math.min(width, height) <= 0 ||
Math.max(width, height) * scale > 2048) { Math.max(width, height) * scale > (options.maxSize || 2048)) {
return res.status(400).send('Invalid size'); return res.status(400).send('Invalid size');
} }
if (format == 'png' || format == 'webp') { if (format == 'png' || format == 'webp') {
@@ -283,21 +303,30 @@ module.exports = function(options, repo, params, id) {
image.toFormat(format); image.toFormat(format);
var formatEncoding = (params.formatEncoding || {})[format] || var formatQuality = (params.formatQuality || {})[format] ||
(options.formatEncoding || {})[format]; (options.formatQuality || {})[format];
if (format == 'png') { if (format == 'png') {
image.compressionLevel(formatEncoding || 6) image.withoutAdaptiveFiltering();
.withoutAdaptiveFiltering();
} else if (format == 'jpeg') { } else if (format == 'jpeg') {
image.quality(formatEncoding || 80); image.quality(formatQuality || 80);
} else if (format == 'webp') { } else if (format == 'webp') {
image.quality(formatEncoding || 90); image.quality(formatQuality || 90);
} }
image.toBuffer(function(err, buffer, info) { image.toBuffer(function(err, buffer, info) {
if (!buffer) { if (!buffer) {
return res.status(404).send('Not found'); return res.status(404).send('Not found');
} }
if (format == 'png') {
var usePngQuant =
(options.formatQuality || {}).pngQuantization === true;
if (usePngQuant) {
buffer = pngquant.compress(buffer, {
quality: [0, formatQuality || 90]
});
}
}
res.set({ res.set({
'Last-Modified': lastModified, 'Last-Modified': lastModified,
'Content-Type': 'image/' + format 'Content-Type': 'image/' + format
@@ -309,6 +338,13 @@ module.exports = function(options, repo, params, id) {
}; };
app.get(tilePattern, function(req, res, next) { app.get(tilePattern, function(req, res, next) {
var modifiedSince = req.get('if-modified-since'), cc = req.get('cache-control');
if (modifiedSince && (!cc || cc.indexOf('no-cache') == -1)) {
if (new Date(lastModified) <= new Date(modifiedSince)) {
return res.sendStatus(304);
}
}
var z = req.params.z | 0, var z = req.params.z | 0,
x = req.params.x | 0, x = req.params.x | 0,
y = req.params.y | 0, y = req.params.y | 0,
@@ -396,14 +432,13 @@ module.exports = function(options, repo, params, id) {
var minCorner = mercator.px([bbox[0], bbox[3]], z), var minCorner = mercator.px([bbox[0], bbox[3]], z),
maxCorner = mercator.px([bbox[2], bbox[1]], z); maxCorner = mercator.px([bbox[2], bbox[1]], z);
while ((((maxCorner[0] - minCorner[0]) * (1 + 2 * padding) > w) || w /= (1 + 2 * padding);
((maxCorner[1] - minCorner[1]) * (1 + 2 * padding) > h)) && z > 0) { h /= (1 + 2 * padding);
z--;
minCorner[0] /= 2; z -= Math.max(
minCorner[1] /= 2; Math.log((maxCorner[0] - minCorner[0]) / w),
maxCorner[0] /= 2; Math.log((maxCorner[1] - minCorner[1]) / h)
maxCorner[1] /= 2; ) / Math.LN2;
}
return z; return z;
}; };
@@ -413,11 +448,12 @@ module.exports = function(options, repo, params, id) {
':scale(' + SCALE_PATTERN + ')?\.:format([\\w]+)'; ':scale(' + SCALE_PATTERN + ')?\.:format([\\w]+)';
var centerPattern = var centerPattern =
util.format(':lon(%s),:lat(%s),:z(\\d+)(@:bearing(%s)(,:pitch(%s))?)?', util.format(':lon(%s),:lat(%s),:z(%s)(@:bearing(%s)(,:pitch(%s))?)?',
FLOAT_PATTERN, FLOAT_PATTERN, FLOAT_PATTERN, FLOAT_PATTERN); FLOAT_PATTERN, FLOAT_PATTERN, FLOAT_PATTERN,
FLOAT_PATTERN, FLOAT_PATTERN);
app.get(util.format(staticPattern, centerPattern), function(req, res, next) { app.get(util.format(staticPattern, centerPattern), function(req, res, next) {
var z = req.params.z | 0, var z = +req.params.z,
x = +req.params.lon, x = +req.params.lon,
y = +req.params.lat, y = +req.params.lat,
bearing = +(req.params.bearing || '0'), bearing = +(req.params.bearing || '0'),
@@ -427,6 +463,10 @@ module.exports = function(options, repo, params, id) {
scale = getScale(req.params.scale), scale = getScale(req.params.scale),
format = req.params.format; format = req.params.format;
if (z < 0) {
return res.status(404).send('Invalid zoom');
}
var path = extractPathFromQuery(req.query); var path = extractPathFromQuery(req.query);
var overlay = renderOverlay(z, x, y, bearing, pitch, w, h, scale, var overlay = renderOverlay(z, x, y, bearing, pitch, w, h, scale,
path, req.query); path, req.query);

View File

@@ -17,8 +17,14 @@ module.exports = function(options, repo, params, id, reportTiles, reportFont) {
var source = styleJSON.sources[name]; var source = styleJSON.sources[name];
var url = source.url; var url = source.url;
if (url.lastIndexOf('mbtiles:', 0) === 0) { if (url.lastIndexOf('mbtiles:', 0) === 0) {
var mbtiles = url.substring('mbtiles://'.length); var mbtilesFile = url.substring('mbtiles://'.length);
var identifier = reportTiles(mbtiles); var fromData = mbtilesFile[0] == '{' &&
mbtilesFile[mbtilesFile.length - 1] == '}';
if (fromData) {
mbtilesFile = mbtilesFile.substr(1, mbtilesFile.length - 2);
}
var identifier = reportTiles(mbtilesFile, fromData);
source.url = 'local://data/' + identifier + '.json'; source.url = 'local://data/' + identifier + '.json';
} }
}); });

View File

@@ -17,13 +17,19 @@ var base64url = require('base64url'),
var packageJson = require('../package'), var packageJson = require('../package'),
serve_font = require('./serve_font'), serve_font = require('./serve_font'),
serve_rendered = require('./serve_rendered'), serve_rendered = null,
serve_style = require('./serve_style'), serve_style = require('./serve_style'),
serve_data = require('./serve_data'), serve_data = require('./serve_data'),
utils = require('./utils'); utils = require('./utils');
var isLight = packageJson.name.slice(-6) == '-light';
if (!isLight) {
// do not require `serve_rendered` in the light package
serve_rendered = require('./serve_rendered');
}
module.exports = function(opts, callback) { module.exports = function(opts, callback) {
console.log('Starting TileServer-GL v' + packageJson.version); console.log('Starting server');
var app = express().disable('x-powered-by'), var app = express().disable('x-powered-by'),
serving = { serving = {
@@ -45,21 +51,29 @@ module.exports = function(opts, callback) {
app.use(morgan('dev')); app.use(morgan('dev'));
} }
var configPath = path.resolve(opts.config); var config = opts.config || null;
var configPath = null;
var config; if (opts.configPath) {
try { configPath = path.resolve(opts.configPath);
config = clone(require(configPath)); try {
} catch (e) { config = clone(require(configPath));
console.log('ERROR: Config file not found or invalid!'); } catch (e) {
console.log(' See README.md for instructions and sample data.'); console.log('ERROR: Config file not found or invalid!');
console.log(' See README.md for instructions and sample data.');
process.exit(1);
}
}
if (!config) {
console.log('ERROR: No config file not specified!');
process.exit(1); process.exit(1);
} }
var options = config.options || {}; var options = config.options || {};
var paths = options.paths || {}; var paths = options.paths || {};
options.paths = paths; options.paths = paths;
paths.root = path.resolve(process.cwd(), paths.root || ''); paths.root = path.resolve(
configPath ? path.dirname(configPath) : process.cwd(),
paths.root || '');
paths.styles = path.resolve(paths.root, paths.styles || ''); paths.styles = path.resolve(paths.root, paths.styles || '');
paths.fonts = path.resolve(paths.root, paths.fonts || ''); paths.fonts = path.resolve(paths.root, paths.fonts || '');
paths.sprites = path.resolve(paths.root, paths.sprites || ''); paths.sprites = path.resolve(paths.root, paths.sprites || '');
@@ -78,15 +92,24 @@ module.exports = function(opts, callback) {
if (item.serve_data !== false) { if (item.serve_data !== false) {
app.use('/styles/', serve_style(options, serving.styles, item, id, app.use('/styles/', serve_style(options, serving.styles, item, id,
function(mbtiles) { function(mbtiles, fromData) {
var dataItemId; var dataItemId;
Object.keys(data).forEach(function(id) { Object.keys(data).forEach(function(id) {
if (data[id].mbtiles == mbtiles) { if (fromData) {
dataItemId = id; if (id == mbtiles) {
dataItemId = id;
}
} else {
if (data[id].mbtiles == mbtiles) {
dataItemId = id;
}
} }
}); });
if (dataItemId) { // mbtiles exist in the data config if (dataItemId) { // mbtiles exist in the data config
return dataItemId; return dataItemId;
} else if (fromData) {
console.log('ERROR: data "' + mbtiles + '" not found!');
process.exit(1);
} else { } else {
var id = mbtiles.substr(0, mbtiles.lastIndexOf('.')) || mbtiles; var id = mbtiles.substr(0, mbtiles.lastIndexOf('.')) || mbtiles;
while (data[id]) id += '_'; while (data[id]) id += '_';
@@ -100,8 +123,21 @@ module.exports = function(opts, callback) {
})); }));
} }
if (item.serve_rendered !== false) { if (item.serve_rendered !== false) {
app.use('/styles/' + id + '/', if (serve_rendered) {
serve_rendered(options, serving.rendered, item, id)); app.use('/styles/' + id + '/',
serve_rendered(options, serving.rendered, item, id,
function(mbtiles) {
var mbtilesFile;
Object.keys(data).forEach(function(id) {
if (id == mbtiles) {
mbtilesFile = data[id].mbtiles;
}
});
return mbtilesFile;
}));
} else {
item.serve_rendered = false;
}
} }
}); });
@@ -176,7 +212,8 @@ module.exports = function(opts, callback) {
return res.status(404).send('Not found'); return res.status(404).send('Not found');
} }
} }
data['server_version'] = packageJson.version; data['server_version'] = packageJson.name + ' v' + packageJson.version;
data['is_light'] = isLight;
data['key_query_part'] = data['key_query_part'] =
req.query.key ? 'key=' + req.query.key + '&amp;' : ''; req.query.key ? 'key=' + req.query.key + '&amp;' : '';
data['key_query'] = req.query.key ? '?key=' + req.query.key : ''; data['key_query'] = req.query.key ? '?key=' + req.query.key : '';
@@ -209,6 +246,11 @@ module.exports = function(opts, callback) {
style.wmts_link = 'http://wmts.maptiler.com/' + style.wmts_link = 'http://wmts.maptiler.com/' +
base64url('http://' + req.headers.host + base64url('http://' + req.headers.host +
'/styles/' + id + '/rendered.json' + query) + '/wmts'; '/styles/' + id + '/rendered.json' + query) + '/wmts';
var tiles = utils.getTileUrls(
req, style.serving_rendered.tiles,
'styles/' + id, style.serving_rendered.format);
style.xyz_link = tiles[0];
} }
}); });
var data = clone(serving.data || {}); var data = clone(serving.data || {});
@@ -233,6 +275,10 @@ module.exports = function(opts, callback) {
data_.wmts_link = 'http://wmts.maptiler.com/' + data_.wmts_link = 'http://wmts.maptiler.com/' +
base64url('http://' + req.headers.host + base64url('http://' + req.headers.host +
'/data/' + id + '.json' + query) + '/wmts'; '/data/' + id + '.json' + query) + '/wmts';
var tiles = utils.getTileUrls(
req, data_.tiles, 'data/' + id, data_.format);
data_.xyz_link = tiles[0];
} }
if (data_.filesize) { if (data_.filesize) {
var suffix = 'kB'; var suffix = 'kB';
@@ -284,7 +330,7 @@ module.exports = function(opts, callback) {
return data; return data;
}); });
var server = app.listen(process.env.PORT || opts.port, function() { var server = app.listen(process.env.PORT || opts.port, process.env.BIND || opts.bind, function() {
console.log('Listening at http://%s:%d/', console.log('Listening at http://%s:%d/',
this.address().address, this.address().port); this.address().address, this.address().port);

View File

@@ -64,6 +64,6 @@ describe('Metadata', function() {
}); });
}); });
testTileJSON('/styles/test/rendered.json', 'test'); testTileJSON('/styles/bright/rendered.json', 'bright');
testTileJSON('/data/zurich-vector.json', 'zurich-vector'); testTileJSON('/data/zurich-vector.json', 'zurich-vector');
}); });

View File

@@ -7,7 +7,7 @@ before(function() {
console.log('global setup'); console.log('global setup');
process.chdir('test_data'); process.chdir('test_data');
var running = require('../src/server')({ var running = require('../src/server')({
config: 'config.json', configPath: 'config.json',
port: 8888 port: 8888
}); });
global.app = running.app; global.app = running.app;

View File

@@ -12,88 +12,91 @@ var testStatic = function(prefix, q, format, status, scale, type, query) {
}); });
}; };
var prefix = 'bright';
describe('Static endpoints', function() { describe('Static endpoints', function() {
describe('center-based', function() { describe('center-based', function() {
describe('valid requests', function() { describe('valid requests', function() {
describe('various formats', function() { describe('various formats', function() {
testStatic('test', '0,0,0/256x256', 'png', 200, undefined, /image\/png/); testStatic(prefix, '0,0,0/256x256', 'png', 200, undefined, /image\/png/);
testStatic('test', '0,0,0/256x256', 'jpg', 200, undefined, /image\/jpeg/); testStatic(prefix, '0,0,0/256x256', 'jpg', 200, undefined, /image\/jpeg/);
testStatic('test', '0,0,0/256x256', 'jpeg', 200, undefined, /image\/jpeg/); testStatic(prefix, '0,0,0/256x256', 'jpeg', 200, undefined, /image\/jpeg/);
testStatic('test', '0,0,0/256x256', 'webp', 200, undefined, /image\/webp/); testStatic(prefix, '0,0,0/256x256', 'webp', 200, undefined, /image\/webp/);
}); });
describe('different parameters', function() { describe('different parameters', function() {
testStatic('test', '0,0,0/300x300', 'png', 200, 2); testStatic(prefix, '0,0,0/300x300', 'png', 200, 2);
testStatic('test', '0,0,0/300x300', 'png', 200, 3); testStatic(prefix, '0,0,0/300x300', 'png', 200, 3);
testStatic('test', '80,40,20/600x300', 'png', 200, 3); testStatic(prefix, '0,0,1.5/256x256', 'png', 200);
testStatic('test', '8.5,40.5,20/300x150', 'png', 200, 3);
testStatic('test', '-8.5,-40.5,20/300x150', 'png', 200, 3);
testStatic('test', '8,40,2@0,0/300x150', 'png', 200); testStatic(prefix, '80,40,20/600x300', 'png', 200, 3);
testStatic('test', '8,40,2@180,45/300x150', 'png', 200, 2); testStatic(prefix, '8.5,40.5,20/300x150', 'png', 200, 3);
testStatic('test', '8,40,2@10/300x150', 'png', 200, 3); testStatic(prefix, '-8.5,-40.5,20/300x150', 'png', 200, 3);
testStatic('test', '8,40,2@10.3,20.4/300x300', 'png', 200);
testStatic('test', '0,0,2@390,120/300x300', 'png', 200); testStatic(prefix, '8,40,2@0,0/300x150', 'png', 200);
testStatic(prefix, '8,40,2@180,45/300x150', 'png', 200, 2);
testStatic(prefix, '8,40,2@10/300x150', 'png', 200, 3);
testStatic(prefix, '8,40,2@10.3,20.4/300x300', 'png', 200);
testStatic(prefix, '0,0,2@390,120/300x300', 'png', 200);
}); });
}); });
describe('invalid requests return 4xx', function() { describe('invalid requests return 4xx', function() {
testStatic('test', '190,0,0/256x256', 'png', 400); testStatic(prefix, '190,0,0/256x256', 'png', 400);
testStatic('test', '0,86,0/256x256', 'png', 400); testStatic(prefix, '0,86,0/256x256', 'png', 400);
testStatic('test', '80,40,20/0x0', 'png', 400); testStatic(prefix, '80,40,20/0x0', 'png', 400);
testStatic('test', '0,0,0/256x256', 'gif', 400); testStatic(prefix, '0,0,0/256x256', 'gif', 400);
testStatic('test', '0,0,0/256x256', 'png', 404, 1); testStatic(prefix, '0,0,0/256x256', 'png', 404, 1);
testStatic('test', '0,0,-1/256x256', 'png', 404); testStatic(prefix, '0,0,-1/256x256', 'png', 404);
testStatic('test', '0,0,1.5/256x256', 'png', 404); testStatic(prefix, '0,0,0/256.5x256.5', 'png', 404);
testStatic('test', '0,0,0/256.5x256.5', 'png', 404);
testStatic('test', '0,0,0,/256x256', 'png', 404); testStatic(prefix, '0,0,0,/256x256', 'png', 404);
testStatic('test', '0,0,0,0,/256x256', 'png', 404); testStatic(prefix, '0,0,0,0,/256x256', 'png', 404);
}); });
}); });
describe('area-based', function() { describe('area-based', function() {
describe('valid requests', function() { describe('valid requests', function() {
describe('various formats', function() { describe('various formats', function() {
testStatic('test', '-180,-80,180,80/10x10', 'png', 200, undefined, /image\/png/); testStatic(prefix, '-180,-80,180,80/10x10', 'png', 200, undefined, /image\/png/);
testStatic('test', '-180,-80,180,80/10x10', 'jpg', 200, undefined, /image\/jpeg/); testStatic(prefix, '-180,-80,180,80/10x10', 'jpg', 200, undefined, /image\/jpeg/);
testStatic('test', '-180,-80,180,80/10x10', 'jpeg', 200, undefined, /image\/jpeg/); testStatic(prefix, '-180,-80,180,80/10x10', 'jpeg', 200, undefined, /image\/jpeg/);
testStatic('test', '-180,-80,180,80/10x10', 'webp', 200, undefined, /image\/webp/); testStatic(prefix, '-180,-80,180,80/10x10', 'webp', 200, undefined, /image\/webp/);
}); });
describe('different parameters', function() { describe('different parameters', function() {
testStatic('test', '-180,-90,180,90/20x20', 'png', 200, 2); testStatic(prefix, '-180,-90,180,90/20x20', 'png', 200, 2);
testStatic('test', '0,0,1,1/200x200', 'png', 200, 3); testStatic(prefix, '0,0,1,1/200x200', 'png', 200, 3);
testStatic('test', '-280,-80,0,80/280x160', 'png', 200); testStatic(prefix, '-280,-80,0,80/280x160', 'png', 200);
}); });
}); });
describe('invalid requests return 4xx', function() { describe('invalid requests return 4xx', function() {
testStatic('test', '0,87,1,88/5x2', 'png', 400); testStatic(prefix, '0,87,1,88/5x2', 'png', 400);
testStatic('test', '0,0,1,1/1x1', 'gif', 400); testStatic(prefix, '0,0,1,1/1x1', 'gif', 400);
testStatic('test', '-180,-80,180,80/0.5x2.6', 'png', 404); testStatic(prefix, '-180,-80,180,80/0.5x2.6', 'png', 404);
}); });
}); });
describe('autofit path', function() { describe('autofit path', function() {
describe('valid requests', function() { describe('valid requests', function() {
testStatic('test', 'auto/256x256', 'png', 200, undefined, /image\/png/, '?path=10,10|20,20'); testStatic(prefix, 'auto/256x256', 'png', 200, undefined, /image\/png/, '?path=10,10|20,20');
describe('different parameters', function() { describe('different parameters', function() {
testStatic('test', 'auto/20x20', 'png', 200, 2, /image\/png/, '?path=10,10|20,20'); testStatic(prefix, 'auto/20x20', 'png', 200, 2, /image\/png/, '?path=10,10|20,20');
testStatic('test', 'auto/200x200', 'png', 200, 3, /image\/png/, '?path=-10,-10|-20,-20'); testStatic(prefix, 'auto/200x200', 'png', 200, 3, /image\/png/, '?path=-10,-10|-20,-20');
}); });
}); });
describe('invalid requests return 4xx', function() { describe('invalid requests return 4xx', function() {
testStatic('test', 'auto/256x256', 'png', 400); testStatic(prefix, 'auto/256x256', 'png', 400);
testStatic('test', 'auto/256x256', 'png', 400, undefined, undefined, '?path=10,10'); testStatic(prefix, 'auto/256x256', 'png', 400, undefined, undefined, '?path=10,10');
testStatic('test', 'auto/2560x2560', 'png', 400, undefined, undefined, '?path=10,10|20,20'); testStatic(prefix, 'auto/2560x2560', 'png', 400, undefined, undefined, '?path=10,10|20,20');
}); });
}); });
}); });

View File

@@ -8,13 +8,15 @@ var testIs = function(url, type, status) {
}); });
}; };
var prefix = 'bright';
describe('Styles', function() { describe('Styles', function() {
describe('/styles/test.json is valid style', function() { describe('/styles/' + prefix + '.json is valid style', function() {
testIs('/styles/test.json', /application\/json/); testIs('/styles/' + prefix + '.json', /application\/json/);
it('contains expected properties', function(done) { it('contains expected properties', function(done) {
supertest(app) supertest(app)
.get('/styles/test.json') .get('/styles/' + prefix + '.json')
.expect(function(res) { .expect(function(res) {
res.body.version.should.equal(8); res.body.version.should.equal(8);
res.body.name.should.be.String(); res.body.name.should.be.String();
@@ -29,17 +31,17 @@ describe('Styles', function() {
testIs('/styles/streets.json', /./, 404); testIs('/styles/streets.json', /./, 404);
}); });
describe('/styles/test/sprite[@2x].{format}', function() { describe('/styles/' + prefix + '/sprite[@2x].{format}', function() {
testIs('/styles/test/sprite.json', /application\/json/); testIs('/styles/' + prefix + '/sprite.json', /application\/json/);
testIs('/styles/test/sprite@2x.json', /application\/json/); testIs('/styles/' + prefix + '/sprite@2x.json', /application\/json/);
testIs('/styles/test/sprite.png', /image\/png/); testIs('/styles/' + prefix + '/sprite.png', /image\/png/);
testIs('/styles/test/sprite@2x.png', /image\/png/); testIs('/styles/' + prefix + '/sprite@2x.png', /image\/png/);
}); });
}); });
describe('Fonts', function() { describe('Fonts', function() {
testIs('/fonts/Open Sans Bold/0-255.pbf', /application\/x-protobuf/); testIs('/fonts/Open Sans Bold/0-255.pbf', /application\/x-protobuf/);
testIs('/fonts/Open Sans Regular/65280-65533.pbf', /application\/x-protobuf/); testIs('/fonts/Open Sans Regular/65280-65535.pbf', /application\/x-protobuf/);
testIs('/fonts/Open Sans Bold,Open Sans Regular/0-255.pbf', testIs('/fonts/Open Sans Bold,Open Sans Regular/0-255.pbf',
/application\/x-protobuf/); /application\/x-protobuf/);
testIs('/fonts/Nonsense,Open Sans Bold/0-255.pbf', /./, 400); testIs('/fonts/Nonsense,Open Sans Bold/0-255.pbf', /./, 400);

View File

@@ -9,35 +9,38 @@ var testTile = function(prefix, z, x, y, format, status, scale, type) {
}); });
}; };
var prefix = 'bright';
describe('Raster tiles', function() { describe('Raster tiles', function() {
describe('valid requests', function() { describe('valid requests', function() {
describe('various formats', function() { describe('various formats', function() {
testTile('test', 0, 0, 0, 'png', 200, undefined, /image\/png/); testTile(prefix, 0, 0, 0, 'png', 200, undefined, /image\/png/);
testTile('test', 0, 0, 0, 'jpg', 200, undefined, /image\/jpeg/); testTile(prefix, 0, 0, 0, 'jpg', 200, undefined, /image\/jpeg/);
testTile('test', 0, 0, 0, 'jpeg', 200, undefined, /image\/jpeg/); testTile(prefix, 0, 0, 0, 'jpeg', 200, undefined, /image\/jpeg/);
testTile('test', 0, 0, 0, 'webp', 200, undefined, /image\/webp/); testTile(prefix, 0, 0, 0, 'webp', 200, undefined, /image\/webp/);
}); });
describe('different coordinates and scales', function() { describe('different coordinates and scales', function() {
testTile('test', 1, 1, 1, 'png', 200); testTile(prefix, 1, 1, 1, 'png', 200);
testTile('test', 0, 0, 0, 'png', 200, 2); testTile(prefix, 0, 0, 0, 'png', 200, 2);
testTile('test', 0, 0, 0, 'png', 200, 3); testTile(prefix, 0, 0, 0, 'png', 200, 3);
testTile('test', 2, 1, 1, 'png', 200, 3); testTile(prefix, 2, 1, 1, 'png', 200, 3);
testTile(prefix, 0, 0, 0, 'png', 200, 4);
}); });
}); });
describe('invalid requests return 4xx', function() { describe('invalid requests return 4xx', function() {
testTile('non_existent', 0, 0, 0, 'png', 404); testTile('non_existent', 0, 0, 0, 'png', 404);
testTile('test', -1, 0, 0, 'png', 404); testTile(prefix, -1, 0, 0, 'png', 404);
testTile('test', 25, 0, 0, 'png', 404); testTile(prefix, 25, 0, 0, 'png', 404);
testTile('test', 0, 1, 0, 'png', 404); testTile(prefix, 0, 1, 0, 'png', 404);
testTile('test', 0, 0, 1, 'png', 404); testTile(prefix, 0, 0, 1, 'png', 404);
testTile('test', 0, 0, 0, 'gif', 400); testTile(prefix, 0, 0, 0, 'gif', 400);
testTile('test', 0, 0, 0, 'pbf', 400); testTile(prefix, 0, 0, 0, 'pbf', 400);
testTile('test', 0, 0, 0, 'png', 404, 1); testTile(prefix, 0, 0, 0, 'png', 404, 1);
testTile('test', 0, 0, 0, 'png', 404, 4); testTile(prefix, 0, 0, 0, 'png', 404, 5);
//testTile('hybrid', 0, 0, 0, 'png', 404); //TODO: test this //testTile('hybrid', 0, 0, 0, 'png', 404); //TODO: test this
}); });