From b0bceee0eac5896ddf28314fc9376713ac207a2b Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Wed, 12 Feb 2020 17:37:42 +0100 Subject: docs: add instructions for Google accounts This makes it easier for people to try out koushin. --- docs/google.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/google.md (limited to 'docs') diff --git a/docs/google.md b/docs/google.md new file mode 100644 index 0000000..adf3de8 --- /dev/null +++ b/docs/google.md @@ -0,0 +1,20 @@ +# Running koushin with a Google account + +## Create an application password + +First, you'll need to obtain an application-specific password for koushin from +the [app passwords] page on your Google account. + +## Run koushin + +Start koushin with these upstream URLs: + + koushin imaps://imap.gmail.com smtps://smtp.gmail.com \ + carddavs://www.googleapis.com/carddav/v1/principals/YOUREMAIL/ + +Replace `YOUREMAIL` with your Google account's e-mail address. + +Once koushin is started, you can login with your e-mail address and the app +password. + +[app passwords]: https://security.google.com/settings/security/apppasswords -- cgit v1.2.3