Skip to content
Please note that GitHub no longer supports your web browser.

We recommend upgrading to the latest Google Chrome or Firefox.

Learn more
Windshaft tailored for CARTO
TSQL JavaScript PLpgSQL Shell Roff CSS
Branch: master
Clone or download
rjimenezda Merge pull request #1119 from CartoDB/fix-curl-docs-windows
Fix cURL docs for Windows users by using files
Latest commit 71dba04 Aug 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets timeout error vector with lines Nov 7, 2017
config/environments Merge pull request #863 from CartoDB/cartofante Jul 11, 2019
docker Tests using PG11 and Postgis 2.5 (#1093) Apr 10, 2019
docs Fix cURL docs for Windows users by using files Aug 22, 2019
lib/cartodb Please jshint Jul 29, 2019
scripts Drop suppor for Node.js 6, npm 3, yarn and redis 3 Feb 21, 2019
test Update windshaft devel branch Jul 29, 2019
.gitignore Do not ignore redis-cell SO Mar 26, 2018
.jshintignore Include test/support as part of jshint validation Oct 6, 2017
.jshintrc Allow es6 syntax May 25, 2017
.travis.yml Remove unused travisci variable Apr 10, 2019
CONTRIBUTING.md Fixed contributing link Jan 25, 2017
HOWTO_RELEASE Drop suppor for Node.js 6, npm 3, yarn and redis 3 Feb 21, 2019
INSTALL.md Improve doc Feb 22, 2019
LICENSE Adds notes about contributing Sep 8, 2015
Makefile Remove NO PORTED TEST makefile option Mar 19, 2018
NEWS.md Update windshaft to version 5.6.0 Jul 30, 2019
README.md Drop suppor for Node.js 6, npm 3, yarn and redis 3 Feb 21, 2019
app.js Update dynamic Node.js version check Mar 26, 2019
carto-package.json carto-package.json: Update mapnik dependency to match what's installed Jun 24, 2019
configure Remove sql api related configuration from configure script Sep 29, 2015
docker-bash.sh extracting postgres start from Node.js installation file Feb 12, 2019
docker-test.sh Tests using PG11 and Postgis 2.5 (#1093) Apr 10, 2019
package-lock.json Update windshaft to version 5.6.0 Jul 30, 2019
package.json Update windshaft to version 5.6.0 Jul 30, 2019
run_tests.sh Install the cartodb extension directly Jun 3, 2019
run_tests_docker.sh Docker: Install cartodb extension for testing purposes Jun 3, 2019

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
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
You can’t perform that action at this time.