Appboard/2.5/admin/unix installation - Revision history

imported>Jason.nicholls: /* Binding to Port <1024 as non-root */

2015-03-12T07:18:01Z

Binding to Port <1024 as non-root

← Older revision		Revision as of 07:18, 12 March 2015
Line 65:		Line 65:
	# Use JSVC to run AppBoard. This allows JSVC to run as root, bind to the port, and then start Tomcat as the non-root user. To configure JSVC, run the Post Installation script and answer ''yes'' to the question about using JSVC. To change the listening port then edit the HTTP_PORT value in <tt>setenv-custom.sh</tt> (see [[appboard/2.5/admin/runtime_options\|Runtime Options]]). It will be necessary to restart AppBoard for these changes to take effect.		# Use JSVC to run AppBoard. This allows JSVC to run as root, bind to the port, and then start Tomcat as the non-root user. To configure JSVC, run the Post Installation script and answer ''yes'' to the question about using JSVC. To change the listening port then edit the HTTP_PORT value in <tt>setenv-custom.sh</tt> (see [[appboard/2.5/admin/runtime_options\|Runtime Options]]). It will be necessary to restart AppBoard for these changes to take effect.
	#: NOTE: in some cases the included JSVC binary may not work and will need to be re-compiled to suit your platform/configuration (see http://commons.apache.org/daemon/jsvc.html).		#: NOTE: in some cases the included JSVC binary may not work and will need to be re-compiled to suit your platform/configuration (see http://commons.apache.org/daemon/jsvc.html).
	# Use OS-supported port forwarding. Depending on the platform, the operating system may offer network layer port forwarding to transparently route traffic from the desired port to the port ~~enPortal~~ is listening on.		# Use OS-supported port forwarding. Depending on the platform, the operating system may offer network layer port forwarding to transparently route traffic from the desired port to the port AppBoard is listening on.
	#* Example for Linux using iptables. This will redirect port 80 to port 8080 arriving on the eth0 interface. Add this command to <tt>/etc/rc.local</tt> to enable on boot:		#* Example for Linux using iptables. This will redirect port 80 to port 8080 arriving on the eth0 interface. Add this command to <tt>/etc/rc.local</tt> to enable on boot:
	#*: <tt>iptables -A PREROUTING -t nat -i eth0 -p tcp --dport 80 -j REDIRECT --to-port 8080</tt>		#*: <tt>iptables -A PREROUTING -t nat -i eth0 -p tcp --dport 80 -j REDIRECT --to-port 8080</tt>

imported>Jason.nicholls: /* Binding to Port <1024 as non-root */

2015-03-12T07:17:43Z

Binding to Port <1024 as non-root

