Improve readme
- Requirements bumped - Delete URLs documentation and point to docs directory.
This commit is contained in:
Raul Ochoa
parent
1979697551
commit
6d4eb23696
97
README.md
97
README.md
@ -3,36 +3,36 @@ Windshaft-CartoDB
|
|||||||
|
|
||||||
[](https://travis-ci.org/CartoDB/Windshaft-cartodb)
|
[](https://travis-ci.org/CartoDB/Windshaft-cartodb)
|
||||||
|
|
||||||
This is the CartoDB map tiler. It extends Windshaft with some extra
|
This is the [CartoDB Maps API](http://docs.cartodb.com/cartodb-platform/maps-api.html) tiler. It extends
|
||||||
functionality and custom filters for authentication
|
[Windshaft](https://github.com/CartoDB/Windshaft) with some extra functionality and custom filters for authentication.
|
||||||
|
|
||||||
* reads dbname from subdomain and cartodb redis for pretty tile urls
|
* reads dbname from subdomain and cartodb redis for pretty tile urls
|
||||||
* configures windshaft to publish ``cartodb_id`` as the interactivity layer
|
* configures windshaft to publish `cartodb_id` as the interactivity layer
|
||||||
* gets the default geometry type from the cartodb redis store
|
* gets the default geometry type from the cartodb redis store
|
||||||
* allows tiles to be styled individually
|
* allows tiles to be styled individually
|
||||||
* provides a link to varnish high speed cache
|
* provides a link to varnish high speed cache
|
||||||
* provides a ``infowindow`` endpoint for windshaft (DEPRECATED)
|
* provides a ``infowindow`` endpoint for windshaft (DEPRECATED)
|
||||||
* provides a ``map_metadata`` endpoint for windshaft (DEPRECATED)
|
* provides a ``map_metadata`` endpoint for windshaft (DEPRECATED)
|
||||||
* provides signed template maps API
|
* provides a [template maps API](https://github.com/CartoDB/Windshaft-cartodb/blob/master/docs/Template-maps.md)
|
||||||
(http://github.com/CartoDB/Windshaft-cartodb/wiki/Template-maps)
|
|
||||||
|
|
||||||
Requirements
|
Requirements
|
||||||
------------
|
------------
|
||||||
|
- Core
|
||||||
|
- Node.js >=0.8
|
||||||
|
- npm >=1.2.1
|
||||||
|
- PostgreSQL >8.3.x, PostGIS >1.5.x
|
||||||
|
- Redis >2.4.0 (http://www.redis.io)
|
||||||
|
- Mapnik 2.0.1, 2.0.2, 2.1.0, 2.2.0, 2.3.0. See Installing Mapnik.
|
||||||
|
- Windshaft: check [Windshaft dependencies and installation notes](https://github.com/CartoDB/Windshaft#dependencies)
|
||||||
|
- libcairo2, libpango1.0, libjpeg8 and libgif for server side canvas support
|
||||||
|
|
||||||
[core]
|
- For cache control (optional)
|
||||||
- node-0.8.x+
|
- CartoDB-SQL-API 1.0.0+
|
||||||
- PostgreSQL-8.3+
|
- CartoDB 0.9.5+ (for `CDB_QueryTables`)
|
||||||
- PostGIS-1.5.0+
|
- Varnish (http://www.varnish-cache.org)
|
||||||
- Redis 2.4.0+ (http://www.redis.io)
|
|
||||||
- Mapnik 2.0 or 2.1
|
|
||||||
|
|
||||||
[for cache control]
|
- For running the testsuite
|
||||||
- CartoDB-SQL-API 1.0.0+
|
- ImageMagick (http://www.imagemagick.org)
|
||||||
- CartoDB 0.9.5+ (for ``CDB_QueryTables``)
|
|
||||||
- Varnish (http://www.varnish-cache.org)
|
|
||||||
|
|
||||||
[for running the testsuite]
|
|
||||||
- Imagemagick (http://www.imagemagick.org)
|
|
||||||
|
|
||||||
Configure
|
Configure
|
||||||
---------
|
---------
|
||||||
@ -74,59 +74,16 @@ there may be out-of-sync records in there.
|
|||||||
Take a look: http://redis.io/commands
|
Take a look: http://redis.io/commands
|
||||||
|
|
||||||
|
|
||||||
URLs
|
Documentation
|
||||||
----
|
-------------
|
||||||
|
|
||||||
**TILES**
|
The [docs directory](https://github.com/CartoDB/Windshaft-cartodb/tree/master/docs) contains different documentation
|
||||||
|
resources, from higher level to more detailed ones:
|
||||||
[GET] subdomain.cartodb.com/tiles/:table_name/:z/:x/:y.[png|png8|grid.json]
|
The [Maps API](https://github.com/CartoDB/Windshaft-cartodb/blob/master/docs/Map-API.md) defined the endpoints and their
|
||||||
|
expected parameters and outputs.
|
||||||
Args:
|
|
||||||
|
|
||||||
* sql - plain SQL arguments
|
|
||||||
* interactivity - specify the column to use in UTFGrid
|
|
||||||
* cache_buster - Specify an identifier for the internal tile cache.
|
|
||||||
Requesting tiles with the same cache_buster value may
|
|
||||||
result in being served a cached version of the tile
|
|
||||||
(even when requesting a tile for the first time, as tiles
|
|
||||||
can be prepared in advance)
|
|
||||||
* cache_policy - Set to "persist" to have the server send an Cache-Control
|
|
||||||
header requesting caching devices to keep the response
|
|
||||||
cached as much as possible. This is best used with a
|
|
||||||
timestamp value in cache_buster for manual control of
|
|
||||||
updates.
|
|
||||||
* geom_type - override the cartodb default
|
|
||||||
* style - override the default map style with Carto
|
|
||||||
|
|
||||||
|
|
||||||
**STYLE**
|
Examples
|
||||||
|
--------
|
||||||
|
|
||||||
[GET/POST] subdomain.cartodb.com/tiles/:table_name/style
|
[CartoDB's Map Gallery](http://cartodb.com/gallery/) showcases several examples of visualisations built on top of this.
|
||||||
|
|
||||||
Args:
|
|
||||||
|
|
||||||
* style - the style in CartoCSS you want to set
|
|
||||||
* style_version - the version of the style for POST
|
|
||||||
* style_convert - request conversion to target version (both POST and GET)
|
|
||||||
|
|
||||||
|
|
||||||
**INFOWINDOW**
|
|
||||||
|
|
||||||
[GET] subdomain.cartodb.com/tiles/:table_name/infowindow
|
|
||||||
|
|
||||||
Args:
|
|
||||||
|
|
||||||
* infowindow - returns contents of infowindow from CartoDB.
|
|
||||||
|
|
||||||
|
|
||||||
**MAP METADATA**
|
|
||||||
|
|
||||||
[GET] subdomain.cartodb.com/tiles/:table_name/map_metadata
|
|
||||||
|
|
||||||
Args:
|
|
||||||
|
|
||||||
* infowindow - returns contents of infowindow from CartoDB.
|
|
||||||
|
|
||||||
|
|
||||||
All GET requests are wrappable with JSONP using callback argument,
|
|
||||||
including the UTFGrid map tile call.
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user