OxalisCommunity / oxalis

Oxalis - PEPPOL Access Point open source implementation - Core component
Other
119 stars 89 forks source link
edelivery peppol

Oxalis Master Build Maven Central


Oxalis

Oxalis is the leading open-source software implementation of OpenPeppol eDelivery Access Point (AS4) specifications. This repository was originally developed by Steinar Overbeck Cook(SendRegning) and later looked after by the Norwegian agency for Public Management and eGovernment (Difi) until March 2020.

Starting November 2020, Oxalis is being maintained by NorStella Oxalis Community.

Oxalis Community

Oxalis Community is a not-for-profit organization organized under NorStella Foundation based in Norway, dedicated to the continued support and development of Oxalis, to secure Peppol compliance and value for its users.

Oxalis Community is facilitated by the foundation NorStella. It is organized according to democratic non-for-profit principles and established as an independent and autonomous part of the NorStella association with independent budgets.

The goals of Oxalis Community:

Oxalis can be used either as a complete standalone PEPPOL solution or as an API component from your own code. Standalone component (oxalis-standalone) comes with a basic command line tool for sending messages. It persists inbound messages to the filesystem Out of the box. Persistence have been modularized so you can provide your own implementation if you need to send inbound messages to a message queue, a workflow engine, a document archive or others.

Binary distributions is available both at Maven Central and GitHub.

The Latest version is Oxalis 6.x.x

Java 11 is minimum supported Java version since Oxalis 6.0.0. For detailed documentation, refer: main.adoc

Technical Information

The Latest technical news is available at : https://www.oxalis.network/technical-information


Are you Contributor?

We are actively looking for contributors who can contribute to Oxalis and associated Git repositories. You can start fixing issues by selecting any existing issue or you can add new feature. Please refer Pull request Checklist while generating new pull request. Team will review your code, if it will meet desired goal, and will be according to standards and guidelines then it will be merged to master.


Oxalis components

Component Type Description
oxalis-inbound war Inbound access point implementation which runs on Tomcat (1)
oxalis-outbound jar Outbound component for sending PEPPOL business documents (2)
oxalis-standalone main Command line application for sending PEPPOL business documents (3)

(1) Receives messages using AS2 protocol and stores them in the filesystem as default.

(2) Can be incorporated into any system which needs to send PEPPOL documents.

(3) Serves as example code on how to send a business documents using the oxalis-outbound component.

Installation

Troubleshooting

Build from source

Note that the Oxalis "head" revision on master branch is often in "flux" and should be considered a "nightly build". The official releases are tagged and may be downloaded by clicking on Tags.

Securing Oxalis

By default Oxalis publish the web addresss listed in the table below.
The table describes their use and give some hints on how to secure those addresses.
A pretty standard scenario is to use some kind of load balancer and SSL offloader in front of the appserver running Oxalis.
This could be free/open software like Nginx and Apache or commercial software like NetScaler and BigIP.
All such front end software should be able to enforce security like the one suggested below.

URL Function Transport Security
oxalis/as2 AS2 protocol endpoint HTTPS with proper certificates Enable inbound access from Internet
oxalis/status Status information, for internal use and debugging HTTP/HTTPS Internet access can be blocked
oxalis/statistics RAW statistics for DIFI HTTPS with proper certificates Used by DIFI to collect statistics