Changes for page Backup/Restore

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -52,21 +52,10 @@
52	52
53	53	= Backup Permanent Data =
54	54
55		-XWiki generates & saves data in the [[permanent directory>>platform:AdminGuide.Configuration||anchor="HConfiguringDirectories"]] of XWiki and it's important that you back them up. If you've installed the default standalone version of XWiki then the Permanent Directory is located in the ##data/## directory inside the directory where you've installed XWiki. If you have installed the XWiki WAR, you'll find this directly in the location pointed by the ##environment.permanentDirectory## configuration property in your ##WEB-INF/xwiki.properties## configuration file. Backing up this Permanent Directory will backup all files generated by XWiki (in addition to what's in the database).
	55	+XWiki generates & saves data in the [[permanent directory>>platform:AdminGuide.Configuration||anchor="HConfiguringDirectories"]] of XWiki and it's important that you back it up.
56	56
57		-List of sub-directories in the permanent directory:
58		-* ##store##: Data stores
59		-** ##store/file##: Attachments ([[when they're saved on the filesystem>>platform:AdminGuide.Attachments||anchor="HAttachmentStorage"]], which is the default, otherwise they're saved in the database). Note that even when attachments are saved on the filesystem the attachment metadata are saved in the database (e.g. creator, date, etc).
60		-** ##store/solr##: Solr configurations and data that are not cache data (cache data for in ##cache##, see below).
61		-* ##extension##: Installed extensions.
62		-* ##cache##: Cache files. These files and subdirectories can be removed and do not necessarily need to be backed up. However if you don't back them up, XWiki will need to regenerate them (e.g. the Solr seach indexes) and that can take a lot of time. It's this recommended to back them up too. Examples of what's contained in the cache:
63		-** Solr search indexes
64		-** Descriptors of core extensions. If you delete them, XWiki will simply try to resolve those extensions again at startup but it won't need to resolve much since the WAR embeds complete descriptors for all the JARs. Removing this directory allows cleaning descriptors that were downloaded in previous versions of XWiki.
65		-** FOP Font cache
66		-* ##mails##: The [[Mail Sender API>>extensions:Extension.Mail Sender API]] (used by several features of XWiki that require sending mails) will serialize email messages in this directory before they are sent, so that if XWiki crashes or is stopped, those mails are not lost and can be resent. Once a mail is successfully sent, its associated file is removed from this directory. Thus this directory will contain mails that failed to be sent.
67		-* ##logs##: Contains the xwiki logs but this is only true for the [[XWiki Standalone packaging>>Documentation.AdminGuide.Installation.WebHome||anchor="HInstallationMethods"]] which has Jetty configured to generate its logs in this directory.
68		-* ##jobs##: Logs and statuses of the various jobs that executed inside XWiki (e.g. when deleting a page or set of pages a job is used). It also contains the status of the Flavor which is setup as a job. Removing this directory can cause problems (it'll remove the status of the Flavor for example).
69		-* ##database##: This is only true for the [[XWiki Standalone packaging>>Documentation.AdminGuide.Installation.WebHome||anchor="HInstallationMethods"]] and it contains the HSQLDB database data (i.e. the wiki pages and more).
	57	+Notes:
	58	+* The ##cache## directory can be removed and does not necessarily need to be backed up. However if you don't back it up, XWiki will need to regenerate its content (e.g. the Solr seach indexes) and that can take a lot of time. It's thus recommended to back it up too.
70	70
71	71	= Backup Log files =
72	72