cartodb4
/
Windshaft-cartodb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1825 Commits
1 Branch
311 Tags
39 MiB
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '6f7bbe4ff5'
${ noResults }
Go to file
Paul Norman 6f7bbe4ff5
Move install instructions to their own file 		9 years ago
assets Replaces render timeout fallback asset on behalf of @saleiva, thx! 10 years ago
config/environments Use torque renderer config 9 years ago
docs Remove specific template maps doc as it's redundant info from Map-API.md 9 years ago
lib/cartodb Remove soft-purge option when purging fastly 9 years ago
scripts Adds script/tool to go from lzma base64 encoded string to mapconfig 10 years ago
test Do not test `all` layers. Test is also present in windshaft suite. 9 years ago
tools Deprecating scripts from tools directory 9 years ago
.gitignore Add option to generate coverage metrics using istanbul module 10 years ago
.jshintignore adds tests as part of the jshint target 10 years ago
.jshintrc Don't allow to use suite related functions anymore 9 years ago
.travis.yml apt-get update before apt-get install 10 years ago
CONTRIBUTING.md Adds notes about contributing 9 years ago
HOWTO_RELEASE Be more clear about how to upgrade shrinkwrap file 9 years ago
INSTALL.md Move install instructions to their own file 9 years ago
LICENSE Adds notes about contributing 9 years ago
Makefile Makefile getting tests with find command 9 years ago
NEWS.md Stubs next version 9 years ago
README.md Move install instructions to their own file 9 years ago
app.js Set backlog on server listen 9 years ago
configure Remove sql api related configuration from configure script 9 years ago
npm-shrinkwrap.json Stubs next version 9 years ago
package.json Stubs next version 9 years ago
run_tests.sh Show some redis stats after running tests 9 years ago

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.