docs: add instructions for Google accounts

This makes it easier for people to try out koushin.
This commit is contained in:
Simon Ser 2020-02-12 17:37:42 +01:00
parent 1dc00fa023
commit b0bceee0ea
No known key found for this signature in database
GPG key ID: 0FDE7BE0E88F5E48
2 changed files with 22 additions and 0 deletions

20
docs/google.md Normal file
View file

@ -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

2
go.mod
View file

@ -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