INSTALL.txt

   1 Installation instructions:
   2 ==========================
   3
   4 0) Make sure to have Payara 4.1.2.181 installed AND have javax.faces.jar
   5    REPLACED with version 2.3.9 (2.4.0 seem to be a little to new) as the WAR
   6    project requires JSF 2.3 (not JSF 2.2). Paraya is currently required as a
   7    @NamedCache annotation alongside @Inject is being used to inject the cache
   8    into the backing bean.
   9
  10    The server.log should reveal a line with "Initializing Mojarra 2.3.9". If
  11    that is the case, it SHOULD work.
  12
  13    A common mistake is to copy the required JARs not to ~/personal_domain/lib/
  14    (or where ever your domain's lib path is) as the required JARs varies from
  15    EJB/WAR project. The easiest but single-host deployment is to build the EAR
  16    project by doing a "ant dist" in THIS project's root directory.
  17
  18    For the EJB projects, any EJB 3.0/JPA 2.2 container SHOULD work, Payara 4.1
  19    has been tested/used by myself.
  20
  21 1) Create an empty database and setup proper permissions and user account. You
  22    should create a separate database and user for each project you are going to
  23    run on it for maximum security.
  24
  25 2) Setup a JDBC pool. This is an example for a MariaDB JDBC driver, a SQLite3
  26    database resource works surely differently (other URL, user/password can be
  27    anything non-empty). I would recommend SQLite3 for development (up to 1 mio.
  28    records with almost no performance drop) and MariaDB/PostreSQL (later not
  29    tested by myself) or any other DBMS (including MongoDB) as this project only
  30    uses the javax.persistence package and not EclipseLink/Hibernate/DataNucleus
  31    specific packages.
  32
  33 Pool name: JJobsPool
  34 Resource type: java.sql.Driver
  35 Driver: MariaDB
  36 Driver class: org.mariadb.jdbc.Driver
  37
  38 URL: jdbc:mariadb://localhost/your_database
  39 user: your_login
  40 password: your_password
  41
  42 3) Setup a JDBC resource:
  43
  44 JNDI name: jdbc/jjobs
  45 Pool name: JJobsPool
  46
  47 4) In juser-core project you will find a JAR named "commons-codec-1.10.jar" you
  48    need to copy this to your $GLASSFISH_DOMAIN/lib/ path to make password
  49    encryption working. Please setup sufficient access rights (CHMOD 0644 is
  50    enough).
  51
  52    If you forgot this file to copy and you have copied it now, please restart
  53    the Glassfish server so the JAR can be found and loaded.
  54
  55 5) Setup a JMS connection factory:
  56
  57 JNDI name: jms/jjobs-queue-factory
  58 Resource type: javax.jms.QueueConnectionFactory
  59
  60 6) Setup JMS message queue:
  61
  62 JNDI name: jms/jjobs-email-queue
  63 Physical destination name: jjobsSendEmail
  64 Resource type: javax.jms.Queue
  65
  66 7) Setup Java Mail session:
  67
  68 JNDI name: jjobsSmtpSession
  69 Mail host: <your-smtp-host>
  70 Default user: <your-smtp-login-name>
  71 Default sender address: noreply@your-domain.example
  72
  73 Optional, but more secure/sometimes required advanced properties:
  74
  75 mail.smtp.password : <email password>
  76 mail.smtp.port : <email port>
  77 mail.smtp.auth : true
  78
  79 8) Setup JMS message queue
  80
  81 JNDI name: jms/jjobs-user-activity-log
  82 Physical destination name: jjobsUserActivityLog
  83 Resource type: javax.jms.Queue
  84
  85 9) In WAR project, copy local_xx_XX.properties-dist to local_de_DE.properties
  86    and local_en_US.properties. If for example your application uses
  87    product_categories from jproduct-core, you may want to add your custom i18n
  88    strings to the local properties files as this doesn't cause any later merge
  89    conflicts as they are ignored by default.