← Older revision		Revision as of 07:17, 12 March 2015
Line 63:		Line 63:
	If AppBoard is ''not'' running as root, Tomcat will not be able to bind to a port less than 1024. By default, AppBoard is configured to listen on port 8080 so this is not an issue. However in production systems it may be necessary to have AppBoard listen on a port < 1024 and have AppBoard run as non-root. In these situations, the following options apply:		If AppBoard is ''not'' running as root, Tomcat will not be able to bind to a port less than 1024. By default, AppBoard is configured to listen on port 8080 so this is not an issue. However in production systems it may be necessary to have AppBoard listen on a port < 1024 and have AppBoard run as non-root. In these situations, the following options apply:

	* Use JSVC to run AppBoard. This allows JSVC to run as root, bind to the port, and then start Tomcat as the non-root user. To configure JSVC, run the Post Installation script and answer ''yes'' to the question about using JSVC. To change the listening port then edit the HTTP_PORT value in <tt>setenv-custom.sh</tt> (see [[appboard/2.5/admin/runtime_options\|Runtime Options]]). It will be necessary to restart AppBoard for these changes to take effect.		# Use JSVC to run AppBoard. This allows JSVC to run as root, bind to the port, and then start Tomcat as the non-root user. To configure JSVC, run the Post Installation script and answer ''yes'' to the question about using JSVC. To change the listening port then edit the HTTP_PORT value in <tt>setenv-custom.sh</tt> (see [[appboard/2.5/admin/runtime_options\|Runtime Options]]). It will be necessary to restart AppBoard for these changes to take effect.
	** NOTE: in some cases the included JSVC binary may not work and will need to be re-compiled to suit your platform/configuration (see http://commons.apache.org/daemon/jsvc.html).		#: NOTE: in some cases the included JSVC binary may not work and will need to be re-compiled to suit your platform/configuration (see http://commons.apache.org/daemon/jsvc.html).
	* As an alternative to using JSVC, ~~you can use some kind of~~ port forwarding ~~that is transparent~~ to ~~the client which listens on~~ the desired port ~~and forwards traffic~~ to ~~AppBoard~~. On Linux ~~systems,~~ this ~~can be achieved~~ using ~~iptables~~.		# Use OS-supported port forwarding. Depending on the platform, the operating system may offer network layer port forwarding to transparently route traffic from the desired port to the port enPortal is listening on.
			#* Example for Linux using iptables. This will redirect port 80 to port 8080 arriving on the eth0 interface. Add this command to <tt>/etc/rc.local</tt> to enable on boot:
			#*: <tt>iptables -A PREROUTING -t nat -i eth0 -p tcp --dport 80 -j REDIRECT --to-port 8080</tt>
			#* Example for Solaris using ipfilter. This will redirect port 80 to port 8080 for traffic on the e1000g0 interface which has IP 192.168.149.131:
			#*# create <tt>/etc/ipf/ipnat.conf</tt> if it does not exist, and add the line:
			#*#: <tt>rdr e1000g0 192.168.149.131/32 port 80 -> 127.0.0.1 port 8080 tcp</tt>
			#*# enable the ipfilter system service: <tt>$ svcadm enable ipfilter</tt>. This will ensure the service is enabled at boot.
			#*# verify the forwarding rules: <tt>$ ipnat -l</tt>

	=== 64-bit Java on Solaris ===		=== 64-bit Java on Solaris ===

imported>Jason.nicholls at 05:46, 12 March 2015

2015-03-12T05:46:09Z

@@ Line 44: / Line 44: @@
 Due to how Java runtime environments are managed on the various Linux / UNIX systems, the script also completely resolves any symbolic links. This may explain why a simple Java path such as <tt>/usr/bin/java</tt> can be saved as a more involved JAVA_HOME into setenv-custom.sh. After running post_install it's always possible to edit setenv-custom and set a different JAVA_HOME if necessary.
 ==Verifying the Installation==
@@ Line 76: / Line 66: @@
 ** NOTE: in some cases the included JSVC binary may not work and will need to be re-compiled to suit your platform/configuration (see http://commons.apache.org/daemon/jsvc.html).
 * As an alternative to using JSVC, you can use some kind of port forwarding that is transparent to the client which listens on the desired port and forwards traffic to AppBoard. On Linux systems, this can be achieved using iptables.
 === Restoring an Archive ===

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

2015-03-12T05:42:08Z

Post Installation Tasks

← Older revision		Revision as of 05:42, 12 March 2015
Line 44:		Line 44:

	Due to how Java runtime environments are managed on the various Linux / UNIX systems, the script also completely resolves any symbolic links. This may explain why a simple Java path such as <tt>/usr/bin/java</tt> can be saved as a more involved JAVA_HOME into setenv-custom.sh. After running post_install it's always possible to edit setenv-custom and set a different JAVA_HOME if necessary.		Due to how Java runtime environments are managed on the various Linux / UNIX systems, the script also completely resolves any symbolic links. This may explain why a simple Java path such as <tt>/usr/bin/java</tt> can be saved as a more involved JAVA_HOME into setenv-custom.sh. After running post_install it's always possible to edit setenv-custom and set a different JAVA_HOME if necessary.

			=== Additional Notes for 64bit Solaris ===

			Java for Solaris is packaged differently than for other platforms in that both 32-bit and 64-bit JVMs exist in the same location. In order to use the 64-bit VM it's necessary to either specify the <tt>-d64</tt> option, or to explicitly run the 64-bit executable (for example: <tt>/opt/java8/bin/amd64/java</tt>).

			For the best results with AppBoard do the following:

			* For default (non-jsvc) installs edit <tt>setenv-custom.sh</tt> and add the following:
			*: <tt>CUSTOM_JAVA_OPTS="-d64"</tt>
			* If using JSVC just ensure <tt>[INSTALL_HOME]/server/bin/jsvc</tt> links to the 64-bit executable. Do not set the variable above as this option is not valid to the jsvc executable.

	==Verifying the Installation==		==Verifying the Installation==

imported>Jason.nicholls: /* post_install Details */

2014-08-26T16:32:54Z

post_install Details

← Older revision		Revision as of 16:32, 26 August 2014
Line 29:		Line 29:

	* <tt>TOMCAT_USER</tt>		* <tt>TOMCAT_USER</tt>
			* <tt>TOMCAT_GROUP</tt>
	* <tt>TOMCAT_SERVICE</tt>		* <tt>TOMCAT_SERVICE</tt>
	* <tt>USE_JSVC</tt>		* <tt>USE_JSVC</tt>

imported>Jason.nicholls at 10:59, 18 July 2014

2014-07-18T10:59:00Z

← Older revision		Revision as of 10:59, 18 July 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:Linux / UNIX Installation}}		{{DISPLAYTITLE:Linux / UNIX Installation}}
	[[Category:AppBoard 2.5]]		[[Category:AppBoard 2.5]]
	===Prerequisites===		==Prerequisites==
	# Install Java (refer to the [[appboard/2.5/system_requirements\|System Requirements]] for supported versions)		# Install Java (refer to the [[appboard/2.5/system_requirements\|System Requirements]] for supported versions)
	# Install unzip		# Install unzip

	===Installation Tasks===		==Installation Tasks==
	# Extract the turnkey installation archive to the desired location on the server. For example:		# Extract the turnkey installation archive to the desired location on the server. For example:
	## <tt>$ mkdir /opt/appboard</tt>		## <tt>$ mkdir /opt/appboard</tt>
