Autobackup - Revision history

Manni at 08:05, 25 April 2022

2022-04-25T08:05:30Z

Manni at 07:54, 25 April 2022

2022-04-25T07:54:14Z

Manni at 07:51, 25 April 2022

2022-04-25T07:51:50Z

Ferd Frederix: /* Autobackup details */ More details on [Autobackup] operation and an example

2017-02-25T03:35:42Z

‎Autobackup details: More details on [Autobackup] operation and an example

Ferd Frederix: /* AutoBackupSkipAssets */ Params taken from proposal and source code for 0.9

2017-02-22T16:20:41Z

‎AutoBackupSkipAssets: Params taken from proposal and source code for 0.9

Justincc at 16:27, 8 July 2014

2014-07-08T16:27:52Z

Justincc: /* Settings added since OpenSimulator 0.7.6 */

2014-07-08T16:26:53Z

‎Settings added since OpenSimulator 0.7.6

Justincc: Created page with "=Introduction= This is a stub page for the experimental autobackup module that has been included with OpenSimulator since 0.7.6. This module aims to regularly save region ar..."

2014-07-08T16:26:45Z

Created page with "=Introduction= This is a stub page for the experimental autobackup module that has been included with OpenSimulator since 0.7.6. This module aims to regularly save region ar..."

New page

=Introduction=

This is a stub page for the experimental autobackup module that has been included with OpenSimulator since 0.7.6. This module aims to regularly save region archives for backup or archive purposes. Over time, working documentation needs to be transferred here. In the meantime, please see the [[Feature Proposals/Autobackup]] page.

=Configuration=

Settings can be configured either in OpenSim.ini or associated simulator-wide config files (to affect backup of all regions on the simulator) or per region in the Regions.ini files. The same settings are used in each file.

For most settings, please currently refer to the [[Feature Proposals/Autobackup]] page.

== Settings added since OpenSimulator 0.7.6 ==

=== AutoBackupSkipAssets ===

Set as

<source lang="ini">
[AutoBackupModule]
AutoBackupSkipAssets = true|false
</source>

This governs whether OARs are generated containing assets. It can be very useful to set this to true if you are backing up the asset service database by other means. Otherwise, the generated archives may take up a very large amount of space as each will require their own copy of every asset referenced by the region.

Default setting is false.

← Older revision		Revision as of 08:05, 25 April 2022
Line 151:		Line 151:

	</source>		</source>
		+
		+	[[Category:Configuration]]

@@ Line 1: / Line 1: @@
-{{Quicklinks}}
+{{Languages|Autobackup}}
 <br />
 =Introduction=

← Older revision		Revision as of 07:51, 25 April 2022
Line 1:		Line 1:
		+	{{Quicklinks}}
		+	<br />
	=Introduction=		=Introduction=

@@ Line 19: / Line 19: @@
 <source lang="ini">
 [AutoBackupModule]
+;
-;AutoBackupModuleEnabled: True/False. Default: False. If False, every
+; Global (in OpenSim.ini) or Per-Region (in Regions/Regions.ini under the region's name's section)
-;function in the module is as no-op as possible: just return as soon as
-;realizing that we're not enabled. Otherwise it will try to get as far as it
-;can with auto backup for each region.
-; Global (in OpenSim.ini) or Per-Region (in Regions/Regions.ini under theregion's name's section)
 ; IMPORTANT: Settings declared per-region in Regions/Regions.ini override
 ;settings in OpenSim.ini. Settings in OpenSim.ini, in turn, override
-;hard-coded defaults.  AutoBackup: True/False. Default: False. If True,
+;hard-coded defaults.
 ;activate auto backup functionality. This is the only required option for
 ;enabling auto-backup; the other options have sane defaults. If False, the
 ;auto-backup module becomes a no-op for the region, and all other
 ;AutoBackup* settings are ignored.
 ; AutoBackupModuleEnabled: True/False. Default: False. If False, every
 ;function in the module is as no-op as possible: just return as soon as
 ;realizing that we're not enabled. Otherwise it will try to get as far as it
 ;can with auto backup for each region.
 ; AutoBackupInterval: Integer, non-negative value. Default: 720 (12
 ;hours). The number of minutes between each backup attempt. If a negative or
 ;zero value is given, it is equivalent to setting AutoBackup = False.
 ; AutoBackupBusyCheck: True/False. Default: True. If True, we will only
 ;take an auto-backup if a set of conditions are met. These conditions are
 ;heuristics to try and avoid taking a backup when the sim is busy.
 ; AutoBackupScript: String. Default: not specified (disabled). File path
 ;to an executable script or binary to run when an automatic backup is taken.
