Appboard/2.4/admin/backup and recovery - Revision history

imported>Jason.nicholls: /* Customizing the Export */

2014-09-29T15:14:58Z

Customizing the Export

← Older revision		Revision as of 15:14, 29 September 2014
Line 64:		Line 64:
	Recommended best practices is to ensure that backups include all required files for a functioning system. In many cases this is handled automatically by placing custom files within the supplied ''custom'' directories. Some files fall outside this pattern however and to handle these it's necessary to customize the export file set by creating a <tt>custom.properties</tt> file and placing it into the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt> directory.		Recommended best practices is to ensure that backups include all required files for a functioning system. In many cases this is handled automatically by placing custom files within the supplied ''custom'' directories. Some files fall outside this pattern however and to handle these it's necessary to customize the export file set by creating a <tt>custom.properties</tt> file and placing it into the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt> directory.

	This file can be used for various overrides so may exist for other purposes already. The key part is to define a <tt>export.custom.other</tt> property with the list of files to be exported, ~~so for~~ example:		This file can be used for various overrides so may exist for other purposes already. The key part is to define a <tt>export.custom.other</tt> property with the list of files to be exported. This is a semi-colon (<tt>;</tt>) separated list, with the backslash character (<tt>\</tt>) used to split the list over multiple lines to improve readability. For example:


	<pre>		<pre>

imported>Jason.nicholls: /* Customizing the Export */

2014-09-29T15:14:30Z

Customizing the Export

← Older revision		Revision as of 15:14, 29 September 2014
Line 70:		Line 70:
	export.custom.other=${webapp.webinf}/lib/mysql-connector-java-5.1.19.jar;\		export.custom.other=${webapp.webinf}/lib/mysql-connector-java-5.1.19.jar;\
	${webapp.webinf}/lib/jtds-1.2.4.jar;\		${webapp.webinf}/lib/jtds-1.2.4.jar;\
	${webapp.xmlroot}/appboard/config/iconregistry/custom_icons.csv		${webapp.xmlroot}/appboard/config/iconregistry/custom_icons.csv;\
	${webapp.home}/visualizer/assets/images/custom_banner_logo.png		${webapp.home}/visualizer/assets/images/custom_banner_logo.png
	</pre>		</pre>

imported>Andy.hopper: /* Troubleshooting */

2014-02-06T16:36:21Z

Troubleshooting

← Older revision		Revision as of 16:36, 6 February 2014
Line 118:		Line 118:
	** AppBoard is still running. Make sure AppBoard is shut down prior to running the restore command.		** AppBoard is still running. Make sure AppBoard is shut down prior to running the restore command.
	** The system was improperly shut down and there is a lock file in the H2 folder (/server/webapps/enportal/WEB-INF/h2/). Delete the lock file (persist.lock.db) and run the restore command again.		** The system was improperly shut down and there is a lock file in the H2 folder (/server/webapps/enportal/WEB-INF/h2/). Delete the lock file (persist.lock.db) and run the restore command again.


	{{Note\|AppBoard stores widget configuration in XML which cannot contain some non-printable characters. If such characters are identified during a backup or restore operation, they will be removed to avoid runtime errors. However, introducing such characters is not a pitfall that users would typically fall into: the board or widget configuration itself would have to contain the non-printable characters.}}		{{Note\|AppBoard stores widget configuration in XML which cannot contain some non-printable characters. If such characters are identified during a backup or restore operation, they will be removed to avoid runtime errors. However, introducing such characters is not a pitfall that users would typically fall into: the board or widget configuration itself would have to contain the non-printable characters.}}

imported>Andy.hopper: /* Troubleshooting */

2014-02-06T16:36:02Z

Troubleshooting

← Older revision		Revision as of 16:36, 6 February 2014
Line 118:		Line 118:
	** AppBoard is still running. Make sure AppBoard is shut down prior to running the restore command.		** AppBoard is still running. Make sure AppBoard is shut down prior to running the restore command.
	** The system was improperly shut down and there is a lock file in the H2 folder (/server/webapps/enportal/WEB-INF/h2/). Delete the lock file (persist.lock.db) and run the restore command again.		** The system was improperly shut down and there is a lock file in the H2 folder (/server/webapps/enportal/WEB-INF/h2/). Delete the lock file (persist.lock.db) and run the restore command again.


			{{Note\|AppBoard stores widget configuration in XML which cannot contain some non-printable characters. If such characters are identified during a backup or restore operation, they will be removed to avoid runtime errors. However, introducing such characters is not a pitfall that users would typically fall into: the board or widget configuration itself would have to contain the non-printable characters.}}

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

2013-12-14T06:39:17Z

