You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
Raul Ochoa 97e8b54b8c
Replaces render timeout fallback asset on behalf of @saleiva, thx!
10 years ago
assets Replaces render timeout fallback asset on behalf of @saleiva, thx! 10 years ago
config/environments cacheOnTimeout only for mapnik renderer 10 years ago
docs Remove metrics for authorizedBy* 10 years ago
lib/cartodb Add user from params to fakereq object so it's propagated 10 years ago
scripts Adds script/tool to go from lzma base64 encoded string to mapconfig 10 years ago
test Replaces render timeout fallback asset on behalf of @saleiva, thx! 10 years ago
tools Remove flush_cache tool as it doesn't make sense anymore 10 years ago
.gitignore Add option to generate coverage metrics using istanbul module 10 years ago
.jshintrc Adds some tests for limits based on user limits 10 years ago
.travis.yml apt-get update before apt-get install 10 years ago
HOWTO_RELEASE Update release document 11 years ago
LICENSE Switch to 3-clause BSD license 11 years ago
Makefile Tidy app.js 10 years ago
NEWS.md Mapnik renderer configuration not part of the `renderer` root configuration 10 years ago
README.md Specific dependencies for building node-canvas 10 years ago
app.js Tidy app.js 10 years ago
configure Have ./configure tolerate unknown options 10 years ago
npm-shrinkwrap.json Uses windshaft@0.41.0 registry version 10 years ago
package.json Uses windshaft@0.41.0 registry version 10 years ago
run_tests.sh Add option to generate coverage metrics using istanbul module 10 years ago

README.md

Windshaft-CartoDB

Build Status

This is the CartoDB Maps API 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 a template maps API

Requirements

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

Documentation

The docs directory contains different documentation resources, from higher level to more detailed ones: The Maps API defined the endpoints and their expected parameters and outputs.

Examples

CartoDB's Map Gallery showcases several examples of visualisations built on top of this.