diff --git a/CHANGELOG.md b/CHANGELOG.md index ad10e106..1c4f2d22 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,7 +15,11 @@ **Fixed bugs:** +- Templated entries should not be saved if the raw text is identical to the original template [\#1652](https://github.com/jrnl-org/jrnl/issues/1652) - jrnl does not update version key in config file [\#1638](https://github.com/jrnl-org/jrnl/issues/1638) +- jrnl should not create 0-length "encrypted" file on startup [\#1493](https://github.com/jrnl-org/jrnl/issues/1493) +- Save empty journal on install instead of just creating a zero-length file [\#1690](https://github.com/jrnl-org/jrnl/pull/1690) ([micahellison](https://github.com/micahellison)) +- Don't save templated journal entries if the received raw text is the same as the template itself [\#1653](https://github.com/jrnl-org/jrnl/pull/1653) ([Briscoooe](https://github.com/Briscoooe)) - Add tag to XML file when edited DayOne entry and is searchable afterward [\#1648](https://github.com/jrnl-org/jrnl/pull/1648) ([jonakeys](https://github.com/jonakeys)) - Update version key in config file after version changes [\#1646](https://github.com/jrnl-org/jrnl/pull/1646) ([jonakeys](https://github.com/jonakeys)) @@ -32,7 +36,13 @@ **Documentation:** +- Document template extension behavior [\#1677](https://github.com/jrnl-org/jrnl/issues/1677) +- Visual Studio Code may store unencrypted temporary files [\#1675](https://github.com/jrnl-org/jrnl/issues/1675) - Documentation Change [\#1651](https://github.com/jrnl-org/jrnl/issues/1651) +- Support mkdocs 1.4.2 and fix its missing breadcrumb [\#1691](https://github.com/jrnl-org/jrnl/pull/1691) ([micahellison](https://github.com/micahellison)) +- Document temporary file extension behavior when using template [\#1686](https://github.com/jrnl-org/jrnl/pull/1686) ([micahellison](https://github.com/micahellison)) +- Update documentation about privacy and security in VSCode [\#1680](https://github.com/jrnl-org/jrnl/pull/1680) ([giuseppedandrea](https://github.com/giuseppedandrea)) +- Update documentation on temporary files naming [\#1673](https://github.com/jrnl-org/jrnl/pull/1673) ([giuseppedandrea](https://github.com/giuseppedandrea)) - Update docs to include time and title in arguments with `--edit` [\#1657](https://github.com/jrnl-org/jrnl/pull/1657) ([pconrad-fb](https://github.com/pconrad-fb)) - Fix markup in "Advanced Usage" doc [\#1655](https://github.com/jrnl-org/jrnl/pull/1655) ([multani](https://github.com/multani)) - Remove Windows 7 known issue since Windows 7 is no longer supported [\#1636](https://github.com/jrnl-org/jrnl/pull/1636) ([micahellison](https://github.com/micahellison)) diff --git a/docs/external-editors.md b/docs/external-editors.md index 977a9de2..b7219d8d 100644 --- a/docs/external-editors.md +++ b/docs/external-editors.md @@ -37,6 +37,9 @@ jrnl yesterday: All my troubles seemed so far away. --edit All editors must be [blocking processes](https://en.wikipedia.org/wiki/Blocking_(computing)) to work with jrnl. Some editors, such as [micro](https://micro-editor.github.io/), are blocking by default, though others can be made to block with additional arguments, such as many of those documented below. If jrnl opens your editor but finishes running immediately, then your editor is not a blocking process, and you may be able to correct that with one of the suggestions below. +Please see [this section](./privacy-and-security.md#editor-history) about how +your editor might leak sensitive information and how to mitigate that risk. + ## Sublime Text To use [Sublime Text](https://www.sublimetext.com/), install the command line @@ -71,6 +74,17 @@ back to journal. In the case of MacVim, this is `-f`: editor: "mvim -f" ``` +## Vim/Neovim + +To use any of the Vim derivatives as editor in Linux, simply set the `editor` +to the executable: + +```yaml +editor: "vim" +# or +editor: "nvim" +``` + ## iA Writer On OS X, you can use the fabulous [iA diff --git a/docs/privacy-and-security.md b/docs/privacy-and-security.md index a55e6fa3..f855cc3e 100644 --- a/docs/privacy-and-security.md +++ b/docs/privacy-and-security.md @@ -78,8 +78,125 @@ unencrypted temporary remains on your disk. If your computer were to shut off during this time, or the `jrnl` process were killed unexpectedly, then the unencrypted temporary file will remain on your disk. You can mitigate this issue by only saving with your editor right before closing it. You can also -manually delete these files (i.e. files named `jrnl_*.txt`) from your temporary -folder. +manually delete these files from your temporary folder. By default, they +are named `jrnl*.jrnl`, but if you use a +[template](reference-config-file.md#template), they will have the same +extension as the template. + +## Editor history + +Some editors keep usage history stored on disk for future use. This can be a +security risk in the sense that sensitive information can leak via recent +search patterns or editor commands. + +### Visual Studio Code + +Visual Studio Code stores the contents of saved files to allow you to restore or +review the contents later. You can disable this feature for all files by unchecking +the `workbench.localHistory.enabled` setting in the +[Settings editor](https://code.visualstudio.com/docs/getstarted/settings#_settings-editor). + +Alternatively, you can disable this feature for specific files by configuring a +[pattern](https://code.visualstudio.com/docs/editor/codebasics#_advanced-search-options) +in the `workbench.localHistory.exclude` setting. To exclude unencrypted temporary files generated +by `jrnl`, you can set the `**/jrnl*.jrnl` (unless you are using a +[template](reference-config-file.md#template)) pattern for the `workbench.localHistory.exclude` setting +in the [Settings editor](https://code.visualstudio.com/docs/getstarted/settings#_settings-editor). + +!!! note + On Windows, the history location is typically found at + `%APPDATA%\Code\User\History`. + +Visual Studio Code also creates a copy of all unsaved files that are open. +It stores these copies in a backup location that's automatically cleaned when +you save the file. However, if your computer shuts off before you save the file, +or the Visual Studio Code process stops unexpectedly, then an unencrypted +temporary file may remain on your disk. You can manually delete these files +from the backup location. + +!!! note + On Windows, the backup location is typically found at + `%APPDATA%\Code\Backups`. + +### Vim + +Vim stores progress data in a so called Viminfo file located at `~/.viminfo` +which contains all sorts of user data including command line history, search +string history, search/substitute patterns, contents of register etc. Also to +be able to recover opened files after an unexpected application close Vim uses +swap files. + +These options as well as other leaky features can be disabled by setting the +`editor` key in the Jrnl settings like this: + +``` yaml +editor: "vim -c 'set viminfo= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure'" +``` + +To disable all plugins and custom configurations and start Vim with the default +configuration `-u NONE` can be passed on the command line as well. This will +ensure that any rogue plugins or other difficult to catch information leaks are +eliminated. The downside to this is that the editor experience will decrease +quite a bit. + +To instead let Vim automatically detect when a Jrnl file is being edited an +autocommand can be used. Place this in your `~/.vimrc`: + +``` vim +autocmd BufNewFile,BufReadPre *.jrnl setlocal viminfo= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure +``` + +!!! note + If you're using a [template](reference-config-file.md#template), you will + have to use the template's file extension instead of `.jrnl`. + +See `:h