Quick Access Bookmark

Installation

Quick Access Bookmark requires Tomcat 8, Java 8, and MySQL 5.x to run. The following instructions assume that:

• You have Tomcat 8 installed on your host/server
• You have Java 8 installed on your host/server
• You have MySQL 5.x running on your host/server
• You have a MySQL user with sufficient privileges to create a new database or you created an empty schema called QUICK_ACCESS_BOOKMARK

Build From Source Instructions

• Clone the project from https://github.com/MetroState-Cougars/QuickAccessBookmark.git
• Edit application.yaml in the project to add your MySQL username and password
• Build the app with the Maven command mvn package
• Add $PROJECT_PATH/target/quickAccessBookmark.war to the $TOMCAT_HOME/webapps directory on your Tomcat server
• Navigate to $TOMCAT_HOME/bin and run the command ./startup.sh to start the server
• At first run the application will create and/or initialize the database.
• The default username is admin and the default password is password

No-Build Instructions

• Add $PROJECT_PATH/target/quickAccessBookmark.war to the $TOMCAT_HOME/webapps directory on your Tomcat server
• Create a file on the server and name it quickAccessBookmark.yaml
• The file contents of quickAccessBookmark.yaml should look like the following, only updated with your db connection info
• Edit the setenv.sh file in $TOMCAT_HOME/bin and add -Dspring.config.location=/path/to/quickAccessBookmark.yaml to the JAVA_OPTS list
• Navigate to $TOMCAT_HOME/bin and run the command ./startup.sh to start the server
• At first run the application will create and/or initialize the database.
• The default username is admin and the default password is password

quickAccessBookmark.yaml example

spring.datasource:
    url: jdbc:mysql://address=(protocol=tcp)(host=localhost)(port=3306)/QUICK_ACCESS_BOOKMARK?verifyServerCertificate=false&useSSL=false&requireSSL=false&createDatabaseIfNotExist=true
    username: DB_USERNAME
    password: DB_PASSWORD

These instructions may not work for your particular environment. This is simply a basic installation guideline. It is possible to create the database yourself in advance and create a MySQL user with restricted privileges for security purposes (recommended!). You'll need to be familiar with JDBC connection strings and MySQL to perform this type of (advanced) installation.