Boomi Flow S3 Service

This service allows you to work with files in your Boomi Flow app, backed by an S3 compatible storage provider.

Running

Heroku

The service is compatible with Heroku, and can be deployed by clicking the button below, which also handles any required configuration.

Locally

The service is a JAX-RS application, that by default runs on port 8080 (if you use the packaged JAR). To configure and build the service, you will need to have Apache Ant, Maven 3 and JDK 8+ installed.

Building

Once any configuration is complete, you can build the runnable shaded JAR:

$ mvn clean package

Defaults

Running the following command will start the service listening on 0.0.0.0:8080/api/s3/1:

$ java -jar target/service-s3.jar

Custom Port

You can specify a custom port to run the service on by passing the server.port property when running the JAR. The following command will start the service listening on port 9090 (0.0.0.0:9090/api/s3/1):

$ java -Dserver.port=9090 -jar target/service-s3.jar

Contributing

Contributions are welcome to the project - whether they are feature requests, improvements or bug fixes! Refer to CONTRIBUTING.md for our contribution requirements.

License

This service is released under the MIT License.