INSTALL.md

Table of contents

• Platforms
• Get the source code
• Dependencies
  • Node dependencies
• Running the project
  • Troubleshooting

Platforms

You should be able to compile RealtimeServer successfully on the following platforms:

• Linux with at least 8GB of RAM

Get the source code

You can clone the repository and all its submodules using the following command:

git clone https://sasagitlab.opensasa.info/development/realtimebus-v2.git

To update an existing clone you can use the following commands:

cd realtimebus
git pull
git submodule update --init --recursive

Dependencies

To run RealtimeServer you will need:

• The latest version of NodeJs (Tested on v4.2.6)
• The latest version of PostgreSQL (9.5 or greater)
• The latest version of PostGIS (2.2 or greater)
• The latest version of MapServer (2.2 or greater) (optional)

You can install all needed dependencies using the following command:

sudo apt install nodejs npm postgresql postgresql-server-dev-9.5 postgis recode

If you want to serve bus path overlays to use on a map (OSM, Google Maps), you need to install MapServer. Please refer to the official installation guide for help.

Node dependencies

To install all needed NodeJs dependencies run the following command in your project directory:

npm install

Import data

To run this server you need to import the VDV data first. This is done in three steps:

1. Make sure that the schemas data and beacons do not exist. If they do, drop them:

    DROP SCHEMA data CASCADE;
    DROP SCHEMA beacons CASCADE;
   

2. Import the database schemas beacons.sql and data.sql:

    psql database_name < schema.sql
   

3. Import the VDV data. Download the latest version of the VDV data from here. Upload the data by executing a POST request to the VDV-endpoint like follows:

    curl --header "Content-Type:application/octet-stream" --data-binary @/path/to/vdv.zip http://HOST/vdv
   

   The import may take a while, please be patient. After the import is completed, the server will respond to your request with the validity dates for the uploaded VDV data.

   To re-import the VDV data you only need to perform step 3. The existing tables will be truncated automatically.

Running the project

1. Enter the project directory and execute node:

    cd ~/RealtimeServer
    node app.js
   

2. The server should now be running on port 80 and can be accessed using:

    curl http://localhost/geojson/realtime
   

Troubleshooting

The Server runs on port 80 by default. On some Linux distros listening on port 80 requires elevated permissions.

To fix this error you can either:

• Run this project using elevated permissions (Unrecommended)

    sudo node app.js serve --port=80
  

• Give node permission to use port 80 (Recommended)

    sudo apt-get install libcap2-bin
    sudo setcap cap_net_bind_service=+ep `readlink -f \`which node\``
  

  You can now launch the server using:

    node app.js serve --port=80
  

• Change the port to a number over 1024

  To change the port number, pass a different port when launching app.js

    node app.js serve --port=80