imported>Jason.nicholls: 1 revision

2015-04-30T11:18:23Z

1 revision

← Older revision	Revision as of 11:18, 30 April 2015
(No difference)

imported>Jason.nicholls: /* Installation Tasks */

2014-07-18T11:33:30Z

Installation Tasks

New page

[[Category:enPortal 5.6]]
{{DISPLAYTITLE:Windows Installation}}

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

== Prerequisites ==

# Install Java (refer to the [[enportal/5.6/overview/system_requirements|System Requirements]] for supported versions)
# Ensure <tt>JAVA_HOME</tt> system environment variable is configured
## Start | Right-click on Computer and "Properties" | Advanced System Settings | Environment Variables
## Under "System Variables", if there is no "JAVA_HOME" variable set, click "New"
## Set "Variable Name" to JAVA_HOME
## Set "Variable Path" to the path to Java install path
## For example: <tt>JAVA_HOME = C:\Program Files\Java\jre7</tt>
## 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.

== Installation Tasks ==

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

# Extract the turnkey installation file to any desired location on the server
# Save the license file into <tt>[INSTALL_HOME]\webapps\enportal\WEB-INF\config\license.properties</tt>
# [optional] Ensure the default ports enPortal use are free or make changes to the listening ports, along with changes to other runtime options. Refer to the [[enportal/5.6/admin/enPortal_installation/installation/runtime_options|Runtime Options]] page for further information.
# [optional] enPortal comes with a pre-configured H2 database for storing configuration. An external configuration database can also be used, see the [[enportal/5.6/admin/configuration_database|Configuration Database]] page for more information.
# Run the Tomcat startup executable in <tt>[INSTALL_HOME]\bin\startup.bat</tt>
# Validate the installation
## Go to the following URL in a supported web browser on any workstation that has network access to the enPortal server: http://localhost:8080
## When prompted, log in with the following default credentials (case sensitive):
### User Name: '''administrator'''
### Password: '''administrator'''
### Domain: '''System'''

=== 32-bit Systems ===

By default the turnkey installation is configured with 64-bit executables. For 32-bit systems the following additional tasks must be performed:

# Navigate to <tt>[INSTALL_HOME]\server\bin\windows-x86</tt> and copy the 32-bit Tomcat files from the <tt>\windows-x86</tt> folder up one level to replace the default 64-bit versions in the <tt>\bin</tt> folder:
## tcnative-1.dll
## tomcat7.exe
# It may be necessary to reduce the memory usage, refer to next step and the [[enportal/5.6/admin/enPortal_installation/installation/memory_configuration|Memory Configuration]] page.

== Create an enPortal Service ==

After installing 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 restarted. This can be implemented using a Windows service. This section details how to configure automated startup.

{{Note|
* Installing a service requires administrator privileges.
* A 64-bit JVM must be used when running as a service on 64-bit Windows.}}

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

# Open a ''Command Prompt''.
# Navigate to <tt>[INSTALL_HOME]\server\bin</tt>
# Enter the following command to install the Windows service:
#: <tt>> service install</tt>
# If successful, the message should be displayed: "The service 'EdgeTomcat' has been installed."
# Enter the following command later if you need to remove the Windows service:
#: <tt>> service remove</tt>
# If successful, the message should be displayed: "The service 'EdgeTomcat' 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 Tomcat", then choosing the desired startup type, such as "Automatic".

{{Tip|The command <tt>> tomcat7w.exe //MS//EdgeTomcat</tt> can be used to monitor the service and access the service configuration. Launching this utility will add an ''Edge Tomcat'' icon in the system tray. Right-click the icon to start/stop or further configure the service.}}

== Stopping enPortal ==
To stop enPortal, terminate the Tomcat process that is running on the enPortal server.

{{Warning|When enPortal is stopped, all current users who are logged in to the system will receive an error message the next time they make a request to the enPortal server. Subsequent users will not be able to access the login page until enPortal is restarted. If you are stopping a production instance of enPortal, it is recommended that you schedule a maintenance window and send advance notification to users of the system. You can check if there are any active users logged in to enPortal before stopping it by using the [[enportal/5.6/admin/system_administration/manage_sessions|Session Manager]].}}

There are several ways to terminate the Tomcat process:
* Execute the shutdown script that is provided:
*: <tt>[INSTALL_HOME]/server/bin/shutdown.bat</tt>
* If running as a service, stop the ''Edge Tomcat'' service
* In the console, enter CTRL-C

{{Warning|You must properly shut down Tomcat. Do not kill the process by clicking the window "close" button ("X") or by using the Unix kill command (kill -9 <processid>). If the database does not properly shut down, residual lock files have been documented to cause problems when restoring archives.}}

Enportal/5.6/admin/windows installation - Revision history

imported>Jason.nicholls: 1 revision

imported>Jason.nicholls: /* Installation Tasks */