Line 13:		Line 13:
	# Run the post installation tasks.		# Run the post installation tasks.

	===Post Installation Tasks===		==Post Installation Tasks==
			On Linux and UNIX systems, it is necessary to run a script to update file ownership and permissions, and set some initial configuration parameters. To be prepared to run this script, make sure you know which java you want AppBoard to use (e.g. <tt>/usr/bin/java</tt>), what user to run AppBoard as, and whether you wish to install a system service to automaticaly start/stop AppBoard on boot and shutdown.
	On Linux and UNIX systems, it is necessary to run a script to update file ownership and permissions, and set some initial configuration parameters. To be prepared to run this script, make sure you know which java you want AppBoard~~/enPortal~~ to use (e.g. <tt>/usr/bin/java</tt>), what user to run AppBoard~~/enPortal~~ as, and whether you wish to install a system service to automaticaly start/stop AppBoard~~/enPortal~~ on boot and shutdown.

	This script can be run as root or non-root. When run as non-root some options are not available, such as installing a system service.		This script can be run as root or non-root. When run as non-root some options are not available, such as installing a system service.
Line 23:		Line 22:
	# Answer the prompted questions. Defaults or previous preferences are provided where appropriate.		# Answer the prompted questions. Defaults or previous preferences are provided where appropriate.
	# The script will verify selected options before making any changes, so review and continue if correct.		# The script will verify selected options before making any changes, so review and continue if correct.
	# [optional] Make changes to the default ports, java memory tuning, and runtime options. Refer to the [[appboard/2.5/admin/runtime_options\|Runtime Options]] page for further information. Please ~~also~~ note that some options are managed by the post_install script, see ~~below~~.		# [optional] Make changes to the default ports, java memory tuning, and runtime options. Refer to the [[appboard/2.5/admin/runtime_options\|Runtime Options]] page for further information. Please note that some runtime options are managed by the post_install script.
			# [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.

			=== post_install Details ===
			The post_install script manages the following environment variables which are updated into <tt>setenv-custom.sh</tt>. It is recommended to re-run post_install to make changes to these:

			* <tt>TOMCAT_USER</tt>
			* <tt>TOMCAT_SERVICE</tt>
			* <tt>USE_JSVC</tt>
			* <tt>JAVA_HOME</tt>

	~~<tt>post_install.sh</tt> manages the <tt>TOMCAT_USER</tt>, <tt>TOMCAT_SERVICE</tt>, <tt>USE_JSVC</tt>,~~ and ~~<tt>JAVA_HOME</tt> options~~ stored ~~in <tt>~~setenv-custom.sh~~</tt>. These can be edited directly but it's recommend to just re-run~~ the ~~post_install script instead~~.		JAVA_HOME is a very important setting and is stored within setenv-custom to ensure a consistent environment whether running portal.sh, running AppBoard from the command line, or running AppBoard as a service.

	~~The script~~ will ~~check for~~ JAVA_HOME ~~and use $JAVA_HOME/bin/java. If a valid java installation is not discovered, the script will then check~~ the ~~user's path, instead. Detection is done in this order/preference~~:		post_install will determine JAVA_HOME based on the following rules:

	# ~~Previously used JAVA_HOME as saved in~~ setenv-custom~~.sh (only if upgrading).~~		# The current setting from setenv-custom
	#* <i>Note that if JAVA_HOME ~~refers to a valid Java installation, AppBoard saves~~ the ~~value of this~~ environment ~~variable in setenv-custom.sh.</i>~~		# If above is not set, or invalid, then JAVA_HOME from the user's environment
	# ~~JAVA_HOME from your env~~		# If above is not set, or invalid, then based on the user's PATH ($ which java)
	~~# java from your path~~ ($ which java)		# Finally, the user is prompted to enter an alternative location.
	# ~~JRE_HOME from your env~~

	~~===Verifying~~ the ~~Installation===~~		Due to how Java runtime environments are managed on the various Linux / UNIX systems, the script also completely resolves any symbolic links. This may explain why a simple Java path such as <tt>/usr/bin/java</tt> can be saved as a more involved JAVA_HOME into setenv-custom.sh. After running post_install it's always possible to edit setenv-custom and set a different JAVA_HOME if necessary.

	# Start AppBoard~~/enPortal~~:		==Verifying the Installation==
			# Start AppBoard:
	#* If a system service was installed, then use the appropriate command to start, such as <tt>$ service ''service_name'' start</tt> for RedHat Enterprise Linux		#* If a system service was installed, then use the appropriate command to start, such as <tt>$ service ''service_name'' start</tt> for RedHat Enterprise Linux
	#* Or start on the command line from the <tt>[INSTALL_HOME]/server/bin</tt> directory: <tt>./startup.sh</tt>		#* Or start on the command line from the <tt>[INSTALL_HOME]/server/bin</tt> directory: <tt>./startup.sh</tt>
