Common mistakes

This page lists some things users might get wrong and strategies for finding out what is wrong. Keeping such a list might help us waste less time when the next person comes along and makes a mistake we had to investigate before.

• In ~/.authsource.gpg the # -*- epa-file-encrypt-to: ("you@example.com") -*- line has to be properly marked as a comment using the #. See #186.
• Set auth-source-debug to trivia as described in the manual. It might just tell you what's wrong.
• During the setup process, if you entered your email address instead of your GitHub username, you need to remove your email address from the git config. To do that, if you set your email address globally, do git config --unset --global github.user. If you set your email address locally, navigate to that repo and do git config --unset --local github.user. Then restart the setup process. See #415 for related blundering.
• If using password-store, make sure that the string /api/v4 does not appear in the filename. See #529.
• If you edit ~/.authsource.gpg by hand and make a mistake, the resulting error messages might not be that enlighening. For example, if you put the token in the file, but don't preceed it with the password property, then Ghub will tell you that it did not find the token (because the token is expected as the value of the password property, which isn't set) but Auth-Source will tell you that it fond a matching entry (because an entry does exist, it just happens to lack the password property). See ghub/#161.