Appboard/2.4/admin/enabling cgi - Revision history

imported>Jason.nicholls at 06:43, 14 December 2013

2013-12-14T06:43:01Z

← Older revision		Revision as of 06:43, 14 December 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:Enabling CGI}}		{{DISPLAYTITLE:Enabling CGI}}
			[[Category:AppBoard 2.4]]

	AppBoard runs on an Apache Tomcat server that can be configured to run CGI scripts. However, enabling CGI can introduce additional load on the AppBoard server and raises it's own security concerns. This document simply covers enabling CGI but thought should go into the issues mentioned.		AppBoard runs on an Apache Tomcat server that can be configured to run CGI scripts. However, enabling CGI can introduce additional load on the AppBoard server and raises it's own security concerns. This document simply covers enabling CGI but thought should go into the issues mentioned.

imported>Jason.nicholls: /* Steps to Enable CGI */

2013-09-19T06:05:39Z

Steps to Enable CGI

← Older revision		Revision as of 06:05, 19 September 2013
Line 12:		Line 12:
	## save changes.		## save changes.
	# Edit <tt>[INSTALL_HOME]/server/conf/context.xml</tt>		# Edit <tt>[INSTALL_HOME]/server/conf/context.xml</tt>
	## add the parameter <tt>privileged="true"</tt> to the <Context ... > tag on line 19.		## add the parameter <tt>privileged="true"</tt> to the <tt><Context ... ></tt> tag on line 19.
	## save changes.		## save changes.
	## create the directory <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/'''cgi'''</tt>		## create the directory <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/'''cgi'''</tt>

imported>Jason.nicholls at 06:03, 19 September 2013

2013-09-19T06:03:48Z

