base on Apache Fineract # Apache Fineract <!-- TODO Reactivate when there is a working CI-CD instance: [](https://validator.swagger.io/validator/debug?url=https://sandbox.mifos.community/fineract-provider/swagger-ui/fineract.yaml) --> [](https://github.com/apache/fineract/actions/workflows/build-mariadb.yml) [](https://hub.docker.com/r/apache/fineract) [](https://github.com/apache/fineract/actions/workflows/publish-dockerhub.yml) [](https://sonarcloud.io/summary/new_code?id=apache_fineract) Apache Fineract is an open-source core banking platform providing a flexible, extensible foundation for a wide range of financial services. By making robust banking technology openly available, it lowers barriers for institutions and innovators to reach underserved and unbanked populations. Have a look at the [documentation](https://fineract.apache.org/docs/current), the [wiki](https://cwiki.apache.org/confluence/display/FINERACT) or at the [FAQ](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=91554327), if this README does not answer what you are looking for. COMMUNITY ========= If you are interested in contributing to this project, but perhaps don't quite know how and where to get started, please [join our developer mailing list](http://fineract.apache.org/#contribute), listen into our conversations, chime into threads, or just send us a "Hello!" introduction email; we're a friendly bunch, and look forward to hearing from you. A more informal alternative is the [Fineract Slack channel](https://app.slack.com/client/T0F5GHE8Y/C028634A61L) (thank you, Mifos, for supporting the Slack channel!). For the developer wiki, see [Contributor's Zone](https://cwiki.apache.org/confluence/display/FINERACT/Contributor%27s+Zone). Maybe [these how-to articles](https://cwiki.apache.org/confluence/display/FINERACT/How-to+articles) help you to get started. In any case visit [our JIRA Dashboard](https://issues.apache.org/jira/secure/Dashboard.jspa?selectPageId=12335824) to find issues to work on, see what others are doing, or open new issues. In the moment you get started writing code, please consult our [CONTRIBUTING](CONTRIBUTING.md) guidelines, where you will find more information on subjects like coding style, testing and pull requests. REQUIREMENTS ============ * min. 16GB RAM and 8 core CPU * `MariaDB >= 11.5.2` or `PostgreSQL >= 17.0` * `Java >= 21` (Azul Zulu JVM is tested by our CI on GitHub Actions) Tomcat (min. v10) is only required, if you wish to deploy the Fineract WAR to a separate external servlet container. You do not need to install Tomcat to run Fineract. We recommend the use of the self-contained JAR, which transparently embeds a servlet container using Spring Boot. SECURITY ============ For a list of known vulnerabilities, see [Apache Fineract Security Reports](https://fineract.apache.org/security.html). If you believe you have found a new vulnerability, [let us know privately](https://fineract.apache.org/#contribute). For details about security during development and deployment, see the documentation [here](https://fineract.apache.org/docs/current/#_security). INSTRUCTIONS ============ The following how-to's assume you have Java installed, you cloned the repository (or downloaded and extracted a [specific version](https://github.com/apache/fineract/releases)) and you have a [database server](#database-and-tables) (MariaDB or PostgreSQL) running. How to run for local development --- Run the following commands in this order: ```bash ./gradlew createDB -PdbName=fineract_tenants ./gradlew createDB -PdbName=fineract_default ./gradlew devRun ``` This creates two databases and builds and runs Fineract, which will be listening for API requests on port 8443 (by default) now. Confirm Fineract is ready with, for example: ```bash curl --insecure https://localhost:8443/fineract-provider/actuator/health ``` To test authenticated endpoints, include credentials in your request: ```bash curl --location \ https://localhost:8443/fineract-provider/api/v1/clients \ --header 'Content-Type: application/json' \ --header 'Fineract-Platform-TenantId: default' \ --header 'Authorization: Basic bWlmb3M6cGFzc3dvcmQ=' ``` How to run for production --- Running Fineract to try it out is relatively easy. If you intend to use it in a production environment, be aware that a proper deployment can be complex, costly, and time-consuming. Considerations include: Security, privacy, compliance, performance, service availability, backups, and more. The Fineract project does not provide a comprehensive guide for deploying Fineract in production. You might need skills in enterprise Java applications and more. Alternatively, you could pay a vendor for Fineract deployment and maintenance. You will find tips and tricks for deploying and securing Fineract in our official documentation and in the community-maintained wiki. How to build the JAR file --- Build a modern, cloud native, fully self contained JAR file: ```bash ./gradlew clean bootJar ``` The JAR will be created in the `fineract-provider/build/libs` directory. As we are not allowed to include a JDBC driver in the built JAR, download a JDBC driver of your choice. For example: ```bash wget https://dlm.mariadb.com/4174416/Connectors/java/connector-java-3.5.2/mariadb-java-client-3.5.2.jar ``` Start the JAR and specify the directory containing the JDBC driver using the loader.path option, for example: ```bash java -Dloader.path=. -jar fineract-provider/build/libs/fineract-provider.jar ``` This does not require an external Tomcat. The tenants database connection details are configured [via environment variables (as with Docker container)](#instructions-to-run-using-docker-or-podman), e.g. like this: ```bash export FINERACT_HIKARI_PASSWORD=verysecret ... java -jar fineract-provider.jar ``` How to build the WAR file --- Build a traditional WAR file: ```bash ./gradlew :fineract-war:clean :fineract-war:war ``` The WAR will be created in the `fineract-war/build/libs` directory. Afterwards deploy the WAR to your Tomcat Servlet Container. We recommend using the JAR instead of the WAR file deployment, because it's much easier. How to run using Docker or Podman --- It is possible to do a 'one-touch' installation of Fineract using containers (AKA "Docker"). This includes the database running in the container. As prerequisites, you must have `docker` and `docker-compose` installed on your machine; see [Docker Install](https://docs.docker.com/install/) and [Docker Compose Install](https://docs.docker.com/compose/install/). Alternatively, you can also use [Podman](https://github.com/containers/libpod) (e.g. via `dnf install podman-docker`), and [Podman Compose](https://github.com/containers/podman-compose/) (e.g. via `pip3 install podman-compose`) instead of Docker. To run a new Fineract instance on Linux you can simply: ```bash git clone https://github.com/apache/fineract.git cd fineract ./gradlew :fineract-provider:jibDockerBuild -x test ``` On Windows, do this instead: ```cmd git clone https://github.com/apache/fineract.git --config core.autocrlf=input cd fineract gradlew :fineract-provider:jibDockerBuild -x test ``` Install the Loki log driver and start: ```bash docker plugin install grafana/loki-docker-driver:latest \ --alias loki --grant-all-permissions docker compose -f docker-compose-development.yml up -d ``` The Fineract (back-end) should be running at https://localhost:8443/fineract-provider/ now. Wait for https://localhost:8443/fineract-provider/actuator/health to return `{"status":"UP"}`. You must go to https://localhost:8443 and remember to accept the self-signed SSL certificate of the API once in your browser. [Docker Hub](https://hub.docker.com/r/apache/fineract) has a pre-built container image of this project, built continuously. You must specify the MySQL tenants database JDBC URL by passing it to the `fineract` container via environment variables; please consult the [`docker-compose.yml`](docker-compose.yml) for exact details how to specify those. The logfiles and the Java Flight Recorder output are available in `PROJECT_ROOT/build/fineract/logs`. If you use IntelliJ then you can double-click on the `.jfr` file and open it with the IDE. You can also download [Azul Mission Control](https://www.azul.com/products/components/azul-mission-control/) to analyze the Java Flight Recorder file. NOTE: If you have issues with the file permissions and Docker Compose then you might need to change the variable values for `FINERACT_USER` and `FINERACT_GROUP` in `PROJECT_ROOT/config/docker/env/fineract-common.env`. You can find out what values you need to put there with the following commands: ```bash id -u ${USER} id -g ${GROUP} ``` Please make sure that you are not checking in your changed values. The defaults should work for most people. How to run on Kubernetes --- ### General Clusters You can also run Fineract using containers on a Kubernetes cluster. Make sure you set up and connect to your Kubernetes cluster. You can follow [this](https://cwiki.apache.org/confluence/display/FINERACT/Install+and+configure+kubectl+and+Google+Cloud+SDK+on+ubuntu+16.04) guide to set up a Kubernetes cluster on GKE. Make sure to replace `apache-fineract-cn` with `apache-fineract` Now e.g. from your Google Cloud shell, run the following commands: ```bash git clone https://github.com/apache/fineract.git cd fineract/kubernetes ./kubectl-startup.sh ``` To shutdown and reset your Cluster, run: ```bash ./kubectl-shutdown.sh ``` ### Using Minikube Alternatively, you can run fineract on a local kubernetes cluster using [minikube](https://minikube.sigs.k8s.io/docs/). As prerequisite you must have `minikube` and `kubectl` installed on your machine; see [Minikube & Kubectl install](https://kubernetes.io/docs/tasks/tools/install-minikube/). To run a new Fineract instance on Minikube you can simply: ```bash git clone https://github.com/apache/fineract.git cd fineract/kubernetes minikube start ./kubectl-startup.sh ``` Wait for all pods to be ready: ```bash kubectl get pods -w ``` Once all pods are running, access the Mifos web application: ```bash minikube service mifos-community ``` This opens the Mifos X web application in your browser. The nginx reverse proxy in the mifos-community pod forwards API requests to the fineract-server backend. **Default credentials:** - Username: `mifos` - Password: `password` You can also access the Fineract API directly: ```bash minikube service fineract-server --url --https ``` Fineract is now running at the printed URL, which you can check e.g. using: ```bash http --verify=no --timeout 240 --check-status get $(minikube service fineract-server --url --https)/fineract-provider/actuator/health ``` To check the status of your containers on your local minikube Kubernetes cluster, run: ```bash minikube dashboard ``` You can check Fineract logs using: ```bash kubectl logs deployment/fineract-server ``` You can check Mifos web app logs using: ```bash kubectl logs deployment/mifos-community ``` To shutdown and reset your cluster, run: ```bash ./kubectl-shutdown.sh ``` How to enable External Message Broker (ActiveMQ or Apache Kafka) --- There are two use-cases where external message broker is needed: - External Business Events / Reliable Event Framework - Executing Partitioned Spring Batch Jobs External Events are business events, e.g.: `ClientCreated`, which might be important for third party systems. Apache Fineract supports ActiveMQ (or other JMS compliant brokers) and Apache Kafka endpoints for sending out Business Events. By default, they are not emitted. In case of a large deployment with millions of accounts, the Close of Business Day Spring Batch job may run several hours. In order to speed up this task, remote partitioning of the job is supported. The Manager node partitions breaks up the COB job into smaller pieces (sub tasks), which then can be executed on multiple Worker nodes in parallel. The worker nodes are notified either by ActiveMQ or Kafka regarding their new sub tasks. ### ActiveMQ JMS based messaging is disabled by default. In `docker-compose-postgresql-activemq.yml` an example is shown, where ActiveMQ is enabled. In that configuration one Spring Batch Manager instance and two Spring Batch Worker instances are created. Spring based events should be disabled and jms based event handling should be enabled. Furthermore, proper broker JMS URL should be configured. ``` FINERACT_REMOTE_JOB_MESSAGE_HANDLER_JMS_ENABLED=true FINERACT_REMOTE_JOB_MESSAGE_HANDLER_SPRING_EVENTS_ENABLED=false FINERACT_REMOTE_JOB_MESSAGE_HANDLER_JMS_BROKER_URL=tcp://activemq:61616 ``` For additional ActiveMQ related configuration please take a look to the `application.properties` where the supported configuration parameters are listed with their default values. ### Kafka Kafka support is also disabled by default. In `docker-compose-postgresql-kafka.yml` an example is shown, where self-hosted Kafka is enabled for both External Events and Spring Batch Remote Job execution. During the development Fineract was tested with PLAINTEXT Kafka brokers without authentication and with AWS MSK using IAM authentication. The extra [JAR file](https://github.com/aws/aws-msk-iam-auth/releases) required for IAM authentication is already added to the classpath. An example MSK setup can be found in `docker-compose-postgresql-kafka-msk.yml`. The full list of supported Kafka related properties is documented in the [Fineract Platform documentation](https://fineract.apache.org/docs/current/). DATABASE AND TABLES =================== You can run the required version of the database server in a container, instead of having to install it, like this: docker run --name mariadb-11.5 -p 3306:3306 -e MARIADB_ROOT_PASSWORD=mysql -d mariadb:11.5.2 and stop and destroy it like this: docker rm -f mariadb-11.5 Beware that this container database keeps its state inside the container and not on the host filesystem. It is lost when you destroy (rm) this container. This is typically fine for development. See [Caveats: Where to Store Data on the database container documentation](https://hub.docker.com/_/mariadb) regarding how to make it persistent instead of ephemeral. MySQL/MariaDB and UTC timezone --- With release `1.8.0` we introduced improved date time handling in Fineract. Date time is stored in UTC, and UTC timezone enforced even on the JDBC driver, e. g. for MySQL: ``` serverTimezone=UTC&useLegacyDatetimeCode=false&sessionVariables=time_zone='-00:00' ``` If you use MySQL as Fineract database, the following configuration is highly recommended: * Run the application in UTC (the default command line in our Docker image has the necessary parameters already set) * Run the MySQL database server in UTC (if you use managed services like AWS RDS, then this should be the default anyway, but it would be good to double-check) In case Fineract and MySQL do not run in UTC, MySQL might save date time values differently from PostgreSQL Example scenario: If the Fineract instance runs in timezone: GMT+2, and the local date time is 2022-08-11 17:15 ... * ... then PostgreSQL saves the LocalDateTime as is: 2022-08-11 17:15 * ... and MySQL saves the LocalDateTime in UTC: 2022-08-11 15:15 * ... but when we read the date time from PostgreSQL or from MySQL, both systems give us the same value: 2022-08-11 17:15 GMT+2 If a previously used Fineract instance didn't run in UTC (backward compatibility), all prior dates will be read wrongly by MySQL. This can cause issues, when you run the database migration scripts. Recommendation: Shift all dates in your database by the timezone offset that your Fineract instance used. CONNECTION POOL CONFIGURATION ======= Please check `application.properties` to see which connection pool settings can be tweaked. The associated environment variables are prefixed with `FINERACT_HIKARI_*`. You can find more information about specific connection pool settings at the [HikariCP Github repository](https://github.com/brettwooldridge/HikariCP?tab=readme-ov-file#gear-configuration-knobs-baby). NOTE: We keep backwards compatibility until one of the next releases to ensure that things are working as expected. Environment variables prefixed `fineract_tenants_*` can still be used to configure the database connection, but we strongly encourage using `FINERACT_HIKARI_*` with more options. VERSIONS ============ A release version is derived from source control. The version will include `-SNAPSHOT` unless the current branch looks like a release or release maintenance branch. See `gitVersioning` settings in `build.gradle` for details. The latest stable release can be viewed on the develop branch: [Latest Release on Develop](https://github.com/apache/fineract/tree/develop "Latest Release"). The progress of this project can be viewed in the left hand navigation under [this page of the wiki](https://cwiki.apache.org/confluence/display/FINERACT/Fineract+Releases) LICENSE ============ This project is licensed under [Apache License Version 2.0](https://github.com/apache/fineract/blob/develop/APACHE_LICENSETEXT.md). The Connector/J JDBC Driver client library from [MariaDB](https://www.mariadb.org) is licensed under the LGPL. The library is often used in development when running integration tests that use the Liquibase library. That JDBC driver is however not distributed with the Fineract product and is not required to use the product. If you are a developer and object to using the LGPL licensed Connector/J JDBC driver, simply do not run the integration tests that use the Liquibase library and use another JDBC driver. As discussed in [LEGAL-462](https://issues.apache.org/jira/browse/LEGAL-462), this project therefore complies with the [Apache Software Foundation third-party license policy](https://www.apache.org/legal/resolved.html). PLATFORM API ============ Fineract does not provide a UI, but provides an API. Running Fineract locally, the Swagger documentation can be accessed under `https://localhost:8443/fineract-provider/swagger-ui/index.html`. A live version can be accessed via [this Sandbox](https://sandbox.mifos.community/fineract-provider/swagger-ui/index.html) (not hosted by us). Apache Fineract supports client code generation using [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) based on the [OpenAPI Specification](https://swagger.io/specification/). For more instructions on how to generate client code, check [this section](https://fineract.apache.org/docs/current/#_generate_api_client) of the Fineract documentation. [This video](https://www.youtube.com/watch?v=FlVd-0YAo6c) documents the use of the Swagger-UI. ", Assign "at most 3 tags" to the expected json: {"id":"1929","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"