From e0a603bcb8ae263625ffd455be5b8a50905d59e5 Mon Sep 17 00:00:00 2001 From: Manuel Ebert Date: Mon, 30 Jun 2014 18:00:38 +0200 Subject: [PATCH] Notes on encryption --- .gitignore | 2 ++ CONTRIBUTING.md | 2 +- docs/encryption.rst | 6 ++++++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 1a8fd1b8..40fd38d0 100644 --- a/.gitignore +++ b/.gitignore @@ -42,3 +42,5 @@ obj # virtaulenv env/ env*/ + +docs/_themes/jrnl/static/less/3L.less diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a6dfe7b..55d53ce7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ If you use jrnl, you can totally make my day by just saying "thanks for the code Docs & Typos ------------ -If you find a typo or a mistake in the docs, just fix it right away and send a pull request. The Right Way™ to fix the docs is to edit the `docs/*.rst` files on the **master** branch. You can see the result if you run `make html` inside the project's root directory, and then open `docs/_build/html/index.html` in your browser. Note that this requires [lessc](http://lesscss.org/#using-less-installation) to be installed. Changes to the CSS or Javascript should be made on `docs/_themes/jrnl/`. The `gh-pages` branch is automatically maintained and updates from `master`; you should never have to edit that. +If you find a typo or a mistake in the docs, just fix it right away and send a pull request. The Right Way™ to fix the docs is to edit the `docs/*.rst` files on the **master** branch. You can see the result if you run `make html` inside the project's root directory, and then open `docs/_build/html/index.html` in your browser. Note that this requires [lessc](http://lesscss.org/#using-less-installation) and [Sphinx](https://pypi.python.org/pypi/Sphinx) to be installed. Changes to the CSS or Javascript should be made on `docs/_themes/jrnl/`. The `gh-pages` branch is automatically maintained and updates from `master`; you should never have to edit that. Bugs ---- diff --git a/docs/encryption.rst b/docs/encryption.rst index 9d420df6..37d341a8 100644 --- a/docs/encryption.rst +++ b/docs/encryption.rst @@ -25,6 +25,12 @@ Whenever you encrypt your journal, you are asked whether you want to store the e If you don't initially store the password in the keychain but decide to do so at a later point -- or maybe want to store it on one computer but not on another -- you can simply run ``jrnl --encrypt`` on an encrypted journal and use the same password again. +A note on security +------------------ + +While jrnl follows best practises, true security is an illusion. Specifically, jrnl will leave traces in your memory and your shell history -- it's meant to keep journals secure in transit, for example when storing it on an `untrusted `_ services such as Dropbox. If you're concerned about security, disable history logging for journal in your ``.bashrc`` :: + + HISTINGNORE="jrnl *" Manual decryption -----------------