-
Notifications
You must be signed in to change notification settings - Fork 2.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document Google OAuth scopes required #9657
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR Summary
Added documentation for required Google OAuth scopes in the self-hosting setup guide, helping users properly configure their Google Cloud projects for Gmail and Calendar integration.
- Added new 'Configure Scopes' section in
/packages/twenty-website/src/content/developers/self-hosting/setup.mdx
listing required scopes: calendar.events, gmail.readonly, profile.emails.read - Included link to source code implementation for scope configuration
- Placed scopes documentation strategically after API enablement section for logical setup flow
💡 (2/5) Greptile learns from your feedback when you react with 👍/👎!
1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
### Configure Scopes | ||
[See relevant source code](https://github.com/twentyhq/twenty/blob/main/packages/twenty-server/src/engine/core-modules/auth/utils/get-google-apis-oauth-scopes.ts#L4-L10) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: The source code link should include a description of what users will find there, e.g. 'See source code for full OAuth scope implementation'
Hi @curiousercreative , Thanks for contributing. It's a good catch, we forgot to list the permission in the doc ! From what I see, you are missing the permission 'email' and 'profile', am I right ? I get that from reading the file Second request, as you can see in the main branch, we are now working on Microsoft. Can I ask you to add the equivalent paragraph on the "For Outlook and Outlook Calendar (Microsoft 365)" part ? the microsoft scopes are listed here |
|
@guillim added Microsoft scopes. In case you know and want to keep creeping, the documentation around the "cron jobs" could also be improved. At least one of these commands failed (does not exist or similar) and we could answer the question of "when do I need to do this?". Answer could be "once per install (as long as database is alive)", "once per container creation", or "once per container run". |
Good points.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be honest, let's merge your PR as such. For the topics leftover (the one we discussed above) please open a new PR :)
Log
|
Attempts to resolve #9656