Enportal/5.5/admin/windows installation - Revision history

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

2014-07-18T11:33:30Z

Installation Tasks

← Older revision		Revision as of 11:33, 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.5/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.5/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.5/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: /* Create an enPortal Service */

2014-07-14T07:07:43Z

Create an enPortal Service

← Older revision		Revision as of 07:07, 14 July 2014
Line 44:		Line 44:
	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.		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\|A 64-bit JVM must be used when running as a service on 64-bit Windows.}}		{{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:		The following steps detail how to create a Windows service for automated startup:

	# Open a ''Command Prompt'' ~~as the administrator (right-click and ''Run as administrator'')~~.		# Open a ''Command Prompt''.
	# Navigate to <tt>[INSTALL_HOME]\server\bin</tt>		# Navigate to <tt>[INSTALL_HOME]\server\bin</tt>
	# Enter the following command to install the Windows service:		# Enter the following command to install the Windows service:

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

2014-07-14T07:01:39Z

Stopping enPortal

← Older revision		Revision as of 07:01, 14 July 2014
Line 72:		Line 72:
	* Execute the shutdown script that is provided:		* Execute the shutdown script that is provided:
	*: <tt>[INSTALL_HOME]/server/bin/shutdown.bat</tt>		*: <tt>[INSTALL_HOME]/server/bin/shutdown.bat</tt>
	* If running as a service, stop the ~~enPortal~~ service		* If running as a service, stop the ''Edge Tomcat'' service
	* In the console, enter CTRL-C		* 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.}}		{{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.}}

imported>Jason.nicholls: /* Create an enPortal Service */

2014-07-14T07:01:08Z

Create an enPortal Service

← Older revision		Revision as of 07:01, 14 July 2014
Line 43:		Line 43:

	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.		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\|A 64-bit JVM must be used when running as a service on 64-bit Windows.}}		{{Note\|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:		The following steps detail how to create a Windows service for automated startup:
Line 54:		Line 52:
	# Enter the following command to install the Windows service:		# Enter the following command to install the Windows service:
	#: <tt>> service install</tt>		#: <tt>> service install</tt>
	# If successful, the message should be displayed: "The service '~~EdgeWebServer~~' has been installed."		# 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:		# Enter the following command later if you need to remove the Windows service:
	#: <tt>> service remove</tt>		#: <tt>> service remove</tt>
	# If successful, the message should be displayed: "The service '~~EdgeWebServer~~' has been removed."		# 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 ~~Web Server~~", then choosing the desired startup type, such as "Automatic".		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>~~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.}}		{{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 ==		== Stopping enPortal ==

imported>Jason.nicholls: /* Create an enPortal Service */

2014-07-14T06:09:34Z

Create an enPortal Service

← Older revision		Revision as of 06:09, 14 July 2014
Line 45:		Line 45:


	{{Note\|		{{Note\|A 64-bit JVM must be used when running as a service on 64-bit Windows.}}
	* It is '''required''' 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.}}

imported>Jason.nicholls: /* Create an enPortal Service */

2014-07-10T09:43:40Z

Create an enPortal Service

← Older revision		Revision as of 09:43, 10 July 2014
Line 43:		Line 43:

	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.		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\|		{{Note\|
Line 54:		Line 55:
	# Navigate to <tt>[INSTALL_HOME]\server\bin</tt>		# Navigate to <tt>[INSTALL_HOME]\server\bin</tt>
	# Enter the following command to install the Windows service:		# Enter the following command to install the Windows service:
	#: > service install		#: <tt>> service install</tt>
	# If successful, the message should be displayed: "The service 'EdgeWebServer' has been installed."		# 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:		# Enter the following command later if you need to remove the Windows service:
	#: > service remove		#: <tt>> service remove</tt>
	# If successful, the message should be displayed: "The service 'EdgeWebServer' has been removed."		# If successful, the message should be displayed: "The service 'EdgeWebServer' has been removed."

imported>Jason.nicholls: /* Create an enPortal Service */

2014-07-10T09:42:38Z

Create an enPortal Service

← Older revision		Revision as of 09:42, 10 July 2014
Line 43:		Line 43:

	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.		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\|
			* It is '''required''' 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.}}


	The following steps detail how to create a Windows service for 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.}}~~		# Open a ''Command Prompt'' as the administrator (right-click and ''Run as administrator'').
	~~{{Note\|A 64~~-~~bit JVM must be used when running~~ as ~~a service on 64-bit Windows~~. }}

	~~# Open the DOS command window~~
	# Navigate to <tt>[INSTALL_HOME]\server\bin</tt>		# Navigate to <tt>[INSTALL_HOME]\server\bin</tt>
	# Enter the following command to install the Windows service:		# Enter the following command to install the Windows service:

imported>Jason.nicholls: /* Create an enPortal Service */

2014-07-10T05:50:31Z

Create an enPortal Service

← Older revision		Revision as of 05:50, 10 July 2014
Line 50:		Line 50:
	{{Note\|A 64-bit JVM must be used when running as a service on 64-bit Windows. }}		{{Note\|A 64-bit JVM must be used when running as a service on 64-bit Windows. }}

	~~# Locate the subfolder under <tt>[INSTALL_HOME]\server\bin</tt> 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 <tt>[INSTALL_HOME]\server\bin</tt>~~
	# Open the DOS command window		# Open the DOS command window
	# Navigate to <tt>[INSTALL_HOME]\server\bin</tt>		# Navigate to <tt>[INSTALL_HOME]\server\bin</tt>

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

2014-07-10T05:49:16Z

Installation Tasks

@@ Line 21: / Line 21: @@
 # 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.5/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.
@@ Line 35: / Line 30: @@
 ### Password: '''administrator'''
 ### Domain: '''System'''
 == Create an enPortal Service ==

imported>Jason.nicholls: /* Create an enPortal Service */

2014-07-10T05:41:32Z

Create an enPortal Service

← Older revision		Revision as of 05:41, 10 July 2014
Line 46:		Line 46:
	{{Note\|A 64-bit JVM must be used when running as a service on 64-bit Windows. }}		{{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.		# Locate the subfolder under <tt>[INSTALL_HOME]\server\bin</tt> that matches your operating system.
	#: Example: If you are running a 32-bit Windows OS, this would be the "windows-x86" folder.		#: 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		# Copy the two files from this folder over the same files in <tt>[INSTALL_HOME]\server\bin</tt>
	# Open the DOS command window		# Open the DOS command window
	# Navigate to [INSTALL_HOME]\server\bin		# Navigate to <tt>[INSTALL_HOME]\server\bin</tt>
	# Enter the following command to install the Windows service:		# Enter the following command to install the Windows service:
	#: > service install		#: > service install