Appboard/2.5/admin/windows installation - Revision history

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

2014-07-18T10:59:57Z

Installation Tasks

← Older revision		Revision as of 10:59, 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 [[appboard/2.5/admin/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 [[appboard/2.5/admin/runtime_options\|Runtime Options]] page for further information.
	# [optional] AppBoard 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 AppBoard to use your own database~~, ~~follow the instructions on~~ the [[~~Database_Configuration~~\|Database ~~Connection Configuration~~]] page.		# [optional] AppBoard comes with a pre-configured H2 database for storing configuration. An external configuration database can also be used, see the [[appboard/2.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 AppBoard Service */

2014-07-14T07:08:04Z

Create an AppBoard Service

← Older revision		Revision as of 07:08, 14 July 2014
Line 44:		Line 44:
	After installing AppBoard, 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.		After installing AppBoard, 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.

	{{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:

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

2014-07-14T06:39:42Z

Create an AppBoard Service

← Older revision		Revision as of 06:39, 14 July 2014
Line 43:		Line 43:

	After installing AppBoard, 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.		After installing AppBoard, 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.


	{{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 59:		Line 57:
	# If successful, the message should be displayed: "The service 'EdgeTomcat' 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 Tomcat", 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>> 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.}}		{{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.}}

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

2014-07-14T06:38:05Z

Create an AppBoard Service

← Older revision		Revision as of 06:38, 14 July 2014
Line 62:		Line 62:
	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".		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.}}		{{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 AppBoard ==		== Stopping AppBoard ==

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

2014-07-14T06:36:30Z

Stopping AppBoard

← Older revision		Revision as of 06:36, 14 July 2014
Line 74:		Line 74:
	* 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 ~~AppBoard~~ 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 AppBoard Service */

2014-07-14T06:35:30Z

Create an AppBoard Service

← Older revision		Revision as of 06:35, 14 July 2014
Line 60:		Line 60:


	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>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.}}
	{{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 AppBoard ==		== Stopping AppBoard ==

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

2014-07-14T06:30:19Z

Create an AppBoard Service

← Older revision		Revision as of 06:30, 14 July 2014
Line 50:		Line 50:
	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:
	#: <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."

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

2014-07-14T06:09:06Z

Create an AppBoard 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 AppBoard Service */

2014-07-10T09:13:00Z

Create an AppBoard Service

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


	~~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.
			* A 64-bit JVM must be used when running as a service on 64-bit Windows.}}

	~~{{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. }}~~		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'' as the administrator (right-click and ''Run as administrator'').

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

2014-07-10T09:10:04Z

Create an AppBoard/enPortal Service

← Older revision		Revision as of 09:10, 10 July 2014
Line 40:		Line 40:
	# It may be necessary to reduce the memory usage, refer to next step and the [[appboard/2.5/admin/memory_configuration\|Memory Configuration]] page.		# It may be necessary to reduce the memory usage, refer to next step and the [[appboard/2.5/admin/memory_configuration\|Memory Configuration]] page.

	== Create an AppBoard~~/enPortal~~ Service ==		== Create an AppBoard 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.		After installing AppBoard, 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:		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\|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. }}		{{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.~~		# Open a ''Command Prompt'' as the administrator (right-click and ''Run as administrator'').
	~~#: Example: If you are running~~ a ~~32-bit Windows OS, this would be~~ the ~~"windows~~-~~x86" folder~~.		# Navigate to <tt>[INSTALL_HOME]\server\bin</tt>
	~~# 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:		# 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."

Line 67:		Line 65:

	{{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>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 AppBoard ==		== Stopping AppBoard ==