Skip to content

Commit 4237ff8

Browse files
committed
Slightly improve docs for configuring google
1 parent 1a6ad54 commit 4237ff8

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

CHANGELOG.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ Version 0.19.2
2020
functional impact, and is merely for forward compatibility with the Rust
2121
implementation of vdirsyncer.
2222
- Python 3.10 and 3.11 are officially supported.
23+
- Instructions for integrating with Google CalDav/CardDav have changed.
24+
Applications now need to be registered as "Desktop applications". Using "Web
25+
application" no longer works due to changes on Google's side. :gh:`1078`
2326

2427
Version 0.19.1
2528
==============

docs/config.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -287,25 +287,29 @@ Furthermore you need to register vdirsyncer as an application yourself to
287287
obtain ``client_id`` and ``client_secret``, as it is against Google's Terms of
288288
Service to hardcode those into opensource software [googleterms]_:
289289

290-
1. Go to the `Google API Manager <https://console.developers.google.com>`_ and
291-
create a new project under any name.
290+
1. Go to the `Google API Manager <https://console.developers.google.com>`_
291+
292+
2. Create a new project under any name.
292293

293294
2. Within that project, enable the "CalDAV" and "CardDAV" APIs (**not** the
294295
Calendar and Contacts APIs, those are different and won't work). There should
295-
be a searchbox where you can just enter those terms.
296+
be a search box where you can just enter those terms.
296297

297-
3. In the sidebar, select "Credentials" and create a new "OAuth Client ID". The
298-
application type is "Desktop".
298+
3. In the sidebar, select "Credentials", then "Create Credentials" and create a
299+
new "OAuth Client ID".
299300

300301
You'll be prompted to create a OAuth consent screen first. Fill out that
301302
form however you like.
302303

304+
After setting up the consent screen, finish creating the new "OAuth Client
305+
ID'. The correct application type is "Desktop application".
306+
303307
4. Finally you should have a Client ID and a Client secret. Provide these in
304308
your storage config.
305309

306-
The ``token_file`` parameter should be a filepath where vdirsyncer can later
307-
store authentication-related data. You do not need to create the file itself
308-
or write anything to it.
310+
The ``token_file`` parameter should be a path to a file where vdirsyncer can
311+
later store authentication-related data. You do not need to create the file
312+
itself or write anything to it.
309313

310314
.. [googleterms] See `ToS <https://developers.google.com/terms/?hl=th>`_,
311315
section "Confidential Matters".

0 commit comments

Comments
 (0)