Enportal/5.4/admin/windows installation - Revision history

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

2014-07-18T11:32:43Z

Installation Tasks

← Older revision		Revision as of 11:32, 18 July 2014
Line 22:		Line 22:
	# Save the license file into <tt>[INSTALL_HOME]\webapps\enportal\WEB-INF\config\license.properties</tt>		# 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.4/admin/enPortal_installation/installation/runtime_options\|Runtime Options]] page for further information.		# [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.4/admin/enPortal_installation/installation/runtime_options\|Runtime Options]] page for further information.
	# [optional] enPortal comes with a pre-configured H2 database for storing ~~basic system information, but this functionality~~ can be ~~achieved using other databases if desired. To configure enPortal to use your own database~~, ~~follow the instructions on~~ the [[~~Database_Configuration~~\|Database ~~Connection Configuration~~]] page.		# [optional] enPortal comes with a pre-configured H2 database for storing configuration. An external configuration database can also be used, see the [[enportal/5.4/admin/configuration_database\|Configuration Database]] page for more information.
	# Run the Tomcat startup executable in <tt>[INSTALL_HOME]\bin\startup.bat</tt>		# Run the Tomcat startup executable in <tt>[INSTALL_HOME]\bin\startup.bat</tt>
	# Validate the installation		# Validate the installation

imported>Jason.nicholls: /* Stopping enPortal */

2014-07-14T07:06:01Z

Stopping enPortal

← Older revision		Revision as of 07:06, 14 July 2014
Line 78:		Line 78:


	{{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.5/admin/system_administration/manage_sessions\|Session Manager]].}}		{{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.4/admin/system_administration/manage_sessions\|Session Manager]].}}

imported>Jason.nicholls at 07:05, 14 July 2014

2014-07-14T07:05:18Z

Show changes

imported>Jason.nicholls: 1 revision

2013-12-19T15:17:44Z

1 revision

← Older revision	Revision as of 15:17, 19 December 2013
(No difference)

imported>Mylene.stolpe at 22:49, 17 December 2013

2013-12-17T22:49:16Z

New page

[[Category:enPortal 5.4]]
{{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 the Java Development Kit (1.6 or later)
# Ensure JAVA_HOME 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 the JDK
## Example (Windows): <tt>JAVA_HOME = C:\Program Files\Java\jdk1.6.0_10</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 [INSTALL_HOME]\webapps\enportal\WEB-INF\config\license.properties
# If you are running a 32-bit version of Windows, perform the following additional steps:
## 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:
### tcnative-1.dll
### tomcat7.exe
## It may be necessary to reduce the memory usage, refer to next step and the [[enportal/5.4/admin/enPortal_installation/installation/memory_configuration|Memory Configuration]] page.
# [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.4/admin/enPortal_installation/installation/runtime_options|Runtime Options]] page for further information.
# [optional] enPortal comes with a pre-configured H2 database for storing basic system information, but this functionality can be achieved using other databases if desired. To configure enPortal to use your own database, follow the instructions on the [[Database_Configuration|Database Connection Configuration]] page.
# Run the Tomcat startup executable in [INSTALL_HOME]\bin\startup.bat
# 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:
### User ID: administrator
### Password: administrator
### Domain: System

== 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.

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

{{Note|It is required that you are the administrator when opening a console to install a service.}}
{{Note|A 64-bit JVM must be used when running as a service on 64-bit Windows. }}

# 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.
# Copy the two files from this folder over the same files in [INSTALL_HOME]\server\bin
# Open the DOS command window
# Navigate to [INSTALL_HOME]\server\bin
# Enter the following command to install the Windows service:
#: > service install
# If successful, the message should be displayed: "The service 'EdgeWebServer' has been installed."
# Enter the following command later if you need to remove the Windows service:
#: > service remove
# 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".

{{Tip|The command <tt>service.bat test</tt> 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.}}

== 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.4/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 enPortal 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.}}