Skip to content

Commit 4bfeb6b

Browse files
committed
bump
1 parent eb3106e commit 4bfeb6b

File tree

3 files changed

+58
-11
lines changed

3 files changed

+58
-11
lines changed

README.md

Lines changed: 56 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,62 @@ We can store all the files which have been modified, into a ZIP file.
2626

2727
## Settings
2828

29-
| Key | Description |
30-
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
31-
| Start backup at launch | When the plug-in has been loaded, Differential backup will be created automatically. |
32-
| Use Desktop Mode | When enabled, We can use internal API and store backups anywhere you want. This feature is on the bleeding edge. Not safe. Only available on desktop devices. |
33-
| Backup folder | The folder which backups are stored. We can choose only the folder inside the vault. |
34-
| Backup folder (desktop) | The folder which backups are stored (if enabling `Use Desktop Mode`). We can choose any folder (Absolute path recommended). |
35-
| Restore folder | The folder which restored files will be stored. |
36-
| Include hidden folder | Backup also the configurations, plugins, themes, and, snippets. |
37-
| ZIP splitting size | An large file are not good for handling, so this plug-in splits the backup ZIP into this size. This splitted ZIP files can be handled by 7Z or something archiver. |
29+
30+
### General
31+
32+
| Key | Description |
33+
| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34+
| Start backup at launch | When the plug-in has been loaded, Differential backup will be created automatically. |
35+
| Include hidden folder | Backup also the configurations, plugins, themes, and, snippets. |
36+
| Backup Destination | Where to save the backup `Inside the vault`, `Anywhere (Desktop only)`, and `S3 bucket` are available. `Anywhere` is on the bleeding edge. Not safe. Only available on desktop devices. |
37+
| Restore folder | The folder which restored files will be stored. |
38+
| Max files in a single zip | How many files are stored in a single ZIP file. |
39+
| Perform all files over the max files | Automatically process the remaining files, even if the number of files to be processed exceeds Max files. |
40+
| ZIP splitting size | An large file are not good for handling, so this plug-in splits the backup ZIP into this size. This splitted ZIP files can be handled by 7Z or something archiver. |
41+
42+
43+
### On `Inside the vault`
44+
45+
| Key | Description |
46+
| ------------- | ------------------------------------------------------------------------------------ |
47+
| Backup folder | The folder which backups are stored. We can choose only the folder inside the vault. |
48+
49+
### On `Anywhere (Desktop only)`
50+
51+
| Key | Description |
52+
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------- |
53+
| Backup folder (desktop) | The folder which backups are stored (if enabling `Use Desktop Mode`). We can choose any folder (Absolute path recommended). |
54+
55+
56+
### On `S3 Compatible bucket`
57+
| Key | Description |
58+
| ----------------------- | ------------------------------------------------------------------------------------- |
59+
| Endpoint | The endpoint of the S3 bucket. |
60+
| AccessKey | The access key ID of the S3 bucket. |
61+
| SecretKey | The secret access key of the S3 bucket. |
62+
| Region | The region of the S3 bucket. |
63+
| Bucket | The name of the S3 bucket. |
64+
| Use Custom HTTP Handler | Use a custom HTTP handler for S3. This is useful for mobile devices services. |
65+
| Backup folder | The folder which backups are stored. We can choose only the folder inside the bucket. |
66+
67+
#### Buttons
68+
- `Test`: Test the connection to the S3 bucket.
69+
- `Create Bucket`: Create a bucket in the S3 bucket.
70+
71+
72+
## Misc
73+
74+
### Reset Backup Information
75+
If you want to make a full backup, you can reset the backup information. This will make all files to be backed up.
76+
77+
### Encryption
78+
If you configure the passphrase, the ZIP file will be encrypted by AES-256-CBC with the passphrase.
79+
80+
>[!IMPORTANT]
81+
> Not compatible with the encrypted zip file. We have to decrypt the file by OpenSSL, without this plug-in.
82+
> Decryption command is `openssl enc -d -aes-256-cbc -in <encrypted file> -out <decrypted file> -k <passphrase> -pbkdf2 -md sha256`.
83+
84+
3885

3986

4087
## What is `backupinfo.md`?

manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"id": "diffzip",
33
"name": "Differential ZIP Backup",
4-
"version": "0.0.9",
4+
"version": "0.0.10",
55
"minAppVersion": "0.15.0",
66
"description": "Back our vault up with lesser storage.",
77
"author": "vorotamoroz",

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "diffzip",
3-
"version": "0.0.9",
3+
"version": "0.0.10",
44
"description": "Differential ZIP Backup",
55
"main": "main.js",
66
"scripts": {

0 commit comments

Comments
 (0)