Enportal/5.5/admin/unix installation - Revision history

imported>Jason.nicholls: /* Linux / UNIX Services (Starting enPortal automatically on boot) */

2015-03-12T07:20:57Z

Linux / UNIX Services (Starting enPortal automatically on boot)

← Older revision		Revision as of 07:20, 12 March 2015
Line 58:		Line 58:
	==Additional Configuration Options==		==Additional Configuration Options==

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

	To have 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.		To have 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 enPortal installation directory has to be moved, or 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 enPortal installation directory has to be moved, or 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===		===Binding to Port <1024 as non-root===

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

2015-03-12T07:16:34Z

Binding to Port <1024 as non-root

← Older revision		Revision as of 07:16, 12 March 2015
Line 70:		Line 70:

	# Use JSVC to run 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 [[enportal/5.5/admin/enPortal_installation/installation/runtime_options\|Runtime Options]]). It will be necessary to restart enPortal for these changes to take effect.		# Use JSVC to run 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 [[enportal/5.5/admin/enPortal_installation/installation/runtime_options\|Runtime Options]]). It will be necessary to restart 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).
	# 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 enPortal is listening on.
	#* f		#* 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: /* Binding to Port <1024 as non-root */

2015-03-12T07:04:51Z

Binding to Port <1024 as non-root

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

	* Use JSVC to run 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 [[enportal/5.5/admin/enPortal_installation/installation/runtime_options\|Runtime Options]]). It will be necessary to restart enPortal for these changes to take effect.		# Use JSVC to run 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 [[enportal/5.5/admin/enPortal_installation/installation/runtime_options\|Runtime Options]]). It will be necessary to restart 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 enPortal. ~~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.
			#* f

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

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

2015-03-12T05:45:03Z

@@ Line 46: / Line 46: @@
 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 83: / Line 73: @@
 * 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 enPortal. On Linux systems, this can be achieved using iptables.
 === Restoring an Archive ===

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

2015-03-12T05:43:35Z

Post Installation Tasks

← Older revision		Revision as of 05:43, 12 March 2015
Line 46:		Line 46:

	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 enPortal 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:35:30Z

post_install Details

← Older revision		Revision as of 16:35, 26 August 2014
Line 31:		Line 31:

	* <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: /* Post Installation Tasks */

2014-07-18T11:46:50Z

Post Installation Tasks

← Older revision		Revision as of 11:46, 18 July 2014
Line 20:		Line 20:

	# Change into the <tt>[INSTALL_HOME]/server/bin/helpers</tt> directory		# 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>		# 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.		# 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 [[enportal/5.5/admin/enPortal_installation/installation/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 [[enportal/5.5/admin/enPortal_installation/installation/runtime_options\|Runtime Options]] page for further information. Please note that some runtime options are managed by the post_install script.
			# [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.

	~~<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.		=== post_install Details ===

	~~If "java" is not found in~~ the ~~system path, the script will check for JAVA_HOME and use $JAVA_HOME~~/~~bin/java instead~~. ~~Detection~~ is ~~done in this order/preference~~:		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:

	~~# java from your path ($ which java)~~		* <tt>TOMCAT_USER</tt>
	# JAVA_HOME ~~from your env~~		* <tt>TOMCAT_SERVICE</tt>
	~~# JRE_HOME from your env~~		* <tt>USE_JSVC</tt>
			* <tt>JAVA_HOME</tt>

			JAVA_HOME is a very important setting and is stored within setenv-custom to ensure a consistent environment whether running portal.sh, running enPortal from the command line, or running enPortal as a service.

	~~[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~~.		post_install will determine JAVA_HOME based on the following rules:

			# The current setting from setenv-custom
			# If above is not set, or invalid, then JAVA_HOME from the user's environment
			# If above is not set, or invalid, then based on the user's PATH ($ which java)
			# Finally, the user is prompted to enter an alternative location.

			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==		==Verifying the Installation==

imported>Jason.nicholls: /* Prerequisites */

2014-07-10T05:33:56Z

Prerequisites

← Older revision		Revision as of 05:33, 10 July 2014
Line 2:		Line 2:
	{{DISPLAYTITLE:Linux / UNIX Installation}}		{{DISPLAYTITLE:Linux / UNIX Installation}}
	==Prerequisites==		==Prerequisites==
	# Install Java ~~SE 7~~ (~~JRE~~) ~~or 8~~		# Install Java (refer to the [[enportal/5.5/overview/system_requirements\|System Requirements]] for supported versions)
	# Install unzip		# Install unzip

imported>Jason.nicholls: /* Prerequisites */

2014-07-10T05:32:37Z

Prerequisites

← Older revision		Revision as of 05:32, 10 July 2014
Line 2:		Line 2:
	{{DISPLAYTITLE:Linux / UNIX Installation}}		{{DISPLAYTITLE:Linux / UNIX Installation}}
	==Prerequisites==		==Prerequisites==
	# Install ~~the JRE (~~Java ~~Runtime Environment) or JDK~~ (~~Java Development Kit~~) ~~1.6~~ or ~~higher~~		# Install Java SE 7 (JRE) or 8
	# Install unzip		# Install unzip

imported>Jason.nicholls: 1 revision

2014-07-10T05:08:56Z

1 revision

← Older revision	Revision as of 05:08, 10 July 2014
(No difference)