Go to file

Sandro Santilli 81a83b93e4 Make base url configurable, use a wildcard in the example config		2013-05-23 11:49:23 +02:00
app	Make base url configurable, use a wildcard in the example config	2013-05-23 11:49:23 +02:00
config	Make base url configurable, use a wildcard in the example config	2013-05-23 11:49:23 +02:00
doc	Initial support for TopoJSON (#79 )	2013-01-09 17:43:23 +01:00
logs	updated gitignore and added required directories for node cluster to work out of the box	2011-09-05 17:01:23 +01:00
test	Make base url configurable, use a wildcard in the example config	2013-05-23 11:49:23 +02:00
tools	Automatically use batch mode when input or output aren't a TTY	2012-11-23 17:18:39 +01:00
websocket_test	updated readme to reflect api key:	2012-06-01 21:19:02 +01:00
.gitignore	Ignore node_module* permutations	2013-02-18 12:58:04 +01:00
app.js	Allow using "test" as and environment name	2013-03-14 09:16:06 +01:00
cluster.js	Use an env config parameter for socket timeout	2012-12-05 14:02:40 +01:00
configure	Rename env files to .example, add a ./configure script	2012-10-04 12:04:49 +02:00
LICENSE	update licence	2011-10-07 17:19:37 +01:00
Makefile	Run tests on "make check", using custom port for redis	2012-07-12 18:10:56 +02:00
NEWS.md	Make base url configurable, use a wildcard in the example config	2013-05-23 11:49:23 +02:00
npm-shrinkwrap.json	Fix shrinkwrap after re-install of cluster2	2013-04-30 17:31:25 +02:00
package.json	Target v1.3.10	2013-05-10 12:18:27 +02:00
README.md	Document node-0.8 requirement	2012-10-04 12:43:12 +02:00

README.md

SQL API for cartodb.com

Provides a nodejs based API for running SQL queries against CartoDB.

Users are authenticated over OAuth or via an API KEY.
Authenticated requests to this API should always be made over SSL.

core requirements

postgres 9.0+
cartodb 0.9.5+ (for CDB_QueryTables)
redis
node 0.8+
npm

Install dependencies

npm install

usage

Create and edit config/environments/.js from .js.example files. You may find the ./configure script useful to make an edited copy for you, see ./configure --help for a list of supported switches.

Make sure redis is running and knows about active cartodb user.

Make sure your PostgreSQL server is running, is accessible on the host and port specified in the file, has a 'publicuser' role and trusts user authentication from localhost connections.

node [cluster.js|app.js] <environment>

Supported values are developement, test, production

See doc/API.md for API documentation. For examples of use, see under test/.

tests

Run make check or see test/README.md