Go to file
Simon Martín 9cb149fa32
Merge pull request #1103 from CartoDB/fix-torque-cartocss
Upgrade windshaft to version 5.4.0
2019-06-25 11:17:14 +02:00
assets timeout error vector with lines 2017-11-07 15:57:33 +01:00
config/environments Update comments and config 2019-02-22 10:49:22 +01:00
docker Tests using PG11 and Postgis 2.5 (#1093) 2019-04-10 13:06:39 +02:00
docs fix typo 2019-03-29 19:03:25 +01:00
lib/cartodb Adapt endpoints to the new preview interface 2019-06-17 10:43:30 +02:00
scripts Drop suppor for Node.js 6, npm 3, yarn and redis 3 2019-02-21 17:34:29 +01:00
test Install the cartodb extension directly 2019-06-03 16:23:41 +02:00
.gitignore Do not ignore redis-cell SO 2018-03-26 17:52:00 +02: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 Remove unused travisci variable 2019-04-10 16:43:24 +02:00
app.js Update dynamic Node.js version check 2019-03-26 19:14:39 +01:00
carto-package.json carto-package.json: Update mapnik dependency to match what's installed 2019-06-24 17:05:06 +02: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-bash.sh extracting postgres start from Node.js installation file 2019-02-12 18:51:33 +01:00
docker-test.sh Tests using PG11 and Postgis 2.5 (#1093) 2019-04-10 13:06:39 +02:00
HOWTO_RELEASE Drop suppor for Node.js 6, npm 3, yarn and redis 3 2019-02-21 17:34:29 +01:00
INSTALL.md Improve doc 2019-02-22 12:11:14 +01: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 Upgrade windshaft to version 5.4.0 2019-06-25 11:01:02 +02:00
package-lock.json Upgrade windshaft to version 5.4.0 2019-06-25 11:01:02 +02:00
package.json Upgrade windshaft to version 5.4.0 2019-06-25 11:01:02 +02:00
README.md Drop suppor for Node.js 6, npm 3, yarn and redis 3 2019-02-21 17:34:29 +01:00
run_tests_docker.sh Docker: Install cartodb extension for testing purposes 2019-06-03 16:44:59 +02:00
run_tests.sh Install the cartodb extension directly 2019-06-03 16:23:41 +02: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
$ 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