@@ Line 52: / Line 59: @@
 ;OAR. If the process can't be spawned for some reason (file not found, no
 ;execute permission, etc), write a warning to the console.
 ; AutoBackupNaming: string. Default: Time.  One of three strings (case
 ;insensitive):
@@ Line 61: / Line 71: @@
 ;  "Overwrite": Always save to file named "RegionName.oar", even if we
 ;have to overwrite an existing file.
-; AutoBackupDir: String. Default: "." (the current directory). A directory
-;(absolute or relative) where backups should be saved. If the path is not a
+; AutoBackupNaming = Time
-;directory, or insufficient permissions are available, a warning will be
-;printed to the console and no backups will be taken.
 ; AutoBackupDilationThreshold: float. Default: 0.5. Lower bound on time
 ;dilation required for BusyCheck heuristics to pass.  If the time dilation
 ;is below this value, don't take a backup right now.
 ; AutoBackupAgentThreshold: int. Default: 10. Upper bound on # of agents
 ;in region required for BusyCheck heuristics to pass.  If the number of
 ;agents is greater than this value, don't take a backup right now.
 ; AutoBackupKeepFilesForDays: int. Default: 0.
 ;   1) number of days to keep backups (0 the default value will disable
@@ Line 80: / Line 95: @@
 ;auto-backup, or manually created or uploaded. It is not recommended to use
 ;the bin directory for your auto backups for this reason.
+;
-;; Typical settings for AutoBackup:
 AutoBackupModuleEnabled = true
@@ Line 109: / Line 147: @@
 AutoBackupDir = "../AutoBackup"
 </source>

@@ Line 11: / Line 11: @@
 == Settings added since OpenSimulator 0.8 ==
-Set as
+This governs whether OARs are automatically generated containing assets.  It can be very useful to set this to true if you are backing up the asset service database by other means.  Otherwise, the generated archives may take up a very large amount of space as each will require their own copy of every asset referenced by the region.
 <source lang="ini">
 [AutoBackupModule]
-This governs whether OARs are generated containing assets.  It can be very useful to set this to true if you are backing up the asset service database by other means.  Otherwise, the generated archives may take up a very large amount of space as each will require their own copy of every asset referenced by the region.
-Default setting is false.
+;; Typical settings for AutoBackup:

@@ Line 1: / Line 1: @@
 =Introduction=
-This is a stub page for the experimental autobackup module that has been included with OpenSimulator since 0.7.6.  This module aims to regularly save region archives for backup or archive purposes.  Over time, working documentation needs to be transferred here.  In the meantime, please see the [[Feature Proposals/Autobackup]] page.
+This is a stub page for the experimental autobackup module that has been included with OpenSimulator since 0.7.6.  This module aims to regularly save region archives for backup or archive purposes.  Over time, working documentation needs to be transferred here.  In the meantime, please see the [[Feature Proposals/AutoBackup]] page.
 =Configuration=
@@ Line 7: / Line 7: @@
 Settings can be configured either in OpenSim.ini or associated simulator-wide config files (to affect backup of all regions on the simulator) or per region in the Regions.ini files.  The same settings are used in each file.
-For most settings, please currently refer to the [[Feature Proposals/Autobackup]] page.
+For most settings, please currently refer to the [[Feature Proposals/AutoBackup]] page.
 == Settings added since OpenSimulator 0.8 ==

@@ Line 9: / Line 9: @@
 For most settings, please currently refer to the [[Feature Proposals/Autobackup]] page.
-== Settings added since OpenSimulator 0.7.6 ==
+== Settings added since OpenSimulator 0.8 ==
 === AutoBackupSkipAssets ===