Edge Documentation

This section provides instructions for installing AppBoard/enPortal on a Windows Server. It also details how to create a service that will automatically start AppBoard/enPortal when the server is booted.

Install AppBoard/enPortal

To install AppBoard/enPortal, perform the following steps on the server:

1. Install the Java Development Kit (JDK)
2. Make sure the Java home environment variable is set on the server:
   1. Start | Right-click on Computer and "Properties" | Advanced System Settings | Environment Variables
   2. Under "System Variables", if there is no "JAVA_HOME" variable set, click "New"
   3. Set "Variable Name" to JAVA_HOME
   4. Set "Variable Path" to the path to the JDK
   5. Example (Windows): JAVA_HOME = C:\Program Files\Java\jdk1.6.0_10
   6. Note: Make sure JAVA_HOME does not end with "\" and is not surrounded by quotes. It is also recommended that JAVA_HOME not contain spaces.
3. Extract the turnkey installation file to any desired location on the server
4. Save the license file into [INSTALL_HOME]/webapps/enportal/WEB-INF/config/license.properties
5. If you are running a 32-bit version of Windows, perform the following additional steps:
   1. Navigate to [INSTALL_HOME]/server/bin/windows-x86 and copy the 32-bit Tomcat files from the /windows-x86 folder up one level to replace the default 64-bit versions in the /bin folder:
      1. tcnative-1.dll
      2. tomcat7.exe
   2. Navigate to [INSTALL_HOME]/server/bin/setenv.bat and change the JAVA_MEMORY_MAX setting from 1536 to 1024
6. [optional] Confirm that the server does not have anything running on the port to be used by AppBoard/enPortal
   1. The port number is shown as HTTP_PORT in the file: [INSTALL_HOME]/bin/setenv.bat
7. Run the Tomcat startup executable in [INSTALL_HOME]/bin/startup.bat
8. Validate the installation
   1. Go to the following URL in a supported web browser on any workstation that has network access to the AppBoard/enPortal server: http://localhost:8080
   2. When prompted, log in with the following default credeintials:
      1. User ID: administrator
      2. Password: administrator
      3. Domain: System
9. [optional] Make changes to the default ports, java memory tuning, and other options by updating [INSTALL_HOME]/bin/setenv-custom.bat.

Create an AppBoard/enPortal Service

After installing AppBoard/enPortal, you can configure the application for automated startup. For example, on a production server, you may want the application to start up automatically any time the server is re-started. This can be implemented using a Windows service. This section details how to configure automated startup.

The following steps detail how to create a Windows service for automated startup:

It is recommended that you are the administrator when opening a console to install a service.

A 64-bit JVM must be used when running as a service on 64-bit Windows.

1. Locate the subfolder under [INSTALL_HOME]\server\bin that matches your operating system.

   Example: If you are running a 32-bit Windows OS, this would be the "windows-x86" folder.

2. Copy the two files from this folder over the same files in [INSTALL_HOME]\server\bin
3. If your system is running with an SSL certificate, perform the following additional steps:
   1. Open the file [INSTALL_HOME]\server\conf\server.xml in a text editor.
   2. Search for "SSLEnabled="true" to locate the section of code that implements the SSL connector.
   3. In this section, look for any lines such as the following:

      SSLCertificateFile="../conf/ssl.crt/server.crt"

      SSLCertificateKeyFile="../conf/ssl.key/server.key"

   4. Updated the file references in the above line(s) to be fully-qualified path references. For example:

      SSLCertificateFile="c:/appboardProd/server/conf/ssl.crt/server.crt"

      SSLCertificateKeyFile="c:/appboardProd/server/conf/ssl.crt/server.key"

   5. Save the server.xml file.
4. Open the DOS command window
5. Navigate to [INSTALL_HOME]\server\bin
6. Enter the following command to install the Windows service:

   > service install

7. If successful, the message should be displayed: "The service 'EdgeWebServer' has been installed."
8. Enter the following command later if you need to remove the Windows service:

   > service remove

9. If successful, the message should be displayed: "The service 'EdgeWebServer' has been removed."

The service is installed with manual startup configured. The Startup type is changed by running "services.msc" from Windows, selecting properties for "Edge Web Server", then choosing the desired startup type, such as "Automatic".

The setenv.bat script can be used to override the system JAVA_HOME and memory allocated to the Java process.

The command service.bat test will launch the service in a console window, with the same options as set for the service. This can allow you to observe startup issues without having to formally run the service.