aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSimon Ser <contact@emersion.fr>2020-02-12 17:37:42 +0100
committerSimon Ser <contact@emersion.fr>2020-02-12 17:37:42 +0100
commitb0bceee0eac5896ddf28314fc9376713ac207a2b (patch)
treee8afa32d9419e7e0da4da1c2bad11b44bc366fc1 /docs
parent1dc00fa023257696b57bd1cbc70601d96492eea3 (diff)
downloadalps-b0bceee0eac5896ddf28314fc9376713ac207a2b.tar.gz
alps-b0bceee0eac5896ddf28314fc9376713ac207a2b.zip
docs: add instructions for Google accounts
This makes it easier for people to try out koushin.
Diffstat (limited to 'docs')
-rw-r--r--docs/google.md20
1 files changed, 20 insertions, 0 deletions
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