Réseau Libre/ documentation/ libremap/ installation

Installation instructions for libremap on Debian sid/jessie.

  1. CouchDB and GeoCouch installation
  2. libremap-api installation
  3. libremap-webui installation
  4. Creating a node

CouchDB and GeoCouch installation

We will need to compile 'geocouch' manually, since it is not yet packaged in Debian.

Install dependancies to build geocouch from source:

sudo apt-get install build-essential erlang libicu-dev libmozjs-dev libcurl4-openssl-dev \
 libtool automake checkinstall couchdb

Install the couchdb source:

mkdir ~/src
cd ~/src
apt-get source couchdb

Download the geocouch source:

cd ~/src
git clone https://github.com/couchbase/geocouch.git

Compile (NB: change 1.4.0 below to the version you downloaded):

cd ~/src/geocouch/
export COUCH_SRC=~/src/couchdb-1.4.0/src/couchdb
git checkout couchdb1.3.x
make

NB: as of 2013-12, Debian unstable had CouchDB 1.4, although CouchDB 2.x now exists. GeoCouch must be built against the same version of CouchDB. There wasn't a 1.4 branch of geocouch, but it seems to compile correctly with the 1.3 branch, To see the available GeoCouch branches available, type "git branch -v -r".

After compilation, you probably want to install it somewhere outside a user directory, ex:

sudo cp -r ebin /usr/local/lib/couchdb-geocouch

And tell erlang ("man erl") to add that to the "code path". In Debian, this can be done in the /etc/default/couchdb file:

export ERL_FLAGS="-pa /usr/local/lib/couchdb-geocouch"

Restart couchdb to make sure everything is OK:

sudo service couchdb stop
ps aux | grep couchdb
sudo kill -9 [...]
sudo service couchdb start

(on Debian jessy, as of 2013-12, doing a restart does not really restart couchdb, because couchdb keeps respawning itself automatically; TODO: is there a bug report open about this already?)

References:

libremap-api installation

This assumes that you have completed the GeoCouch installation.

Install the requirements for libremap-api:

sudo apt-get install nodejs
sudo npm install -g grunt-cli

NB: npm installs modules to /usr/local/lib/node_modules/.

Install libremap-api:

cd ~/src/
git clone git://github.com/libremap/libremap-api.git
cd libremap-api
npm install

Create a CouchDB database:

  • access http://localhost:5974/utils/ (if you are not working locally, edit your /etc/couchdb/default.ini and change the "bindaddress" in the 'httpd' section, then restart couchdb)
  • create an admin account by clicking on the link in the lower-right corner of the screen (more info: http://www.youtube.com/watch?v=oHKvV3Nh-CI)
  • (I could not really figure out how users work in CouchDB, so just moved on to the next step, expecting permissions problems, but it didn't make much of a difference, maybe the admin account was still wide open)
  • in ~/src/libremap-api, copy the file 'couch.json.example' to couch.json
  • change the configuration to match yours.

For example:

{
  "couches": {
    "localhost": {
      "database": "http://192.168.42.1:5984/libremap"
    },
    "dev": {
      "database": "http://192.168.42.1:5984/libremap-dev",
      "user": "libremap-dev",
      "pass": "somerandompassword"
    },
    "production": {
      "database": "http://192.168.42.1:5984/libremap",
      "user": "libremap",
      "pass": "anotherrandompassword"
    }
  }
}
  • run "grunt push --couch dev"

References:

libremap-webui installation

This assumes that you have completed the GeoCouch and libremap-api installation.

Install the requirements for libremap-webui:

sudo npm install -g bower

Install libremap-webui:

cd ~/src/
git clone git://github.com/libremap/libremap-webui.git
cd libremap-webui
npm install
bower install

Configure the local settings so that libremap-webui knows where our couchdb is:

cp -i config.json.example config.json

Edit to adapt to local configurations. For example:

{
  "api_url": "http://carte.bidon.ca/api", // <-- couchDB server via proxy vhost
  "title": "Réseau libre",
  "init_bbox": [[45.29324494090279,-74.07737731933594],[45.77997516219389,-73.32069396972655]],
  "plugins": {
    "tileLayer": "./plugins/tileLayer",
[...]
  "dataLayers": [
    {
      "plugin": "lmLayer",
      "id": "carte.bidon.ca",
      "name": "Routers and Links",
      "api_url": "http://carte.bidon.ca/api",
[...]
      "routers": {
        "cluster": false,  // <-- set to false (for Montreal, does not give a good result)
        "filter_mode": "or",
        "filters": [
          {
            "plugin": "lmFilterRouterAP",
            "enabled": false, // <-- disable, since we have mostly relays, not routers
            "name": "Access Points"
          },
          {
            "plugin": "lmFilterRouterCommunity",
            "enabled": false,
            "name": "Community",
            "val": "Réseau libre Montréal"
          }
[...]

Note that the above example is pointing to the dev DB (libremap-dev).

An Apache vhost doing a proxy for carte.bidon.ca/api :


  ServerName carte.bidon.ca

  ProxyPass /api http://192.168.42.1:5984/libremap-dev/_design/libremap-api/_rewrite/
  ProxyPass / http://192.168.42.1:9000/
  SetEnv proxy-sendchunks 1

Alternatively, for nginx:

server {
    listen 80;
    listen [::]:80;

    root /var/www/;
    index index.html;
    server_name carte.bidon.ca;

    location / {
        proxy_set_header X-Real-IP  $remote_addr;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_set_header Host $host;
        proxy_pass http://192.168.42.1:9000;
    }

    location /api {
        proxy_set_header X-Real-IP  $remote_addr;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_set_header Host $host;
        proxy_pass http://192.168.42.1:5984/libremap-dev/_design/libremap-api/_rewrite/;
    }
}

And finally, ready to run it:

grunt

Note that if you need to debug stuff and want to avoid js/css aggregation, you can run:

grunt --debug

You can now point your browser to http://192.168.42.1:9000/

IMPORTANT: if you have a firewall running, there is a script called "livereload" that tries to connect directly on port 31337 of your web server. See references for more info, I'm not sure yet what it's for, and why it needs to run on a separate port. Long story short, you will want to either disable livereload or open the firewall port, otherwise loading the map will be extremely slow.

References:

Creating a node

(I have no idea what I'm doing at this point --bgm)

Create a text file, for example, latakia.json:

{
  "api_rev": "1.0",
  "type": "router",
  "ctime": "2013-08-20T19:00:00.000Z",
  "mtime": "2013-12-10T19:00:00.000Z",
  "hostname": "latakia",
  "lat": 45.465676,
  "lon": -73.572185,
  "community": "Réseau libre/Montréal"
}

Send it to the server:

$ curl -X POST -d @latakia.json http://192.168.42.1:5984/libremap-dev/_design/libremap-api/_rewrite/router/

It responds:

{"ok":true,"id":"e31ac2d003d2ef25b3d241ff92000f3a"}

We can then query the server to see if it worked:

curl -X GET http://192.168.42.1:5984/libremap-dev/_design/libremap-api/_rewrite/router/e31ac2d003d2ef25b3d241ff92000f3a

It should print the equivalent of what we had saved.

References:

For more examples, see: userguide