Go to file
2017-03-24 17:34:05 +01:00
assets Replaces render timeout fallback asset on behalf of @saleiva, thx! 2015-04-08 12:21:57 +02:00
config/environments Allow to use workers for transforming cartocss into mapnik XML 2016-12-01 17:02:40 +01:00
docs found and fixed a typo 2017-03-24 09:33:15 -04:00
lib/cartodb Remove unused import 2017-03-23 01:14:56 +01:00
scripts Remove script to generate shrinkwrap 2017-03-22 13:08:12 +01:00
test Generate URLs for resources based on CDN + template rules 2017-03-22 18:58:37 +01:00
.gitignore Version 2.88.0 2017-02-20 18:46:47 +01:00
.jshintignore adds tests as part of the jshint target 2015-04-27 18:08:55 +02:00
.jshintrc Discourage console usage, global.logger should be used when required 2016-05-05 12:18:22 +02:00
.travis.yml Drop support for Node 0.10 2017-03-16 17:18:44 +01:00
app.js Remove reference to issue 2017-03-24 17:34:05 +01:00
configure Remove sql api related configuration from configure script 2015-09-29 20:00:39 +02:00
CONTRIBUTING.md Fixed contributing link 2017-01-25 10:43:24 +01:00
HOWTO_RELEASE Update HOWTO_RELEASE 2017-03-22 13:11:12 +01:00
INSTALL.md Improve doc: 'yarn install' command is deprecated, use 'yarn' instead 2017-03-21 14:58:09 +01:00
LICENSE Adds notes about contributing 2015-09-08 16:44:44 +02:00
Makefile Remove script to generate shrinkwrap 2017-03-22 13:08:12 +01:00
NEWS.md Stubs next version 2017-03-23 11:04:12 +01:00
package.json Check node version 2017-03-24 17:28:23 +01:00
README.md Update README.md 2017-03-17 17:41:20 +01:00
run_tests.sh Option to skip sql files download 2016-05-31 16:57:28 +02:00
yarn.lock Remove reference to issue 2017-03-24 17:34:05 +01:00

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 template maps API

Install

See INSTALL.md for detailed installation instructions.

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

Upgrading

Checkout your commit/branch. If you need to reinstall dependencies (you can check NEWS) do the following:

rm -rf node_modules; yarn

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.

Contributing

See CONTRIBUTING.md.

Developing with a custom windshaft version

If you plan or want to use a custom / not released yet version of windshaft (or any other dependency) the best option is to use yarn link. You can read more about it at yarn-link: Symlink a package folder.

Quick start:

~/windshaft-directory $ yarn
~/windshaft-directory $ yarn link
~/windshaft-cartodb-directory $ yarn link windshaft