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.
6291 Commits
1 Branch
311 Tags
39 MiB
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5f900a3b3c'
${ noResults }
Go to file
Daniel García Aubert 5f900a3b3c
Update command 		5 years ago
assets timeout error vector with lines 7 years ago
config/environments windshaft logger by config param 5 years ago
docker Tests using PG11 and Postgis 2.5 (#1093) 6 years ago
docs Professional -> Individual 5 years ago
lib Use good defaults 5 years ago
scripts Stop using deprecated Buffer constructor 5 years ago
test Exec psql commands in batches 5 years ago
.eslintignore Apply automatic eslint fixes 5 years ago
.eslintrc.js Remove jshint, add eslint and config 5 years ago
.gitignore Do not ignore redis-cell SO 7 years ago
.travis.yml Update command 5 years ago
CONTRIBUTING.md Fixed contributing link 8 years ago
HOWTO_RELEASE Drop suppor for Node.js 6, npm 3, yarn and redis 3 6 years ago
INSTALL.md Improve doc 6 years ago
LICENSE Adds notes about contributing 9 years ago
Makefile Update makefile 5 years ago
NEWS.md Update NEWS 5 years ago
README.md Rename server_options -> server-options 5 years ago
app.js Apply automatic eslint fixes 5 years ago
carto-package.json carto-package.json: Update mapnik dependency to match what's installed 5 years ago
configure Remove sql api related configuration from configure script 9 years ago
docker-bash.sh extracting postgres start from Node.js installation file 6 years ago
docker-test.sh Tests using PG11 and Postgis 2.5 (#1093) 6 years ago
package-lock.json Merge branch 'master' into eslint 5 years ago
package.json Missin configuration file in CI 5 years ago
run_tests.sh Install the cartodb extension directly 5 years ago
run_tests_docker.sh Docker: Install cartodb extension for testing purposes 5 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

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