Please cherry-pick:

- added note that you MUST use Payara 4.1.2.181 so far as there is a JAR
  dependency (@NamedCache) required for the WAR project. For EJB projects
  other EJB container (e.g. Wildfly) SHOULD work.

Signed-off-by: Roland Häder <roland@mxchange.org>

diff --git a/INSTALL.txt b/INSTALL.txt
index 8ddaafe5b1a27056c1d1a6a307c55a3a445e9c5b..6b7c6290cf8dceff376ddac6821a8ba176f5a7f0 100644 (file)
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -1,18 +1,41 @@
 Installation instructions:
 ==========================
 
+0) Make sure to have Payara 4.1.2.181 installed AND have javax.faces.jar
+   REPLACED with version 2.3.9 (2.4.0 seem to be a little to new) as the WAR
+   project requires JSF 2.3 (not JSF 2.2). Paraya is currently required as a
+   @NamedCache annotation alongside @Inject is being used to inject the cache
+   into the backing bean.
+
+   The server.log should reveal a line with "Initializing Mojarra 2.3.9". If
+   that is the case, it SHOULD work.
+
+   A common mistake is to copy the required JARs not to ~/personal_domain/lib/
+   (or where ever your domain's lib path is) as the required JARs varies from
+   EJB/WAR project. The easiest but single-host deployment is to build the EAR
+   project by doing a "ant dist" in THIS project's root directory.
+
+   For the EJB projects, any EJB 3.0/JPA 2.2 container SHOULD work, Payara 4.1
+   has been tested/used by myself.
+
 1) Create an empty database and setup proper permissions and user account. You
    should create a separate database and user for each project you are going to
    run on it for maximum security.
 
-2) Setup a JDBC pool. I took the simple driver:
+2) Setup a JDBC pool. This is an example for a MariaDB JDBC driver, a SQLite3
+   database resource works surely differently (other URL, user/password can be
+   anything non-empty). I would recommend SQLite3 for development (up to 1 mio.
+   records with almost no performance drop) and MariaDB/PostreSQL (later not
+   tested by myself) or any other DBMS (including MongoDB) as this project only
+   uses the javax.persistence package and not EclipseLink/Hibernate/DataNucleus
+   specific packages.
 
 Pool name: JFinancialsPool
 Resource type: java.sql.Driver
 Driver: MariaDB
 Driver class: org.mariadb.jdbc.Driver
 
-URL: jdbc:mysql://localhost/your_database
+URL: jdbc:mariadb://localhost/your_database
 user: your_login
 password: your_password