Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.92 KB

README.md

File metadata and controls

41 lines (25 loc) · 1.92 KB
Raw

BikeMan - Bike Manager

BikeMan is a management and backend system for pedelec rental stations.

System Requirements

  • JDK 8
  • Maven
  • Postgres 9.5 or 9.6

It is designed to run as standalone, so a java servlet container / web server (e.g. Apache Tomcat), is not required.

Configuration and Installation

  1. Database preparation:

    Make sure that a database user "BikeMan" and a database "BikeMan" exist (or change these however you want). The user should be the owner of the database.

    The database migrations will be done by Liquibase when the application starts.

  2. Start the application with

    mvn spring-boot:run

  3. Access the web interface at http://localhost:8080/. The initial credentials are defined in users.csv. So, you can login with the email admin@bikeman.com and password admin. Change these in a production system!

IXSI Configuration

BikeMan implements IXSI, which uses WebSocket connections. The database table ixsi_client_system with columns system_id and ip_address should contain entries for IXSI client systems that are allowed to connect to BikeMan.

  • ip_address is the IP address of the IXSI client system from which the WebSocket connection attempt is made.
  • system_id corresponds to the SystemID element in IXSI XML messages. XML messages should contain the same SystemID value as the value in the database.

The relative path for WebSocket connections is /ws. For example, the complete path can look like ws://localhost:8080/ws.

You can monitor open IXSI connections via http://localhost:8080/#/monitor (Administration > IXSI monitor at the right upper corner of the web interface).