Go to file
2018-03-15 11:35:38 +01:00
assets timeout error vector with lines 2017-11-07 15:57:33 +01:00
config/environments rate limit analysis catalog endpoint 2018-03-14 17:46:19 +01:00
docs Link to overviews doc 2018-01-11 15:15:33 +00:00
lib/cartodb rate limit middleware before auth 2018-03-14 18:06:06 +01:00
scripts timeout error vector with lines 2017-11-07 15:57:33 +01:00
test adding type and subtype to rate limit error 2018-03-14 17:27:59 +01:00
.gitignore download redis-cell lib during tests 2018-03-15 11:35:38 +01:00
.jshintignore Include test/support as part of jshint validation 2017-10-06 15:28:01 +02:00
.jshintrc Allow es6 syntax 2017-05-25 11:26:04 +02:00
.travis.yml using new docker image with redis4 and redis-cell 2018-02-19 12:43:36 +01:00
app.js extract setICUEnvVariable() to it's own module 2018-01-11 11:57:11 +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
docker-test.sh Configure travis to export environment variable (POSTGIS_VERSION) 2017-10-16 13:12:06 +02:00
HOWTO_RELEASE Fix yarn.lock and update HOWTO_RELEASE 2017-06-22 18:11:58 +02:00
INSTALL.md Change yarn dep version range specification 2017-10-03 12:43:09 +02:00
LICENSE Adds notes about contributing 2015-09-08 16:44:44 +02:00
Makefile Remove comment 2017-09-26 17:32:50 +02:00
NEWS.md Update Windshaft to 4.5.6 2018-03-12 19:13:56 +01:00
package.json Merge branch 'master' into rateLimits 2018-03-13 18:09:44 +01:00
README.md Update README.md 2017-03-17 17:41:20 +01:00
run_tests.sh download redis-cell lib during tests 2018-03-15 11:35:38 +01:00
yarn.lock yarn lock after master merge 2018-03-13 18:10:27 +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