Skip to content

CartoDB/Windshaft-cartodb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

749a083 · Jan 30, 2018
Nov 7, 2017
Dec 12, 2017
Jan 11, 2018
Jan 29, 2018
Nov 7, 2017
Jan 29, 2018
May 18, 2017
Oct 6, 2017
May 25, 2017
Jan 16, 2018
Jan 25, 2017
Jun 22, 2017
Oct 3, 2017
Sep 8, 2015
Sep 26, 2017
Jan 30, 2018
Mar 17, 2017
Jan 11, 2018
Sep 29, 2015
Oct 16, 2017
Jan 30, 2018
Oct 5, 2017
Jan 29, 2018

Repository files navigation

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