Repository files navigation

The goal of IRIS is to create a centralized and transparent database for distance calculations in short-haul goods transport.IRIS aims to provide such a platform, for both clients and service providers.

IRIS is used to calculate truckings for transports from a hinterland terminal to the place of loading and the other way around.The place of loading can be set very detailed by adjusting its coordinates.IRIS uses these coordinates to calculate the truck route, distance, toll kilometers and the duration of the trucking.An extension for barge and rail routings is already planned.

Example: A freight container arrives in Mannheim via cargo ship and needs to be transported to 48 Berliner Str., Heidelberg, Germany.After arriving at the Contargo terminal in Mannheim it needs to be loaded on a truck to be transported to its destination.There, the recipient unloads the content and the truck transports the empty container back to the terminal.

• Management of seaports, terminals and connections between them (GUI)
• Automatic creation of truck and barge routes between seaports, terminals and destinations (GUI & REST-API)
• Provision of detailed information for each route like distance, toll distance, duration, CO2 output (REST-API)
• Support for different container sizes and states (REST-API)
• Open Street Map Address resolution for destination points (GUI & REST-API)
• Management and resolution of custom static addresses as destination points (GUI & REST-API)
• Possibility to implement any authentication mechanism via Spring Security

Further documentation about the IRIS-terminology can be found here:terminology.If you are interested to use IRIS in Switzerland read this:ASTAG

• MariaDb 5.5 or higher
• Maven 3 or higher
• JDK 8 or higher

Simply clone this repository

$ git clone https://github.com/Contargo/iris.git

Configuration is located insrc/main/resources/

The "general" configuration file issrc/main/resources/application.properties

Environment (System) specific configurations go tosrc/main/resources/application-<envname>.properties

The environment-specific (e.g.application-dev.properties) file overrides and adds to properties defined in the "general" properties-file (application.properties). Not overridden properties ofapplication.properties remain valid.

Default Environment is "dev" (soapplication-dev.properties is loaded by default). Environments can be set using System-Property "environment"

mvn jetty:run -Denvironment=myenv# -> leads to use application-myenv.properties

or environment-parameter environment:

export environment=superdevmvn jetty:run# -> leads to use application-superdev.properties

All database connection settings are configured inapplication-<envname>.properties. Adapt the corresponding properties to match your MariaDb database connection settings.

All needed database tables are created on application start usingLiquibase.

There are two different roles defined in IRIS:

• ROLE_ADMIN
  • can do anything
• ROLE_USER
  • no GUI access
  • limited REST Api access

User Credentials are located insrc/main/resources/usercredentials-<envname>.properties.

For development IRIS ships with two predefined users:

• admin@example.com with password admin: ROLE_ADMIN
• user@example.com with password user: ROLE_USER

These are located insrc/main/resources/usercredentials-dev.properties.

To add own user credentials do the following:

$echo -n"yourpassword"| sha256sume3c652f0ba0b4801205814f8b6bc49672c4c74e25b497770bb89b22cdeb4e951  -

Edit the filesrc/main/resources/usercredentials-<envname>.properties and add your user like this:

youruser@example.com=e3c652f0ba0b4801205814f8b6bc49672c4c74e25b497770bb89b22cdeb4e951,ROLE_USER,enabled

You can specify login, password, role and set the enabled flag.

Logging in IRIS uses Logback.

The default logback configuration is located insrc/main/resources/logback.xml. It configures a console appender and a rolling file appender. The log file is located inlogs/iris.log.

Additionally, there is another logback configuration suited for production use located insrc/main/resources/logback-prod.xml. It can be activated using thelogback.configuration.file property. This logging configuration does not include the console appender. An extra GELF appender can be activated by providing the propertygraylog.server that points to your graylog host.

In order to build the application you need Maven 3 and Oracle JDK 7. You also need your MariaDb database set up as described above. You can then start the local web server:

$ ./mvnw jetty:run

You can run a full build including all tests with

$ ./mvnw clean install

Finally, point your browser to the urlhttp://localhost:8082/. IRIS has both a basic user interface and a JSON API. Documentation for the API is located athttp://localhost:8082/api/docs.html.

If you want to contribute to IRIS, see ourcontribution guidelines.

IRIS is licensed under the GNU Affero General Public License, Version 3. SeeLICENCE for the full license text.