branch: elpa/mastodon
commit 9453f98716eb9e97c4fd670c7bbb08a93cc2be85
Author: marty hiatt <martianhia...@disroot.org>
Commit: marty hiatt <martianhia...@disroot.org>
readme: updates re encrypted tokens. #671
---
README.org | 17 +++++++++++++----
1 file changed, 13 insertions(+), 4 deletions(-)
diff --git a/README.org b/README.org
index 57bbf74bb1..1b80e59c3d 100644
--- a/README.org
+++ b/README.org
@@ -129,15 +129,24 @@ follow the steps again.
By default, user access tokens are now stored in the user's auth source
file (typically =~/.authinfo.gpg=, check the value of =auth-sources=). When
you first update to 2.0.0, or if you encounter issues due to old
-credentials, call =(mastodon-forget-all-logins)= and then authenticate
-again. If you don't want this behaviour, set =mastodon-auth-use-auth-source=
-to nil. Entries will be stored encrypted in =mastodon-client--token-file=
instead.
+credentials, call =(mastodon-forget-all-logins)= to remove the old
+mastodon.el plstore, and then authenticate again. If you don't want to use
+the auth source file, set =mastodon-auth-use-auth-source= to nil. Entries
+will instead be stored encrypted in =mastodon-client--token-file=, a plstore.
-And if for some reason you reauthenticate, you'll need to either remove the
+If for some reason you reauthenticate, you'll need to either remove the
entry in your auth sources file, or manually update the token in it after
doing so, as mastodon.el is unable to reliably update (or even remove)
entires.
+The format for a mastodon.el auth source entry is as follows:
+
+=machine INSTANCE login USERNAME password AUTHTOKEN=
+
+with the token being what you copy from the browser when authenticating.
+If you have =auth-source-save-behavior= set to nil, you'll also need to add
+such an entry manually.
+
Finally, if you find you're asked for your key passphrase too often while
authenticating, consider setting =epa-file-encrypt-to= (for auth-source
encryption) and =plstore-encrypt-to= (for plstore encryption) to your
