diff --git a/CHANGELOG.md b/CHANGELOG.md index 70cf9fc7..05734e50 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,11 @@ **Implemented enhancements:** +- Display locations of config file and documentation after initial install [\#1694](https://github.com/jrnl-org/jrnl/issues/1694) - Don't import cryptography package if not needed [\#1521](https://github.com/jrnl-org/jrnl/issues/1521) +- Add message with config location and docs location when installation is complete [\#1695](https://github.com/jrnl-org/jrnl/pull/1695) ([micahellison](https://github.com/micahellison)) +- Prompt to include colors in config when first running jrnl [\#1687](https://github.com/jrnl-org/jrnl/pull/1687) ([micahellison](https://github.com/micahellison)) +- Search for entries with no tags or stars with `-not -starred` and `-not -tagged` [\#1663](https://github.com/jrnl-org/jrnl/pull/1663) ([cjcon90](https://github.com/cjcon90)) - Refactor flow for easier access to some files \(avoid things like `jrnl.Journal.Journal` and `jrnl.jrnl` co-existing\) [\#1662](https://github.com/jrnl-org/jrnl/pull/1662) ([wren](https://github.com/wren)) - Add more type hints [\#1642](https://github.com/jrnl-org/jrnl/pull/1642) ([outa](https://github.com/outa)) - Add `rich` handler to debug logging [\#1627](https://github.com/jrnl-org/jrnl/pull/1627) ([wren](https://github.com/wren)) @@ -16,6 +20,8 @@ - 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)) @@ -26,6 +32,7 @@ **Build:** +- Support pytest-bdd 6 [\#1534](https://github.com/jrnl-org/jrnl/issues/1534) - Update copyright notices for 2023 [\#1660](https://github.com/jrnl-org/jrnl/pull/1660) ([wren](https://github.com/wren)) - Fix bug where changelog is always slightly out of date on release tags [\#1631](https://github.com/jrnl-org/jrnl/pull/1631) ([wren](https://github.com/wren)) - Add `simplify` plugin to linting checks [\#1630](https://github.com/jrnl-org/jrnl/pull/1630) ([wren](https://github.com/wren)) @@ -33,7 +40,16 @@ **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) +- Document `-tagged`, `-not -tagged`, and `-not -starred` [\#1668](https://github.com/jrnl-org/jrnl/issues/1668) - Documentation Change [\#1651](https://github.com/jrnl-org/jrnl/issues/1651) +- Update console examples on jrnl.sh front page [\#1622](https://github.com/jrnl-org/jrnl/issues/1622) +- Update documentation front page text [\#1698](https://github.com/jrnl-org/jrnl/pull/1698) ([micahellison](https://github.com/micahellison)) +- 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)) +- Document `-tagged`, `-not -tagged`, and `-not -starred` [\#1684](https://github.com/jrnl-org/jrnl/pull/1684) ([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)) diff --git a/docs/privacy-and-security.md b/docs/privacy-and-security.md index c767c5e0..f855cc3e 100644 --- a/docs/privacy-and-security.md +++ b/docs/privacy-and-security.md @@ -67,12 +67,57 @@ Windows doesn't log history to disk, but it does keep it in your command prompt session. Close the command prompt or press `Alt`+`F7` to clear your history after journaling. +## Files in transit from editor to jrnl + +When creating or editing an entry, `jrnl` uses a unencrypted temporary file on +disk in order to give your editor access to your journal. After you close your +editor, `jrnl` then deletes this temporary file. + +So, if you have saved a journal entry but haven't closed your editor yet, the +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 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` @@ -101,7 +146,11 @@ autocommand can be used. Place this in your `~/.vimrc`: autocmd BufNewFile,BufReadPre *.jrnl setlocal viminfo= noswapfile noundofile nobackup nowritebackup noshelltemp history=0 nomodeline secure ``` -Please see `:h