Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Windshaft tailored for CartoDB

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
config
lib/cartodb
test
tools
.gitignore
.travis.yml
HOWTO_RELEASE
LICENCE
Makefile
NEWS.md
README.md
app.js
configure
npm-shrinkwrap.json
package.json
run_tests.sh

README.md

Windshaft-CartoDB

Build Status

This is the CartoDB map tiler. It extends Windshaft with some extra functionality and custom filters for authentication

  • reads dbname from subdomain and cartodb redis for pretty tile urls
  • configures windshaft to publish cartodb_id as the interactivity layer
  • gets the default geometry type from the cartodb redis store
  • allows tiles to be styled individually
  • provides a link to varnish high speed cache
  • provides a infowindow endpoint for windshaft (DEPRECATED)
  • provides a map_metadata endpoint for windshaft (DEPRECATED)
  • provides signed template maps API (http://github.com/CartoDB/Windshaft-cartodb/wiki/Template-maps)

Requirements

[core]

Configure

Create the config/environments/.js files (there are .example files to start from). You can optionally use the ./configure script for this, see ./configure --help to see available options.

Look at lib/cartodb/server_options.js for more on config

Build/install

To fetch and build all node-based dependencies, run:

git clone
npm install

Note that the npm install step will populate the node_modules/ directory with modules, some of which being compiled on demand. If you happen to have startup errors you may need to force rebuilding those modules. At any time just wipe out the node_modules/ directory and run npm install again.

Run

node app.js <env> 

Where is the name of a configuration file under config/environments/.

Note that caches are kept in redis. If you're not seeing what you expect there may be out-of-sync records in there. Take a look: http://redis.io/commands

URLs

TILES

[GET] subdomain.cartodb.com/tiles/:table_name/:z/:x/:y.[png|png8|grid.json]

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

[GET/POST] subdomain.cartodb.com/tiles/:table_name/style

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.

Something went wrong with that request. Please try again.