]> git.notmuchmail.org Git - notmuch/commit - doc/man1/notmuch-reindex.rst
doc: Examples of notmuch-reindex use and crypto policy
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Wed, 21 Feb 2018 17:50:27 +0000 (09:50 -0800)
committerDavid Bremner <david@tethera.net>
Sat, 24 Mar 2018 23:08:27 +0000 (20:08 -0300)
commitf6430bc06d479fdf0b180231d3a3b5fb67bbb8e0
tree1d76918f2187e0cf962e83514a6952e2e0016418
parentb6e3efde05ed72fa1b9c017093aaf56d70b533c1
doc: Examples of notmuch-reindex use and crypto policy

Currently, notmuch has the levers needed to set coherent crypto policy
around how cleartext is indexed, which also has an impact on how
messages are rendered.  But we don't have a lot of documentation about
how to do sensible things.  This is an initial attempt to address
that.

The first example shows a way to selectively index specific messages.

The next two examples are about aligning the existing database with
crypto indexing policy

The default crypto policy is to not index cleartext, and to only
decrypt messages on display when explicitly requested.

The other sensible crypto policy is to index cleartext while stashing
session keys. messages indexed in this way will be searchable, and
will be decrypted on display automatically unless the user explicitly
asks for it to *not* be decrypted.

The policy for indexing *new* messages is stored in the database as
the config variable index.decrypt.

But setting policy for new messages doesn't retroactively affect
already indexed messages.

This patch attempts to document ways that someone can efficiently
align their pre-existing database with their new policy.

I'm not sure this is the right place to document these examples, but i
do want them to be user-facing and relatively easy to find.  I'm happy
to entertain suggestions for where else we should put them.
doc/man1/notmuch-reindex.rst