Skip to content
Windshaft tailored for CartoDB
JavaScript PLpgSQL Shell Other
Latest commit 0edcb30 Apr 28, 2016 @rochoa rochoa Stubs next version
Failed to load latest commit information.
assets Replaces render timeout fallback asset on behalf of @saleiva, thx! Apr 8, 2015
config/environments Add option to modify host header template for camshaft batch client Apr 20, 2016
docs removed dup text from static api section Apr 24, 2016
lib/cartodb Append dataviews related columns to layers Apr 27, 2016
scripts Adds script/tool to go from lzma base64 encoded string to mapconfig Mar 11, 2015
test Append dataviews related columns to layers Apr 27, 2016
.gitignore Add option to generate coverage metrics using istanbul module Mar 23, 2015
.jshintignore adds tests as part of the jshint target Apr 27, 2015
.jshintrc Don't allow to use suite related functions anymore Sep 25, 2015
.travis.yml Merge branch 'master' into new_querytables_library Mar 4, 2016
CONTRIBUTING.md Adds notes about contributing Sep 8, 2015
HOWTO_RELEASE Be more clear about how to upgrade shrinkwrap file Oct 22, 2015
INSTALL.md Remove imagemagick reference from install instructions Feb 22, 2016
LICENSE Adds notes about contributing Sep 8, 2015
Makefile Remove make target to update windshaft Jan 15, 2016
NEWS.md Stubs next version Apr 28, 2016
README.md Adds some notes about how to npm link windshaft for development Feb 15, 2016
app.js Set backlog on server listen Sep 18, 2015
configure Remove sql api related configuration from configure script Sep 29, 2015
npm-shrinkwrap.json Stubs next version Apr 28, 2016
package.json Stubs next version Apr 28, 2016
run_tests.sh Show some redis stats after running tests Sep 25, 2015

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 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; npm install

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 npm link. You can read more about it at npm-link: Symlink a package folder.

Quick start:

~/windshaft-directory $ npm install
~/windshaft-directory $ npm link
~/windshaft-cartodb-directory $ npm link windshaft
Something went wrong with that request. Please try again.