Usage and Integration [Work in progress]

TODO - item available for contribution

0.General configuration

In order to work correctly you need to tell oxalis what configuration should be used. There are three things that need to be done :

0.1. Create configuration files

-oxalis.conf

-oxalis-logback.xml

0.2 Create a keystore

Besides those two files you need a keystore(jks) in which your peppol certificate is present. This is described in : https://github.com/OxalisCommunity/oxalis/blob/master/doc/keystore.adoc

0.3 Set environment variable

Create an Oxalis home directory in which you place files that do not change between new releases of Oxalis. We recommend that you name the Oxalis home directory .oxalis in what is considered the home directory of the user running Oxalis. If you are using Tomcat, it should be the home directory of the tomcat user. Remember to set the $OXALIS_HOME environment variable referencing your Oxalis home directory in your shell startup script. Example: export OXALIS_HOME=~/.oxalis

After doing this there are several ways Oxalis could be used :

1. Oxalis running on Tomcat application server (Incoming)

This is a common used option, the oxalis.war is run on Tomcat application server.

Basic setup for this is described in : https://github.com/OxalisCommunity/oxalis/blob/master/doc/installation.md

The AS4 extention andhow to implement this is described in the following document : https://github.com/OxalisCommunity/Oxalis-AS4/blob/master/docs/installation/tomcat.md

COMMON ISSUES TO BE DOCUMENTED

2. Oxalis running as a docker image (Incoming)

Docker images can be found at https://hub.docker.com/r/norstella/oxalis/tags

You can run the image via the following command :

docker run --rm -id -v "/somelocation:/oxalis/conf" -v "/somelocation/ext:/oxalis/ext" -v "/somelocation/plugin:/oxalis/plugin" -v "/somelocation/outbound:/oxalis/outbound" -v "/somelocation/inbound:/oxalis/inbound" --name "yourcontainername" -p 8080:8080 norstella/oxalis:latest

Please be sure to provide the correct volume and port mappings

COMMON ISSUES TO BE DOCUMENTED

3. Oxalis run as standalone server/Jetty (Incoming)

Oxalis can be used as as standalone item with integrated webserver.

The easiest way is to download the full server package from Maven : https://search.maven.org/search?q=a:oxalis-server

You can unzip this which results in the following directory structure :

-bin

-conf

-ext

-inbound

-lib

-plugin

Within the bin directory you can start the server with the run.sh or run.bat command In the conf directory you need to define your oxalis.conf as described in : To be further documented

COMMON ISSUES TO BE DOCUMENTED