Skip to content

Commit 1dc5539

Browse files
committed
FINERACT-2383: Modernize and correct README page
1 parent c9a7fd2 commit 1dc5539

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ TABLE OF CONTENTS
2222
- [How to run for production](#how-to-run-for-production)
2323
- [How to build the JAR file](#how-to-build-the-jar-file)
2424
- [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)
2626
- [How to run on Kubernetes](#how-to-run-on-kubernetes)
2727
- [General Clusters](#general-clusters)
2828
- [Using Minikube](#using-minikube)
@@ -34,10 +34,10 @@ TABLE OF CONTENTS
3434
- [How to download Gradle wrapper](#how-to-download-gradle-wrapper)
3535
- [How to run Apache RAT (Release Audit Tool)](#how-to-run-apache-rat-release-audit-tool)
3636
- [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)
3838
- [Kafka](#kafka)
3939
- [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)
4141
- [Connection Pool Configuration](#connection-pool-configuration)
4242
- [Checkstyle and Spotless](#checkstyle-and-spotless)
4343
- [Code Coverage Reports](#code-coverage-reports)
@@ -62,7 +62,6 @@ For the developer wiki, see [Contributor's Zone](https://cwiki.apache.org/conflu
6262
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.
6363

6464

65-
6665
REQUIREMENTS
6766
============
6867
* min. 16GB RAM and 8 core CPU
@@ -71,6 +70,7 @@ REQUIREMENTS
7170

7271
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.
7372

73+
7474
SECURITY
7575
============
7676
If you believe you have found a security vulnerability, [let us know privately](https://fineract.apache.org/#contribute).
@@ -113,7 +113,7 @@ curl --location \
113113

114114
How to run for production
115115
---
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.
117117

118118

119119
How to build the JAR file
@@ -151,8 +151,6 @@ The WAR will be created in the `fineract-war/build/libs` directory. Afterwards d
151151
We recommend using the JAR instead of the WAR file deployment, because it's much easier.
152152

153153

154-
<a id="instructions-to-run-using-docker-or-podman"></a>
155-
156154
How to run using Docker or Podman
157155
---
158156

@@ -454,9 +452,10 @@ and stop and destroy it like this:
454452

455453
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.
456454

457-
If you use MySQL or MariaDB
455+
456+
MySQL/MariaDB and UTC timezone
458457
---
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:
460459

461460
```
462461
serverTimezone=UTC&useLegacyDatetimeCode=false&sessionVariables=time_zone='-00:00'
@@ -476,7 +475,7 @@ Example scenario: If the Fineract instance runs in timezone: GMT+2, and the loca
476475

477476
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.
478477

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.
480479

481480

482481
CONNECTION POOL CONFIGURATION

0 commit comments

Comments
 (0)