diff options
| author | Simon Ser <contact@emersion.fr> | 2020-02-12 17:37:42 +0100 |
|---|---|---|
| committer | Simon Ser <contact@emersion.fr> | 2020-02-12 17:37:42 +0100 |
| commit | b0bceee0eac5896ddf28314fc9376713ac207a2b (patch) | |
| tree | e8afa32d9419e7e0da4da1c2bad11b44bc366fc1 | |
| parent | 1dc00fa023257696b57bd1cbc70601d96492eea3 (diff) | |
| download | alps-b0bceee0eac5896ddf28314fc9376713ac207a2b.tar.gz alps-b0bceee0eac5896ddf28314fc9376713ac207a2b.zip | |
docs: add instructions for Google accounts
This makes it easier for people to try out koushin.
| -rw-r--r-- | docs/google.md | 20 | ||||
| -rw-r--r-- | go.mod | 2 |
2 files changed, 22 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 @@ -25,3 +25,5 @@ require ( golang.org/x/sys v0.0.0-20200202164722-d101bd2416d5 // indirect layeh.com/gopher-luar v1.0.7 ) + +replace github.com/emersion/go-webdav => ../go-webdav |