GitHub setup

Create a GitHub token for Notedog

Notedog uses Git over HTTPS for clone and push. GitHub no longer accepts your account password for that flow; use a personal access token as the password.

Recommended: create a fine-grained personal access token limited to the one repository you use for your Notedog journal.

Before you start

Create a fine-grained token

  1. Open GitHub and go to Settings.
  2. Open Developer settings.
  3. Under Personal access tokens, choose Fine-grained tokens.
  4. Click Generate new token.
  5. Give it a clear name, such as Notedog journal, and choose an expiration date.
  6. Choose the resource owner for the repository.
  7. Set Repository access to Only select repositories, then select your Notedog journal repository.
  8. Under Repository permissions, set Contents to Read and write. Leave other permissions unset unless you know you need them.
  9. Click Generate token, then copy the token before leaving the page.

Use the token in Notedog

After setup, Notedog can clone from and push to that repository using the token. The journal still lives on your Android device; Git is only the backup you choose.

If fine-grained tokens do not work

Some GitHub organization or collaborator setups may require a classic token. If you use a classic personal access token, choose the smallest scope that works for your repository access. GitHub documents repo as the classic scope for repository access from the command line, but it is broader than a fine-grained token.

Official GitHub docs

GitHub’s token screens and policies can change. If something looks different, use GitHub’s current documentation as the source of truth.

Open GitHub’s personal access token docs