Add more information about Varnish and address some minor styling nits and cleanup.

1.0
Aaron Steele 13 years ago
parent 1fd9bbbfa9
commit 6c8e774b80

@ -35,6 +35,7 @@ In other words, with CartoDB you can make awesome maps and build powerful geospa
- PostGIS 2.0
- Postgres 9.1.x
- Redis 2.2+
- Varnish 3.0+
- Ruby 1.9.2+
- Windshaft-cartodb
@ -45,7 +46,7 @@ The installation process is fairly painless, and we have successful installation
Before getting started, go ahead and download CartoDB by cloning this repository:
```bash
git clone https://github.com/Vizzuality/cartodb.git
$ git clone https://github.com/Vizzuality/cartodb.git
```
Or you can just [download the CartoDB zip file](https://github.com/Vizzuality/cartodb/zipball/master).
@ -56,17 +57,20 @@ We implemented CartoDB in the [Ruby](ruby-lang.org) programming language, so you
## Install Node.js ##
Components of CartoDB, like Windshaft, depend on [Node.js](nodejs.org). Basically it's a highly-scalable web server that leverages Google's V8 JavaScript engine.
Components of CartoDB, like Windshaft, depend on [Node.js](nodejs.org) (version greater than or equal to 0.4.1 but less than version 0.5.0). Basically it's a highly-scalable web server that leverages Google's V8 JavaScript engine.
You can install Node.js and NPM (the Node.js package manager) by [following these instructions](https://github.com/joyent/node/wiki/Installation) on Node's GitHub wiki site.
Alternatively, you can install Node.js using `brew install node`, but NPM has to be installed using the wiki instructions above.
Required: {"node":">= 0.4.1 < 0.5.0"}
You may run into NPM version issues. If so, run
You may run into a few annoying NPM version issuess. If so, don't worry! Just run:
curl http://npmjs.org/install.sh | sh
```bash
$ curl http://npmjs.org/install.sh | sh
```
And you will be good to GO.
## Install PostgreSQL and PostGIS ##
@ -80,7 +84,6 @@ First you'll need to install a few dependencies.
- [PROJ4](http://trac.osgeo.org/proj) is required for reprojection support.
- plpython is required for Python support (e.g., `sudo apt-get install postgresql-plpython-9.1`)
Next install PostgreSQL 9.1.x and PostGIS 2.0.x.
Finally, CartoDB depends on a geospatial database template named `template_postgis`. In the example script below, make sure that the path to each SQL file is correct. As of PostGIS r8242 for example, spatial_ref_sys.sql is now located in the `root` installation directory, instead of in the `./postgis` directory:
@ -110,15 +113,19 @@ To install Redis 2.2+, You can [download it here](http://redis.io/download) or y
To install the Python modules that CartoDB depends on, you can use `easy_install`, which is easy!
```bash
easy_install pip
pip install -r python_requirements.txt
$ easy_install pip
$ pip install -r python_requirements.txt
```
If this fails, try doing `export ARCHFLAGS='-arch i386 -arch x86_64'` beforehand.
Next install varnish
## Install Varnish
```pip install -e git+https://github.com/RealGeeks/python-varnish.git@0971d6024fbb2614350853a5e0f8736ba3fb1f0d#egg=python-varnish```
[Varish](https://www.varnish-cache.org) is a web application accelerator. Components like Windshaft use it to speed up serving tiles via the Maps API. Installing it is speedy too!
```
$ pip install -e $ git+https://github.com/RealGeeks/python-varnish.git@0971d6024fbb2614350853a5e0f8736ba3fb1f0d#egg=python-varnish
```
## Install Mapnik ##
@ -128,10 +135,10 @@ To install it using Ubuntu:
```bash
sudo apt-get install build-essential curl wget python-software-properties
sudo add-apt-repository ppa:mapnik/nightly-trunk
sudo apt-get update
sudo apt-get install libmapnik libmapnik-dev mapnik-utils
$ sudo apt-get install build-essential curl wget python-software-properties
$ sudo add-apt-repository ppa:mapnik/nightly-trunk
$ sudo apt-get update
$ sudo apt-get install libmapnik libmapnik-dev mapnik-utils
```
To install it using OS X, here is a nice [Homebrew recipe](http://trac.mapnik.org/wiki/MacInstallation/Homebrew).
@ -141,15 +148,15 @@ To install it using OS X, here is a nice [Homebrew recipe](http://trac.mapnik.or
The CartoDB SQL API component powers the SQL queries over HTTP. To install it:
```bash
git clone git@github.com:Vizzuality/CartoDB-SQL-API.git
cd CartoDB-SQL-API
npm install
$ git clone git@github.com:Vizzuality/CartoDB-SQL-API.git
$ cd CartoDB-SQL-API
$ npm install
```
To run CartoDB SQL API in development mode, simply type:
```bash
node app.js development
$ node app.js development
```
## Install Windshaft-cartodb ##
@ -157,14 +164,14 @@ node app.js development
The [Windshaft-cartodb](https://github.com/Vizzuality/Windshaft-cartodb) component powers the CartoDB Maps API. To install it:
```bash
git clone git@github.com:Vizzuality/Windshaft-cartodb.git
cd Windshaft-cartodb
npm install
$ git clone git@github.com:Vizzuality/Windshaft-cartodb.git
$ cd Windshaft-cartodb
$ npm install
```
To run Windshaft-cartodb in development mode, simply type:
```bash
node app.js development
$ node app.js development
```
## Install local instance of cold beer ##
@ -191,14 +198,14 @@ After that, just make sure CartoDB-SQL-API, Windshaft-cartodb, and Redis are all
Ok, let's start CartoDB on the rails development server:
```bash
rails s
$ rails s
```
And finally, setup your first user account:
```bash
bundle exec rake cartodb:db:setup EMAIL=me@mail.com SUBDOMAIN=mysubdomain PASSWORD=mypass ADMIN_PASSWORD=mypass
bundle exec rake cartodb:db:set_user_quota['me',1000] # 1 GB quota
$ bundle exec rake cartodb:db:setup EMAIL=me@mail.com SUBDOMAIN=mysubdomain PASSWORD=mypass ADMIN_PASSWORD=mypass
$ bundle exec rake cartodb:db:set_user_quota['me',1000] # 1 GB quota
```
That's it!

Loading…
Cancel
Save