Go to file

Raul Ochoa 9b122280e1 Stubs next version		2015-04-08 12:27:40 +02:00
assets	Replaces render timeout fallback asset on behalf of @saleiva, thx!	2015-04-08 12:21:57 +02:00
config/environments	cacheOnTimeout only for mapnik renderer	2015-04-07 11:09:35 +02:00
docs	Remove metrics for authorizedBy*	2015-03-27 17:57:46 +01:00
lib/cartodb	Add user from params to fakereq object so it's propagated	2015-04-08 11:11:48 +02:00
scripts	Adds script/tool to go from lzma base64 encoded string to mapconfig	2015-03-11 15:16:24 +01:00
test	Replaces render timeout fallback asset on behalf of @saleiva, thx!	2015-04-08 12:21:57 +02:00
tools	Remove flush_cache tool as it doesn't make sense anymore	2015-02-09 19:04:38 +01:00
.gitignore	Add option to generate coverage metrics using istanbul module	2015-03-23 14:05:29 +01:00
.jshintrc	Adds some tests for limits based on user limits	2015-04-01 17:39:02 +02:00
.travis.yml	apt-get update before apt-get install	2015-02-09 18:39:24 +01:00
app.js	Tidy app.js	2015-04-07 13:00:20 +02:00
configure	Have ./configure tolerate unknown options	2014-10-08 10:10:58 +02:00
HOWTO_RELEASE	Update release document	2014-04-09 09:14:20 +02:00
LICENSE	Switch to 3-clause BSD license	2014-03-20 10:20:51 +01:00
Makefile	Tidy app.js	2015-04-07 13:00:20 +02:00
NEWS.md	Stubs next version	2015-04-08 12:27:40 +02:00
npm-shrinkwrap.json	Stubs next version	2015-04-08 12:27:40 +02:00
package.json	Stubs next version	2015-04-08 12:27:40 +02:00
README.md	Specific dependencies for building node-canvas	2015-03-11 14:25:36 +01:00
run_tests.sh	Add option to generate coverage metrics using istanbul module	2015-03-23 14:05:29 +01:00

README.md

Windshaft-CartoDB

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

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
- libcairo2-dev, libpango1.0-dev, libjpeg8-dev and libgif-dev for server side canvas support
For cache control (optional)
- CartoDB-SQL-API 1.0.0+
- CartoDB 0.9.5+ (for CDB_QueryTables)
- Varnish (http://www.varnish-cache.org)
For running the testsuite
- ImageMagick (http://www.imagemagick.org)

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.