You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ TABLE OF CONTENTS
22
22
-[How to run for production](#how-to-run-for-production)
23
23
-[How to build the JAR file](#how-to-build-the-jar-file)
24
24
-[How to build the WAR file](#how-to-build-the-war-file)
25
-
-[How to run using Docker or Podman](#instructions-to-run-using-docker-or-podman)
25
+
-[How to run using Docker or Podman](#how-to-run-using-docker-or-podman)
26
26
-[How to run on Kubernetes](#how-to-run-on-kubernetes)
27
27
-[General Clusters](#general-clusters)
28
28
-[Using Minikube](#using-minikube)
@@ -34,10 +34,10 @@ TABLE OF CONTENTS
34
34
-[How to download Gradle wrapper](#how-to-download-gradle-wrapper)
35
35
-[How to run Apache RAT (Release Audit Tool)](#how-to-run-apache-rat-release-audit-tool)
36
36
-[How to enable External Message Broker (ActiveMQ or Apache Kafka)](#how-to-enable-external-message-broker-activemq-or-apache-kafka)
37
-
-[Active MQ](#active-mq)
37
+
-[ActiveMQ](#activemq)
38
38
-[Kafka](#kafka)
39
39
-[Database and Tables](#database-and-tables)
40
-
-[If you use MySQL or MariaDB](#if-you-use-mysql-or-mariadb)
40
+
-[MySQL/MariaDB and UTC timezone](#mysqlmariadb-and-utc-timezone)
41
41
-[Connection Pool Configuration](#connection-pool-configuration)
42
42
-[Checkstyle and Spotless](#checkstyle-and-spotless)
43
43
-[Code Coverage Reports](#code-coverage-reports)
@@ -62,7 +62,6 @@ For the developer wiki, see [Contributor's Zone](https://cwiki.apache.org/conflu
62
62
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.
63
63
64
64
65
-
66
65
REQUIREMENTS
67
66
============
68
67
* min. 16GB RAM and 8 core CPU
@@ -71,6 +70,7 @@ REQUIREMENTS
71
70
72
71
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.
73
72
73
+
74
74
SECURITY
75
75
============
76
76
If you believe you have found a security vulnerability, [let us know privately](https://fineract.apache.org/#contribute).
@@ -113,7 +113,7 @@ curl --location \
113
113
114
114
How to run for production
115
115
---
116
-
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 will need to be skilled in enterprise Java applications and more. Or you can 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.
116
+
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.
117
117
118
118
119
119
How to build the JAR file
@@ -151,8 +151,6 @@ The WAR will be created in the `fineract-war/build/libs` directory. Afterwards d
151
151
We recommend using the JAR instead of the WAR file deployment, because it's much easier.
@@ -454,9 +452,10 @@ and stop and destroy it like this:
454
452
455
453
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.
456
454
457
-
If you use MySQL or MariaDB
455
+
456
+
MySQL/MariaDB and UTC timezone
458
457
---
459
-
With release `1.8.0` we introduced improved date time handling in Fineract. Date time is now stored in UTC, and we enforce UTC timezone even on the JDBC driver, e. g. for MySQL:
458
+
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:
@@ -476,7 +475,7 @@ Example scenario: If the Fineract instance runs in timezone: GMT+2, and the loca
476
475
477
476
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.
478
477
479
-
Recommendation: You need to shift all dates in your database by the timezone offset that your Fineract instance used.
478
+
Recommendation: Shift all dates in your database by the timezone offset that your Fineract instance used.
0 commit comments