|
| 1 | +# Configuration |
| 2 | + |
| 3 | +## Configuration location |
| 4 | + |
| 5 | +```none |
| 6 | +.minecraft/config/ProjectEssentials/backup.json |
| 7 | +``` |
| 8 | + |
| 9 | +## Configuration description |
| 10 | + |
| 11 | +It configuration file store settings for backup making |
| 12 | + |
| 13 | +## Default configuration |
| 14 | + |
| 15 | +```json |
| 16 | +{ |
| 17 | + "backupEnabled": true, |
| 18 | + "firstLaunchDelay": true, |
| 19 | + "backupCreationDelay": 120000, |
| 20 | + "backupCompressionLevel": 3, |
| 21 | + "backupDirectoryPath": "backup", |
| 22 | + "backupDateFormat": "yyyy-MM-dd_HH.mm.ss", |
| 23 | + "maxBackupFiles": 10, |
| 24 | + "rollingBackupFilesEnabled": true, |
| 25 | + "removeExtraFiles": true |
| 26 | +} |
| 27 | +``` |
| 28 | + |
| 29 | +## Small documentation :) |
| 30 | + |
| 31 | +Sorry for the very bad English, maybe you can fix it in Pull request. |
| 32 | + |
| 33 | +| Property | Type | Description | |
| 34 | +|--- |--- |--- | |
| 35 | +|`backupEnabled` |`Boolean` |If value false then backup loop will be stopped.| |
| 36 | +|`firstLaunchDelay` |`Boolean` |If value true then backup not will be making at server start. (i.e if value `true` then: `server start -> delay -> backup -> delay`, if value false `then`: `server start -> backup -> delay`)| |
| 37 | +|`backupCreationDelay` |`Long` |Delay between backup in milliseconds.| |
| 38 | +|`backupCompressionLevel` |`Int` |Compression level for zip file. Allowed range is `1 - 9` (1 - low compression, 9 - high compression).| |
| 39 | +|`backupDirectoryPath` |`String` |Path to backup directory.| |
| 40 | +|`backupDateFormat` |`String` |Date format for backup archive.| |
| 41 | +|`maxBackupFiles` |`Int` |Maximum backup files in backup directory.| |
| 42 | +|`rollingBackupFilesEnabled` |`Boolean` |New backup file is created periodically, and the old backup file is renamed by appending a date to the name. Each time a new backup file is started, the numbers in the file names of old backup files are increased by one, so the files "rotate" through the dates. Old backup files whose number exceeds a threshold can then will be deleted to save space.| |
| 43 | +|`removeExtraFiles` |`Boolean` |If value true then extra files will be deleted from backup directory, i.e random files, not backup files.| |
| 44 | + |
| 45 | +## If you have any questions or encounter a problem, be sure to open an [issue](https://github.com/ProjectEssentials/ProjectEssentials-Backup/issues/new/choose) |
0 commit comments