← Older revision		Revision as of 06:39, 14 December 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:Backup & Recovery}}		{{DISPLAYTITLE:Backup & Recovery}}
			[[Category:AppBoard 2.4]]
	A typical AppBoard deployment will consist of:		A typical AppBoard deployment will consist of:

imported>David.moore: /* Loading Backups (archives) */

2013-11-26T14:26:04Z

Loading Backups (archives)

← Older revision		Revision as of 14:26, 26 November 2013
Line 105:		Line 105:
	\|-		\|-
	\| Apply		\| Apply
	\| This command is intended when moving an archive from one host to another ~~and~~ will preserve the ~~existing:~~ license file, SSL configuration, other runtime configuration (<tt>setenv-custom.sh</tt>). The host where the ''Apply'' is run will need to have this configuration already set up otherwise AppBoard will not start (i.e. no license).		\| This command is intended when moving an archive from one host to another, but it will not preserve the license file, SSL configuration, or other runtime configuration (<tt>setenv-custom.sh</tt>). The host where the ''Apply'' is run will need to have this configuration already set up otherwise AppBoard will not start (i.e. no license).
	\|}		\|}

imported>Jason.nicholls at 17:03, 30 September 2013

2013-09-30T17:03:45Z

← Older revision		Revision as of 17:03, 30 September 2013
Line 14:		Line 14:
	* it's best practices to keep backups		* it's best practices to keep backups
	* provide a mechanism to migrate configuration from one environment to another, for example from development, to staging, to production.		* provide a mechanism to migrate configuration from one environment to another, for example from development, to staging, to production.
			* used when upgrading AppBoard itself.
	* provide a way for Edge to further investigate support issues - sometimes we may request a backup archive.		* provide a way for Edge to further investigate support issues - sometimes we may request a backup archive.

imported>Jason.nicholls: /* Backup AppBoard Option */

2013-09-30T17:01:37Z

Backup AppBoard Option

← Older revision		Revision as of 17:01, 30 September 2013
Line 49:		Line 49:
	Use the ''Backup All'' option for full system backups.		Use the ''Backup All'' option for full system backups.

	In addition, a special procedure is required to load an AppBoard only backup onto an existing server without losing ~~any~~ other configuration, i.e. this is not necessary for a clean AppBoard installation. Instead of a ''Restore'' or ''Apply'' command, the ''FilesImport'' command should be used. This will overlay the files onto the filesystem without resetting the configuration database. The following steps are also required to ensure data sources are loaded correctly:		In addition, a special procedure is required to load an AppBoard only backup onto an existing server without losing other configuration, i.e. this is not necessary for a clean AppBoard installation. Instead of a ''Restore'' or ''Apply'' command, the ''FilesImport'' command should be used. This will overlay the files onto the filesystem without resetting the configuration database. All AppBoard content will be replaced however. The following steps are also required to ensure data sources are loaded correctly:

	# Shut down AppBoard.		# Shut down AppBoard.

imported>Jason.nicholls: /* Backup AppBoard Option */

2013-09-30T17:00:54Z

Backup AppBoard Option

← Older revision		Revision as of 17:00, 30 September 2013
Line 49:		Line 49:
	Use the ''Backup All'' option for full system backups.		Use the ''Backup All'' option for full system backups.

	In addition a special procedure is required to load an AppBoard only backup onto an existing server without losing any other configuration, i.e. this is not necessary for a clean AppBoard installation. Instead of a ''Restore'' or ''Apply'' command, the ''FilesImport'' command should be used. This will overlay the files onto the filesystem without resetting the configuration database. The following steps are also required to ensure data sources are loaded correctly:		In addition, a special procedure is required to load an AppBoard only backup onto an existing server without losing any other configuration, i.e. this is not necessary for a clean AppBoard installation. Instead of a ''Restore'' or ''Apply'' command, the ''FilesImport'' command should be used. This will overlay the files onto the filesystem without resetting the configuration database. The following steps are also required to ensure data sources are loaded correctly:

	# Shut down AppBoard.		# Shut down AppBoard.

imported>Jason.nicholls: /* Loading Backups (archives) */

2013-09-30T16:58:01Z

Loading Backups (archives)

← Older revision		Revision as of 16:58, 30 September 2013
Line 109:		Line 109:

	{{Note\|Regardless of a ''Restore'' or ''Apply'', on Linux / UNIX platforms it is recommended re-run <tt>post_install.sh</tt>. See [[appboard/2.4/admin/unix_installation\|Linux / UNIX Installation - Restoring an Archive]] for more information.}}		{{Note\|Regardless of a ''Restore'' or ''Apply'', on Linux / UNIX platforms it is recommended re-run <tt>post_install.sh</tt>. See [[appboard/2.4/admin/unix_installation\|Linux / UNIX Installation - Restoring an Archive]] for more information.}}


	== Troubleshooting ==		== Troubleshooting ==