joplin-plugin-backup 1.3.6 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +43 -25
  2. package/package.json +2 -2
  3. package/publish/io.github.jackgruber.backup.jpl +0 -0
  4. package/publish/io.github.jackgruber.backup.json +4 -4
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Joplin Backup Plugin <img src=img/icon_32.png>
1
+ # Joplin Plugin: Backup <img src=img/icon_32.png>
2
2
 
3
3
  A plugin to extend Joplin with a manual and automatic backup function.
4
4
 
@@ -12,7 +12,8 @@ A plugin to extend Joplin with a manual and automatic backup function.
12
12
  <!-- TOC depthfrom:2 orderedlist:false -->
13
13
 
14
14
  - [Installation](#installation)
15
- - [Automatic](#automatic)
15
+ - [Replace Joplin built-in plugin via GUI](#replace-joplin-built-in-plugin-via-gui)
16
+ - [Replace Joplin built-in plugin via file system](#replace-joplin-built-in-plugin-via-file-system)
16
17
  - [Manual](#manual)
17
18
  - [Usage](#usage)
18
19
  - [Options](#options)
@@ -21,11 +22,14 @@ A plugin to extend Joplin with a manual and automatic backup function.
21
22
  - [Restore](#restore)
22
23
  - [Settings](#settings)
23
24
  - [Notes](#notes)
25
+ - [Restore a singel note](#restore-a-singel-note)
24
26
  - [FAQ](#faq)
25
27
  - [Internal Joplin links betwen notes are lost](#internal-joplin-links-betwen-notes-are-lost)
26
28
  - [Combine multiple JEX Files to one](#combine-multiple-jex-files-to-one)
27
29
  - [Open a JEX Backup file](#open-a-jex-backup-file)
28
30
  - [Are Note History Revisions backed up?](#are-note-history-revisions-backed-up)
31
+ - [Are all Joplin profiles backed up?](#are-all-joplin-profiles-backed-up)
32
+ - [The Joplin build-in version of the plugin cannot be updated](#the-joplin-build-in-version-of-the-plugin-cannot-be-updated)
29
33
  - [Changelog](#changelog)
30
34
  - [Links](#links)
31
35
 
@@ -34,12 +38,23 @@ A plugin to extend Joplin with a manual and automatic backup function.
34
38
 
35
39
  ## Installation
36
40
 
37
- ### Automatic
41
+ The plugin is installed as built-in plugin in Joplin version `2.14.6` and newer.
42
+ The built-in plugin cannot be updated via GUI, to update to a other version replace the built-in version.
38
43
 
39
- - Go to `Tools > Options > Plugins`
40
- - Search for `Simple Backup`
41
- - Click Install plugin
42
- - Restart Joplin to enable the plugin
44
+ ### Replace Joplin built-in plugin via GUI
45
+
46
+ - Download the latest released JPL package (`io.github.jackgruber.backup.jpl`) from [here](https://github.com/JackGruber/joplin-plugin-backup/releases/latest)
47
+ - Go to `Tools > Options > Plugins` in Joplin
48
+ - Click on the gear wheel and select `Install from file`
49
+ - Select the downloaded JPL file
50
+ - Restart Joplin
51
+
52
+ ### Replace Joplin built-in plugin via file system
53
+
54
+ - Download the latest released JPL package (`io.github.jackgruber.backup.jpl`) from [here](https://github.com/JackGruber/joplin-plugin-backup/releases/latest)
55
+ - Close Joplin
56
+ - Got to your Joplin profile folder and place the JPL file in the `plugins` folder
57
+ - Start Joplin
43
58
 
44
59
  ### Manual
45
60
 
@@ -51,6 +66,7 @@ A plugin to extend Joplin with a manual and automatic backup function.
51
66
  ## Usage
52
67
 
53
68
  First configure the Plugin under `Tools > Options > Backup`!
69
+ The plugin must be configured separately for each Joplin profile.
54
70
 
55
71
  Backups can be created manually with the command `Tools > Create backup` or are created automatically based on the configured interval.
56
72
  The backup started manually by `Create backup` respects all the settings except for the `Backups interval in hours`.
@@ -59,24 +75,6 @@ The backup started manually by `Create backup` respects all the settings except
59
75
 
60
76
  Go to `Tools > Options > Backup`
61
77
 
62
- | Option | Description | Default |
63
- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------- |
64
- | `Backup path` | Where to save the backups to. <br>This path is exclusive for the Joplin backups, there should be no other data in it when you disable the `Create Subfolder` settings! | |
65
- | `Keep x backups` | How many backups should be kept | `1` |
66
- | `Backups interval in hours` | Create a backup every X hours | `24` |
67
- | `Only on change` | Creates a backup at the specified backup interval only if there was a change to a `note`, `tag`, `resource` or `notebook` | `false` |
68
- | `Password protected backups` | Protect the backups via encrypted Zip archive. | `false` |
69
- | `Logfile` | Loglevel for backup.log | `error` |
70
- | `Create zip archive` | Save backup data in a Zip archive | `No` |
71
- | `Zip compression Level` | Compression level for zip archive archive | `Copy (no compression)` |
72
- | `Temporary export path` | The data is first exported into this path before it is copied to the backup `Backup path`. | `` |
73
- | `Backup set name` | Name of the backup set if multiple backups are to be keep. [Available moment tokens](https://momentjs.com/docs/#/displaying/format/), which can be used with `{<TOKEN>}` | `{YYYYMMDDHHmm}` |
74
- | `Single JEX` | Create only one JEX file for all, this option is recommended to prevent the loss of internal note links or folder structure during a restore! | `true` |
75
- | `Export format` | Selection of the export format of the notes. | `jex` |
76
- | `Command on Backup finish` | Execute command when backup is finished. | |
77
- | `Create Subfolder` | Create a sub folder `JoplinBackup` in the configured `Backup path`. Deactivate only if there is no other data in the `Backup path`! | `true` |
78
- | `Backup plugins` | Backup the plugin folder from the Joplin profile with all installed plugin jpl files. | `true` |
79
-
80
78
  ## Keyboard Shortcuts
81
79
 
82
80
  Under `Options > Keyboard Shortcuts` you can assign a keyboard shortcut for the following commands:
@@ -111,6 +109,17 @@ The notes are imported via `File > Import > JEX - Joplin Export File`.
111
109
  The notes are imported additionally, no check for duplicates is performed.
112
110
  If the notebook in which the note was located already exists in your Joplin, then a "(1)" will be appended to the folder name.
113
111
 
112
+ ### Restore a singel note
113
+
114
+ 1. Create a new profile in Joplin via `File > Switch profile > Create new Profile`
115
+ 2. Joplin switches automatically to the newly created profile
116
+ 3. Import the Backup via `File > Import > JEX - Joplin Export File`
117
+ 4. Search for the desired note
118
+ 5. In the note overview, click on the note on the right and select `Export > JEX - Joplin Export File`
119
+ 6. Save the file on your computer
120
+ 7. Switch back to your orginal Joplin profil via `File > Switch profile > Default`
121
+ 8. Import the exported note via `File > Import > JEX - Joplin Export File` and select the file from step 6
122
+
114
123
  ## FAQ
115
124
 
116
125
  ### Internal Joplin links betwen notes are lost
@@ -136,6 +145,15 @@ The file names in the archive correspond to the Joplin internal IDs.
136
145
 
137
146
  The note history and file versions (revisions) are not included in the backup.
138
147
 
148
+ ### Are all Joplin profiles backed up?
149
+
150
+ No, the backup must be configured for each profile.
151
+ Profiles that are not active are not backed up, even if a backup has been configured.
152
+
153
+ ### The Joplin build-in version of the plugin cannot be updated
154
+
155
+ Yes, the build-in version only gets updates with Joplin updates, but can be replaced as described in the [Installation](#installation) step.
156
+
139
157
  ## Changelog
140
158
 
141
159
  See [CHANGELOG.md](CHANGELOG.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "joplin-plugin-backup",
3
- "version": "1.3.6",
3
+ "version": "1.4.0",
4
4
  "scripts": {
5
5
  "dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
6
6
  "prepare": "npm run dist && husky install",
@@ -28,7 +28,7 @@
28
28
  "husky": "^6.0.0",
29
29
  "jest": "^27.0.4",
30
30
  "jest-when": "^3.3.1",
31
- "joplinplugindevtools": "^1.0.15",
31
+ "joplinplugindevtools": "^1.0.16",
32
32
  "lint-staged": "^11.0.0",
33
33
  "mime": "^2.5.2",
34
34
  "on-build-webpack": "^0.1.0",
package/publish/io.github.jackgruber.backup.json CHANGED
@@ -2,8 +2,8 @@
2
2
  "manifest_version": 1,
3
3
  "id": "io.github.jackgruber.backup",
4
4
  "app_min_version": "2.1.3",
5
- "version": "1.3.6",
6
- "name": "Simple Backup",
5
+ "version": "1.4.0",
6
+ "name": "Backup",
7
7
  "description": "Plugin to create manual and automatic backups.",
8
8
  "author": "JackGruber",
9
9
  "homepage_url": "https://github.com/JackGruber/joplin-plugin-backup/blob/master/README.md",
@@ -34,6 +34,6 @@
34
34
  "icons": {
35
35
  "256": "img/icon_256.png"
36
36
  },
37
- "_publish_hash": "sha256:a0c23652f561356624fce851bb8931b1d04e5098aef79d3ff56f829bc706c5fb",
38
- "_publish_commit": "master:a8f29fdd8153c34862c22a9290c4577dcf4b1834"
37
+ "_publish_hash": "sha256:e0b750e75606240c3abb36d440c93441e0ce6cce07e78bc27cc50c896dfd9d7d",
38
+ "_publish_commit": "master:e7fcf0b460edb5d69b3e2b3578d6244077290542"
39
39
  }