From 30852779432ab7c7213228e2de5896fb84b3f9c8 Mon Sep 17 00:00:00 2001 From: Sandro Santilli Date: Thu, 15 Mar 2012 11:37:25 +0100 Subject: [PATCH 1/4] 80cols wrap --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 59899c9d..9fe82949 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ Windshaft-CartoDB ================== -This is the CartoDB map tiler. It extends Windshaft with some extra functionality and custom filters for authentication +This is the CartoDB map tiler. It extends Windshaft with some extra +functionality and custom filters for authentication Look at lib/cartodb/server_options for more on config @@ -34,7 +35,8 @@ Args: * sql - plain SQL arguments * interactivity - specify the column to use in UTFGrid -* cache_buster - if needed you can add a cachebuster to make sure you're rendering new +* cache_buster - if needed you can add a cachebuster to make sure you're + rendering new * geom_type - override the cartodb default * style - override the default map style with Carto @@ -66,4 +68,5 @@ Args: * infowindow - returns contents of infowindow from CartoDB. -All GET requests are wrappable with JSONP using callback argument, including the UTFGrid map tile call. \ No newline at end of file +All GET requests are wrappable with JSONP using callback argument, +including the UTFGrid map tile call. From a7c5c88c58a45de93bc80cb0cfe41545d587b2c0 Mon Sep 17 00:00:00 2001 From: Sandro Santilli Date: Thu, 15 Mar 2012 12:08:50 +0100 Subject: [PATCH 2/4] Mention config/environments/*.js setting, reorder sections --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9fe82949..8d5e47d1 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,6 @@ Windshaft-CartoDB This is the CartoDB map tiler. It extends Windshaft with some extra functionality and custom filters for authentication -Look at lib/cartodb/server_options for more on config - * 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 @@ -14,12 +12,25 @@ Look at lib/cartodb/server_options for more on config * provides a infowindow endpoint for windshaft * provides a map_metadata endpoint for windshaft - Install ------- + ``` git clone npm install +``` + +Configure +--------- + +Edit config/environments/.js files + +Look at lib/cartodb/server_options for more on config + +Run +--- + +``` node app.js [development | production] ``` From ab50461e83035e42312afc8f2563ecc1b0da0c75 Mon Sep 17 00:00:00 2001 From: Sandro Santilli Date: Wed, 4 Apr 2012 15:17:07 +0200 Subject: [PATCH 3/4] Add note about ```npm install``` actions (#12) --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 8d5e47d1..57a1ee03 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,12 @@ git clone npm install ``` +Note that the ```npm install``` step will populate the node_modules/ +directory with modules, some of which being compiled on demand. If you +happen to have startup errors you may need to force rebuilding those +modules. At any time just wipe out the node_modules/ directory and run +```npm install``` again. + Configure --------- From 192d53679d969799e21574b7607dca9e2fc822d8 Mon Sep 17 00:00:00 2001 From: Sandro Santilli Date: Wed, 18 Apr 2012 12:09:43 +0200 Subject: [PATCH 4/4] Add note about possible out-of-sync redis caches --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 57a1ee03..2fc97856 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,10 @@ Run node app.js [development | production] ``` +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 + URLs ----