Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Let's

...

begin

...

by

...

describing

...

Heroku. Heroku is

...

a

...

cloud

...

application

...

platform

...

a

...

new

...

way

...

of

...

building

...

and

...

deploying

...

web

...

applications (www.heroku.com).

...


This

...

guide

...

provides

...

the

...

steps

...

required

...

for

...

creating

...

a

...

Heroku

...

account,

...

instaling

...

Heroku

...

Toolbelt,

...

 configuring and finally deploying in the Heroku environment.

Create a Heroku account

  1. Go to www.heroku.com and  hit sign up button, add your credentials and hit Create Free Account.
  2. Go to your dashboard to start creating the application environment.  

Installing Heroku toolbelt 

What is it? Heroku client - CLI tool for creating and managing Heroku appsapps 

  1. Go to https://toolbelt.heroku.com
  2. Hit the download button for you OS. 

...

  1. Once you have created your Heroku account you give your credentials after typing in the command line

    Code Block
    languagetext
    $ heroku login 

Install the heroku-deploy plugin 

 This project is a Heroku toolbelt plugin for deploying WAR files. It can also be used to deploy executable JAR files.

...

...

  1. Using the Heroku toolbelt you can write in the command line: 

    Code Block
    languagetext
    $ heroku plugins:install https://github.com/heroku/heroku-deploy
     or using the Heroku toolbelt 
  2. Add the line

     

    export JAVA_OPTS="$JAVA_OPTS -Xms128m -Xmx512m"

Restart Tomcat after the file is edited and saved. You can confirm that Tomcat has picked up the correct settings by running

 

ps aux | grep java

 

and see that the settings for -Xms and -Xmx are as desired.

Database connection

When Tomcat is installed, please refer to Connecting TermWeb to a Database for setting up and configuring the database.

Web application installation

Copy the termweb.war file to <tomcat-install>/webapp . The war file is extracted automatically into <tomcat-install>/webapps/termweb if Tomcat is running.

In the file <tomcat-install>/webapps/termweb/WEB-INF/termweb.properties.sample you will find settings that may have to be adjusted according to your environment. Rename this file to termweb.properties and edit the values for termweb.homebase.url and work.dir values.

Please note

 

Prior to TermWeb v3.15, all changes to termweb.properties requires a restart of TermWeb webapp or Tomcat to take effect.

Logging

Configuration for logging is configured in <tomcat>/webapps/termweb/WEB-INF/log4j.properties. You may need to change the path to the log file (log4j.appender.logfile.file) to make TermWeb write its log file in desired location.

See http://logging.apache.org/log4j for more information about logging configuration options.

Set Environment Variable

Set the TERMWEB_HOME environment variable according to the instructions in Setting TermWeb Home Directory and copy termweb.properties and log4j.properties to the directory specified by the variable.

Installation complete

Start up Tomcat and check the log files for any errors.

Open your browser and enter http://localhost:8080/termweb. TermWeb now asks for a license. Enter the license that you have received from Interverbum Technology.

  1. Check if the heroku-deploy plugin is installed by typing in the command line

    Code Block
    languagebash
    $ heroku plugins

    And if everything is ok you will see: 

    Code Block
    languagebash
    === Installed Plugins
    heroku-deploy

Creating a Heroku application

  1. Create a folder for example termweb-heroku in your local drive.
  2. Go to the command line and navigate to the created folder from the previous step
  3. When you are in the targeted folder type in the command line

    Code Block
    languagetext
    $ heroku create

    You have now created a Dyno, your virtual environment ready for deploying your application. A random name will be assigned by Heroku, for example obscure-peak-95997

Deploying the war file to Heroku

  1. In the folder you have created for your app in this case termweb-heroku you must have the following files: 1. .WAR file 2.Procfile.
  2. Procfile creation details go to: https://devcenter.heroku.com/articles/procfile
  3. As soon as all the required files are in the folder enter the command so as to deploy your code in Heroku:

    Code Block
    languagetext
    $ heroku deploy:war --war <your war file> --app <your heroku app name> 
  4. After the deployment you can now open your application in the browser by typing:

    Code Block
    languagetext
    $ heroku open --app <your heroku app name>

Database creation

You can go to your Heroku dashboard (https://dashboard.heroku.com/apps), choose your dyno and then go to Add-ons and add Heroku Postgress database, or again by giving the command in the command line:

Code Block
languagetext
$ heroku addons:create heroku-postgresql --app <your heroku app name>

Useful configuration commands

These are some configuration commands to display and/or configure Heroku regarding environmental variables and Java options, or just displaying info about the application

Code Block
languagetext
titleshow all config parameters
$ heroku config --app <your heroku app name>
Code Block
languagetext
titleshow all environmental parameters
$ heroku run printenv --app <your heroku app name>
Code Block
languagetext
titleshow application info
$ heroku info --app <your heroku app name>
Code Block
languagetext
titleset the Java options environmental variable
$ heroku config:add JAVA_OPTS='-Xms128m -Xmx512m' --app <your heroku app name>
Code Block
languagetext
titlerestart Heroku application
$ heroku restart --app <your heroku app name>

Installation complete

Open your browser and enter https:/yourappname.herokuapp.com/. You should now see the TermWeb login screen. You can log in with client admin, user admin and password admin.

(tick) Congratulations! Your TermWeb deployment on Heroku is now completed!