You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fineract.apache.org by al...@apache.org on 2021/03/09 02:08:06 UTC

[fineract] branch develop updated: Document new plugins feature (FINERACT-1177)

This is an automated email from the ASF dual-hosted git repository.

aleks pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/fineract.git


The following commit(s) were added to refs/heads/develop by this push:
     new 9a21ac2  Document new plugins feature (FINERACT-1177)
9a21ac2 is described below

commit 9a21ac21db33ba1b046aa27c0d3fdfb8dd8d5d94
Author: Michael Vorburger <mi...@vorburger.ch>
AuthorDate: Mon Mar 8 23:04:13 2021 +0100

    Document new plugins feature (FINERACT-1177)
---
 fineract-doc/src/docs/en/deployment.adoc | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/fineract-doc/src/docs/en/deployment.adoc b/fineract-doc/src/docs/en/deployment.adoc
index 3cc6a0f..c5386f5 100644
--- a/fineract-doc/src/docs/en/deployment.adoc
+++ b/fineract-doc/src/docs/en/deployment.adoc
@@ -1,5 +1,23 @@
 == Deployment
 
+=== Plugins
+
+Apache Fineract is extensible through plugin JARs (https://issues.apache.org/jira/browse/FINERACT-1177[FINERACT-1177]; based on 
+https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-executable-jar-format.html[Spring Boot's support]). To launch Fineract with plugin JARs in `libs/*.jar`, use:
+
+----
+java -Dloader.path=libs/ -jar fineract-provider.jar
+----
+
+The Fineract "Docker" container image's `ENTRYPOINT` uses this, see our `Dockerfile`. You could therefore build your customized Fineract distribution container image with your own `Dockerfile` using e.g. `FROM apache/fineract:latest` and then drop some plugin JARs into `/app/libs/`.
+
+The WAR distribution does not directly support such plugins, but one could "explode" the WAR and drop JARs into `WEB-INF/lib`; if you know what you are doing, and feel nostalgic of the 1990s still using WARs, instead of the recommended modern Spring Boot distribution.
+
+Here is a list of known 3rd-party plugin projects which can be dropped into `libs/`:
+
+* https://github.com/vorburger/fineract-pentaho
+
+
 === HTTPS
 
 Because Apache Fineract deals with customer sensitive personally identifiable information (PII), it very strongly encourages all developers, implementors and end-users to always only use HTTPS. This is why it does not run on HTTP even for local development and enforces use of HTTPS.