Line 46:		Line 54:
	==Additional Configuration Options==		==Additional Configuration Options==

	===~~Linux / UNIX Services (~~Starting ~~AppBoard/enPortal automatically~~ on ~~boot)~~===		===Starting on Boot===
			To have AppBoard start and stop automatically on boot and shutdown, it is necessary to use a system service. The Post Installation script will handle setting up and configuring the system service on supported platforms.
	To have AppBoard~~/enPortal~~ start and stop automatically on boot and shutdown, it is necessary to use a system service. The Post Installation script will handle setting up and configuring the system service on supported platforms.

	NOTE: if the AppBoard/enPortal installation directory has to be moved, or AppBoard/enPortal is to be removed, then make sure to remove the system service ''first''. This can be done using the unix services utility as root from the <tt>[INSTALL_HOME]/server/bin/helpers</tt> directory: <tt>$ ./unix_services.sh remove</tt>

			NOTE: if the AppBoard installation directory has to be moved, or AppBoard is to be removed, then make sure to remove the system service ''first''. This can be done using the unix services utility as root from the <tt>[INSTALL_HOME]/server/bin/helpers</tt> directory: <tt>$ ./unix_services.sh remove</tt>

	===Binding to Port <1024 as non-root===		===Binding to Port <1024 as non-root===
			If AppBoard is ''not'' running as root, Tomcat will not be able to bind to a port less than 1024. By default, AppBoard is configured to listen on port 8080 so this is not an issue. However in production systems it may be necessary to have AppBoard listen on a port < 1024 and have AppBoard run as non-root. In these situations, the following options apply:

	If AppBoard/enPortal is ''not'' running as root, Tomcat will not be able to bind to a port less than 1024. By default, AppBoard/enPortal is configured to listen on port 8080 so this is not an issue. However in production systems it may be necessary to have AppBoard/enPortal listen on a port < 1024 and have AppBoard/enPortal run as non-root. In these situations, the following options apply:		* Use JSVC to run AppBoard. This allows JSVC to run as root, bind to the port, and then start Tomcat as the non-root user. To configure JSVC, run the Post Installation script and answer ''yes'' to the question about using JSVC. To change the listening port then edit the HTTP_PORT value in <tt>setenv-custom.sh</tt> (see [[appboard/2.5/admin/runtime_options\|Runtime Options]]). It will be necessary to restart AppBoard for these changes to take effect.

	* Use JSVC to run AppBoard~~/enPortal~~. This allows JSVC to run as root, bind to the port, and then start Tomcat as the non-root user. To configure JSVC, run the Post Installation script and answer ''yes'' to the question about using JSVC. To change the listening port then edit the HTTP_PORT value in <tt>setenv-custom.sh</tt> (see [[appboard/2.5/admin/runtime_options\|Runtime Options]]). It will be necessary to restart AppBoard~~/enPortal~~ for these changes to take effect.
	** NOTE: in some cases the included JSVC binary may not work and will need to be re-compiled to suit your platform/configuration (see http://commons.apache.org/daemon/jsvc.html).		** NOTE: in some cases the included JSVC binary may not work and will need to be re-compiled to suit your platform/configuration (see http://commons.apache.org/daemon/jsvc.html).
	* As an alternative to using JSVC, you can use some kind of port forwarding that is transparent to the client which listens on the desired port and forwards traffic to AppBoard~~/enPortal~~. On Linux systems, this can be achieved using iptables.		* As an alternative to using JSVC, you can use some kind of port forwarding that is transparent to the client which listens on the desired port and forwards traffic to AppBoard. On Linux systems, this can be achieved using iptables.


	=== Restoring an Archive ===		=== Restoring an Archive ===

	The instructions above detail the procedures for a new installation. However, when restoring or applying an archive (see [[appboard/2.5/admin/backup_and_recovery\|Backup and Recovery]]) it actually replaces files on the filesystem and you '''must''' review:		The instructions above detail the procedures for a new installation. However, when restoring or applying an archive (see [[appboard/2.5/admin/backup_and_recovery\|Backup and Recovery]]) it actually replaces files on the filesystem and you '''must''' review:

imported>Jason.nicholls: /* Prerequisites */

2014-07-10T05:44:26Z

Prerequisites

← Older revision		Revision as of 05:44, 10 July 2014
Line 2:		Line 2:
	[[Category:AppBoard 2.5]]		[[Category:AppBoard 2.5]]
	===Prerequisites===		===Prerequisites===
	# Install Java (refer to the [[appboard/2.5~~/overview~~/system_requirements\|System Requirements]] for supported versions)		# Install Java (refer to the [[appboard/2.5/system_requirements\|System Requirements]] for supported versions)
	# Install unzip		# Install unzip

imported>Jason.nicholls: /* Prerequisites */

2014-07-10T05:44:01Z

Prerequisites

← Older revision		Revision as of 05:44, 10 July 2014
Line 2:		Line 2:
	[[Category:AppBoard 2.5]]		[[Category:AppBoard 2.5]]
	===Prerequisites===		===Prerequisites===
	# Install ~~the JRE (~~Java ~~Runtime Environment) or JDK~~ (~~Java Development Kit~~) ~~1.6 or higher~~		# Install Java (refer to the [[appboard/2.5/overview/system_requirements\|System Requirements]] for supported versions)
	# Install unzip		# Install unzip

	~~{{Note\|AppBoard 2.5.1 and prior also require the <tt>lsb-release</tt> executable installed on Linux to correctly identify the distribution. This is not necessary for AppBoard 2.5.2 or newer.}}~~

	===Installation Tasks===		===Installation Tasks===

imported>Jason.nicholls: 1 revision

2014-06-26T15:52:00Z

1 revision

← Older revision	Revision as of 15:52, 26 June 2014
(No difference)

imported>Andy.hopper: /* Post Installation Tasks */

2014-06-05T15:14:13Z

Post Installation Tasks

New page

{{DISPLAYTITLE:Linux / UNIX Installation}}
[[Category:AppBoard 2.5]]
===Prerequisites===
# Install the JRE (Java Runtime Environment) or JDK (Java Development Kit) 1.6 or higher
# Install unzip

{{Note|AppBoard 2.5.1 and prior also require the <tt>lsb-release</tt> executable installed on Linux to correctly identify the distribution. This is not necessary for AppBoard 2.5.2 or newer.}}

===Installation Tasks===
# Extract the turnkey installation archive to the desired location on the server. For example:
## <tt>$ mkdir /opt/appboard</tt>
## <tt>$ cd /opt/appboard</tt>
## <tt>$ unzip ''AppBoard-2.5.0.zip''</tt>
# Save your license file into <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/license.properties</tt>
# Run the post installation tasks.

===Post Installation Tasks===

On Linux and UNIX systems, it is necessary to run a script to update file ownership and permissions, and set some initial configuration parameters. To be prepared to run this script, make sure you know which java you want AppBoard/enPortal to use (e.g. <tt>/usr/bin/java</tt>), what user to run AppBoard/enPortal as, and whether you wish to install a system service to automaticaly start/stop AppBoard/enPortal on boot and shutdown.

This script can be run as root or non-root. When run as non-root some options are not available, such as installing a system service.

# Change into the <tt>[INSTALL_HOME]/server/bin/helpers</tt> directory
# Run: <tt>$ ./post_install.sh</tt><br>if this script is not set executable, then run and try again: <tt>$ chmod u+x post_install.sh</tt>
# Answer the prompted questions. Defaults or previous preferences are provided where appropriate.
# The script will verify selected options before making any changes, so review and continue if correct.
# [optional] Make changes to the default ports, java memory tuning, and runtime options. Refer to the [[appboard/2.5/admin/runtime_options|Runtime Options]] page for further information. Please also note that some options are managed by the post_install script, see below.

<tt>post_install.sh</tt> manages the <tt>TOMCAT_USER</tt>, <tt>TOMCAT_SERVICE</tt>, <tt>USE_JSVC</tt>, and <tt>JAVA_HOME</tt> options stored in <tt>setenv-custom.sh</tt>. These can be edited directly but it's recommend to just re-run the post_install script instead.

The script will check for JAVA_HOME and use $JAVA_HOME/bin/java. If a valid java installation is not discovered, the script will then check the user's path, instead. Detection is done in this order/preference:

# Previously used JAVA_HOME as saved in setenv-custom.sh (only if upgrading).
#* <i>Note that if JAVA_HOME refers to a valid Java installation, AppBoard saves the value of this environment variable in setenv-custom.sh.</i>
# JAVA_HOME from your env
# java from your path ($ which java)
# JRE_HOME from your env

===Verifying the Installation===

# Start AppBoard/enPortal:
#* If a system service was installed, then use the appropriate command to start, such as <tt>$ service ''service_name'' start</tt> for RedHat Enterprise Linux
#* Or start on the command line from the <tt>[INSTALL_HOME]/server/bin</tt> directory: <tt>./startup.sh</tt>
# Any errors will be logged into <tt>[INSTALL_HOME]/server/logs</tt>
# Go to the following URL in a web browser, using a system that has network access to the server: <tt>http://''server_ip'':8080</tt>. If the system started correctly, a login page will be displayed.
#* The default login credentials are: administrator / administrator / System

==Additional Configuration Options==

===Linux / UNIX Services (Starting AppBoard/enPortal automatically on boot)===

To have AppBoard/enPortal start and stop automatically on boot and shutdown, it is necessary to use a system service. The Post Installation script will handle setting up and configuring the system service on supported platforms.

NOTE: if the AppBoard/enPortal installation directory has to be moved, or AppBoard/enPortal is to be removed, then make sure to remove the system service ''first''. This can be done using the unix services utility as root from the <tt>[INSTALL_HOME]/server/bin/helpers</tt> directory: <tt>$ ./unix_services.sh remove</tt>

===Binding to Port <1024 as non-root===

If AppBoard/enPortal is ''not'' running as root, Tomcat will not be able to bind to a port less than 1024. By default, AppBoard/enPortal is configured to listen on port 8080 so this is not an issue. However in production systems it may be necessary to have AppBoard/enPortal listen on a port < 1024 and have AppBoard/enPortal run as non-root. In these situations, the following options apply:

* Use JSVC to run AppBoard/enPortal. This allows JSVC to run as root, bind to the port, and then start Tomcat as the non-root user. To configure JSVC, run the Post Installation script and answer ''yes'' to the question about using JSVC. To change the listening port then edit the HTTP_PORT value in <tt>setenv-custom.sh</tt> (see [[appboard/2.5/admin/runtime_options|Runtime Options]]). It will be necessary to restart AppBoard/enPortal for these changes to take effect.
** NOTE: in some cases the included JSVC binary may not work and will need to be re-compiled to suit your platform/configuration (see http://commons.apache.org/daemon/jsvc.html).
* As an alternative to using JSVC, you can use some kind of port forwarding that is transparent to the client which listens on the desired port and forwards traffic to AppBoard/enPortal. On Linux systems, this can be achieved using iptables.

=== Restoring an Archive ===

The instructions above detail the procedures for a new installation. However, when restoring or applying an archive (see [[appboard/2.5/admin/backup_and_recovery|Backup and Recovery]]) it actually replaces files on the filesystem and you '''must''' review:

# If using a ''Restore'' then <tt>setenv-custom.sh</tt> is replaced
# If using a ''Restore'' the license file may be replaced
# Both ''Restore'' and ''Apply'' cases may include files with incorrect permissions and/or ownership

The recommendation whether restoring with a ''Restore'' or ''Apply'' is to re-run <tt>post_install.sh</tt> after the import completes. In cases where the archive originates from a different system then ''Apply'' is the recommended import command.

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

{{Warning|When AppBoard 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 AppBoard server. Subsequent Users will not be able to access the login page until AppBoard is re-started. If you are stopping a production instance of AppBoard, 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 AppBoard before stopping it, by using the [[appboard/2.5/builder/system_administration/manage_sessions|Session Manager]].}}

* For instances running as a system service make sure it is shutdown as a service, i.e.
*: <tt>$ /etc/init.d/appboard stop</tt>
* When running on the command line then use:
*: <tt>[INSTALL_HOME]/server/bin/stop.sh</tt>
* When running attached to the console (<tt>./catalina.sh run</tt>) then use a CTRL+C signal to terminate.
* As a general alternative locate the process and send a <tt>TERM</tt> signal.

{{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.}}