← Older revision		Revision as of 06:03, 19 September 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:Enabling CGI}}		{{DISPLAYTITLE:Enabling CGI}}

	AppBoard runs on an Apache Tomcat server that can be configured to run CGI scripts.		AppBoard runs on an Apache Tomcat server that can be configured to run CGI scripts. However, enabling CGI can introduce additional load on the AppBoard server and raises it's own security concerns. This document simply covers enabling CGI but thought should go into the issues mentioned.

	~~{{Warning\|Enabling CGI can introduce additional load on the AppBoard~~ server and ~~raises it's own security concerns. This document simply covers enabling CGI but thought should go into~~ the ~~issues mentioned~~.}}		An alternative is to set up a separate web server environment for custom applications and then include the content via enPortal proxy channels.

	=== Steps to Enable CGI ===		=== Steps to Enable CGI ===

imported>Jason.nicholls at 05:59, 19 September 2013

2013-09-19T05:59:57Z

← Older revision		Revision as of 05:59, 19 September 2013
Line 17:		Line 17:
	# Restart AppBoard.		# Restart AppBoard.

	{{Note\|Changes to <tt>web.xml</tt> and <tt>context.xml</tt> are '''not''' archived by default. ~~While it's possible~~ to ~~change the archive properties files and~~ include these files they are considered ~~systems~~ files and may change release to release~~. In other words, on upgrade it must be verified the there are no changes to these files (beyond enabling CGI)~~.}}		{{Note\|Changes to <tt>web.xml</tt> and <tt>context.xml</tt> are '''not''' archived by default. If changes are made to include these files in archives then they must be manually verified to match the latest version on upgrade. These are considered system files and may change release to release.}}

	=== Additional Information ===		=== Additional Information ===

imported>Jason.nicholls: /* Additional Information */

2013-09-19T05:58:19Z

Additional Information

← Older revision		Revision as of 05:58, 19 September 2013
Line 26:		Line 26:
	* CGI files should be placed into <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/cgi/</tt>		* CGI files should be placed into <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/cgi/</tt>
	* URL to access CGIs: <tt>[http://localhost:8080/enportal/cgi-bin/sample.cgi /enportal/cgi-bin/''sample.cgi'']</tt>		* URL to access CGIs: <tt>[http://localhost:8080/enportal/cgi-bin/sample.cgi /enportal/cgi-bin/''sample.cgi'']</tt>

			For more information on CGI in Tomcat please refer to the [http://tomcat.apache.org/tomcat-7.0-doc/cgi-howto.html Tomcat CGI How To] documentation.

imported>Jason.nicholls: /* Additional Information */

2013-09-19T05:55:48Z

Additional Information

← Older revision		Revision as of 05:55, 19 September 2013
Line 25:		Line 25:
	* CGI interpreter is the system <tt>perl</tt>. To change this it's necessary to modify the CGI servlet section and set the <tt>executable</tt> parameter.		* CGI interpreter is the system <tt>perl</tt>. To change this it's necessary to modify the CGI servlet section and set the <tt>executable</tt> parameter.
	* CGI files should be placed into <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/cgi/</tt>		* CGI files should be placed into <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/cgi/</tt>
	* URL to access CGIs: <tt>[http://localhost:8080/enportal/cgi-bin/''sample.cgi'' /enportal/cgi-bin/sample.cgi]</tt>		* URL to access CGIs: <tt>[http://localhost:8080/enportal/cgi-bin/sample.cgi /enportal/cgi-bin/''sample.cgi'']</tt>

imported>Jason.nicholls at 05:55, 19 September 2013

2013-09-19T05:55:22Z

← Older revision		Revision as of 05:55, 19 September 2013
Line 21:		Line 21:
	=== Additional Information ===		=== Additional Information ===

	~~Enabling~~ CGI ~~with default~~ options		The default CGI options are as follows:

			* CGI interpreter is the system <tt>perl</tt>. To change this it's necessary to modify the CGI servlet section and set the <tt>executable</tt> parameter.
			* CGI files should be placed into <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/cgi/</tt>
			* URL to access CGIs: <tt>[http://localhost:8080/enportal/cgi-bin/''sample.cgi'' /enportal/cgi-bin/sample.cgi]</tt>

imported>Jason.nicholls at 05:51, 19 September 2013

2013-09-19T05:51:01Z

← Older revision		Revision as of 05:51, 19 September 2013
Line 5:		Line 5:
	{{Warning\|Enabling CGI can introduce additional load on the AppBoard server and raises it's own security concerns. This document simply covers enabling CGI but thought should go into the issues mentioned.}}		{{Warning\|Enabling CGI can introduce additional load on the AppBoard server and raises it's own security concerns. This document simply covers enabling CGI but thought should go into the issues mentioned.}}

	~~To enable~~ CGI ~~follow these steps:~~		=== Steps to Enable CGI ===

	# Edit <tt>[INSTALL_HOME]/server/conf/web.xml</tt>		# Edit <tt>[INSTALL_HOME]/server/conf/web.xml</tt>
Line 14:		Line 14:
	## add the parameter <tt>privileged="true"</tt> to the <Context ... > tag on line 19.		## add the parameter <tt>privileged="true"</tt> to the <Context ... > tag on line 19.
	## save changes.		## save changes.
			## create the directory <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/'''cgi'''</tt>
	# Restart AppBoard.		# Restart AppBoard.

			{{Note\|Changes to <tt>web.xml</tt> and <tt>context.xml</tt> are '''not''' archived by default. While it's possible to change the archive properties files and include these files they are considered systems files and may change release to release. In other words, on upgrade it must be verified the there are no changes to these files (beyond enabling CGI).}}

	~~{{Note\|Changes to web.xml and context.xml are '''not''' archived by~~ default. While it's possible to change the archive properties files and include these files they are considered systems files and may change release to release. In other words, on upgrade it must be verified the there are no changes to these files (beyond enabling CGI).}}		=== Additional Information ===

			Enabling CGI with default options

imported>Jason.nicholls at 05:47, 19 September 2013

2013-09-19T05:47:27Z

← Older revision		Revision as of 05:47, 19 September 2013
Line 6:		Line 6:

	To enable CGI follow these steps:		To enable CGI follow these steps:

			# Edit <tt>[INSTALL_HOME]/server/conf/web.xml</tt>
			## uncomment the CGI servlet section, lines 333 through 347
			## uncomment the CGI servlet-mapping section, lines 381 through 386
			## save changes.
			# Edit <tt>[INSTALL_HOME]/server/conf/context.xml</tt>
			## add the parameter <tt>privileged="true"</tt> to the <Context ... > tag on line 19.
			## save changes.
			# Restart AppBoard.


	{{Note\|Changes to web.xml and context.xml are '''not''' archived by default. While it's possible to change the archive properties files and include these files they are considered systems files and may change release to release. In other words, on upgrade it must be verified the there are no changes to these files (beyond enabling CGI).}}		{{Note\|Changes to web.xml and context.xml are '''not''' archived by default. While it's possible to change the archive properties files and include these files they are considered systems files and may change release to release. In other words, on upgrade it must be verified the there are no changes to these files (beyond enabling CGI).}}

imported>Jason.nicholls at 05:39, 19 September 2013

2013-09-19T05:39:44Z

← Older revision		Revision as of 05:39, 19 September 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:Enabling CGI}}		{{DISPLAYTITLE:Enabling CGI}}

	~~The~~ Apache Tomcat server ~~AppBoard runs in~~ can be configured to ~~enable running of~~ CGI scripts.		AppBoard runs on an Apache Tomcat server that can be configured to run CGI scripts.

	{{~~Note~~\|Enabling ~~and writing~~ CGI ~~scripts~~ can introduce additional load on the AppBoard server and security concerns. This document simply covers enabling CGI but thought should go into the issues mentioned.}}		{{Warning\|Enabling CGI can introduce additional load on the AppBoard server and raises it's own security concerns. This document simply covers enabling CGI but thought should go into the issues mentioned.}}

			To enable CGI follow these steps:


			{{Note\|Changes to web.xml and context.xml are '''not''' archived by default. While it's possible to change the archive properties files and include these files they are considered systems files and may change release to release. In other words, on upgrade it must be verified the there are no changes to these files (beyond enabling CGI).}}