Installation Instructions

PublishingLab is a webapp that requires the following:

• MySQL Server (5.7 and above)
• MySQL Workbench (6.3 and above)
• GlassFish Server 4.1 (Use Tomcat at your own risk)
• Oracle JDK 7 and higher

Note: Glassfish Server 4.1.1 has a known bug causing the webapp to fail deployment.

Step 1 - Basics

Open MySQL Workbench and establish the required connection to your MySQL server.

Step 2 - Getting started

• Once the connection is established, create a database schema named 'PublishingLab'(case sensitive).
• Select the schema by double clicking the newly created schema, refresh if the schema is not visible.
• Open the menu 'Server' in the top bar of MySQL Workbench and select the option 'Data Import'.
• In the opened window select the option 'Import from Self-Contained file' and select the followingfile
• Select the 'Default target schema' being the newly created schema 'PublishingLab' and confirm if the option 'Dump Structure and Data' is selected.
• You can now start the import.

Step 3 - Modification

PublishingLab uses Hibernate to handle the entities required for the webapp along with using GlassFish for deployment.

Both Hibernate and Glassfish need to know how to acces the database. By default the webapp uses 'root' as both the username and password.

It is highly recommended to change this

There are two files that need to be modified:

• hibernate.cfg.xml
• glassfish-resources.xml

We will start with Hibernate:

• Open the file in your preferred editor.
• Change the property 'hibernate.connection.username' to the username to acces your database.
• Change the property 'hibernate.connection.password' to the password to acces your database.

Now for Glassfish:

• Open the file in your preferred editor.
• Change the property 'User' to the username to acces your database.
• Change the property 'Password' to the password to acces your database.

And that's it. It is now ready for deployment.

Step 4 - Deployment

• Start your GlassFish server and open the GlassFish Admin Panel.

• Once logged into the admin panel select the option 'Deploy an Application'.

• You will require a WAR archive of the webapp if it is not present you can create it by running 'mvn package' in the root directory of the webapp which is the directory where the pom.xml exists.

• Select the packaged WAR file in the location field in the application deployment window.

• Verify that the recognized type is a 'Web Application'.

• Edit the default context root at your own risk, we recommend using the default settings.

• Confirm by pressing ok

• You will now see a list of deployed applications, find the one you deployed just now and select the action launch.

• If a popup comes up allowing you to choose between an HTTP or HTTPS connection use HTTP the webapp by default is not configured for HTTPS.

And that is it once launched you should be able to view the webapp and login with any of the users in the database all user passwords are '1234'.

Deleting or altering these users is highly recommended