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.
5276 Commits
1 Branch
311 Tags
39 MiB
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f404285140'
${ noResults }
Go to file
Daniel García Aubert f404285140
Use postgres pool configuration to have the same configuration for all renderers. 		6 years ago
assets timeout error vector with lines 7 years ago
config/environments Use postgres pool configuration to have the same configuration for all renderers. 6 years ago
docker using the correct docker account 6 years ago
docs Fix docs typos in _cdb_feature_count 7 years ago
lib/cartodb Use postgres pool configuration to have the same configuration for all renderers. 6 years ago
scripts timeout error vector with lines 7 years ago
test Merge branch 'master' into metadata-categories 6 years ago
.gitignore Do not ignore redis-cell SO 7 years ago
.jshintignore Include test/support as part of jshint validation 7 years ago
.jshintrc Allow es6 syntax 7 years ago
.travis.yml using the correct docker account 6 years ago
CONTRIBUTING.md Fixed contributing link 8 years ago
HOWTO_RELEASE Fix yarn.lock and update HOWTO_RELEASE 7 years ago
INSTALL.md Change yarn dep version range specification 7 years ago
LICENSE Adds notes about contributing 9 years ago
Makefile Remove comment 7 years ago
NEWS.md Merge branch 'master' into upgrade-dependencies 6 years ago
README.md Update README.md 8 years ago
app.js Extract middleware served by host header 7 years ago
configure Remove sql api related configuration from configure script 9 years ago
package.json Upgrade windshaft version to 4.8.0 6 years ago
run_tests.sh Remove downloading function 7 years ago
run_tests_docker.sh EOF line 6 years ago
yarn.lock Upgrade windshaft version to 4.8.0 6 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; yarn

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.

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 yarn link. You can read more about it at yarn-link: Symlink a package folder.

Quick start:

~/windshaft-directory $ yarn
~/windshaft-directory $ yarn link
~/windshaft-cartodb-directory $ yarn link windshaft