cartodb/Windshaft-cartodb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1,945 Commits 1 Branch 311 Tags 39 MiB
JavaScript 97.1%
PLpgSQL 2.3%
CSS 0.4%
8592136683
Go to file
Javier Goizueta 8592136683 Change status code assigned to some errors 
Errors without an explicit status code with the error message
containing 'does not exist' were assigned codes 404 or 403.
Now if the error message is 'function X does not exist'
(originated in SQL) the error code assigned is 400.
2016-01-21 18:02:21 +01:00
assets Replaces render timeout fallback asset on behalf of @saleiva, thx! 2015-04-08 12:21:57 +02:00
config/environments Use torque renderer config 2015-09-04 16:33:40 +02:00
docs fix json, 2nd attempt 2016-01-14 18:16:31 +01:00
lib/cartodb Change status code assigned to some errors 2016-01-21 18:02:21 +01:00
scripts Adds script/tool to go from lzma base64 encoded string to mapconfig 2015-03-11 15:16:24 +01:00
test Change status code assigned to some errors 2016-01-21 18:02:21 +01:00
tools Deprecating scripts from tools directory 2015-06-25 18:07:48 +02:00
.gitignore Add option to generate coverage metrics using istanbul module 2015-03-23 14:05:29 +01:00
.jshintignore adds tests as part of the jshint target 2015-04-27 18:08:55 +02:00
.jshintrc Don't allow to use suite related functions anymore 2015-09-25 13:37:32 +02:00
.travis.yml test with pg 9.4 2016-01-13 20:33:12 +01:00
app.js Set backlog on server listen 2015-09-18 16:25:10 +02:00
configure Remove sql api related configuration from configure script 2015-09-29 20:00:39 +02:00
CONTRIBUTING.md Adds notes about contributing 2015-09-08 16:44:44 +02:00
HOWTO_RELEASE Be more clear about how to upgrade shrinkwrap file 2015-10-22 16:26:37 +02:00
INSTALL.md Add a list of packages and postgres instructions 2015-12-30 23:37:12 -08:00
LICENSE Adds notes about contributing 2015-09-08 16:44:44 +02:00
Makefile Remove make target to update windshaft 2016-01-15 16:02:02 +01:00
NEWS.md Stubs next version 2015-11-23 16:08:32 +01:00
npm-shrinkwrap.json Merge branch 'master' into mapconfig-extension 2016-01-18 14:32:33 +01:00
package.json Use master branch from windshaft and regenerate npm-shrinkwrap.json 2016-01-15 16:01:01 +01:00
README.md Move install instructions to their own file 2015-12-30 17:29:19 -08:00
run_tests.sh Show some redis stats after running tests 2015-09-23 17:18:58 +02:00

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.