apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-07-22 23:31:12 +02:00
Code Issues Projects Releases Packages Wiki Activity

Fix documentation: Remove deleted Google OAuth images, clarify auth is email-only

Browse source 
- Update Auth Setup section to reflect email/password authentication only
- Remove references to deleted OAuth setup images
- Clarify Google OAuth is only for Gmail/Calendar connectors, not user auth
- Add redirect URI examples for connector setup
This commit is contained in:
Ojārs Kapteinis 2025-11-18 14:05:55 +02:00
parent 586ab481c2
commit a148614e4d
1 changed files with 11 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

23
surfsense_web/content/docs/index.mdx
View file

@ -5,26 +5,25 @@ full: true
--- ---
## Auth Setup ## Auth Setup
SurfSense supports both Google OAuth and local email/password authentication. Google OAuth is optional - if you prefer local authentication, you can skip this section. SurfSense uses email/password authentication for user accounts.
**Note**: Google OAuth setup is **required** in your `.env` files if you want to use the Gmail and Google Calendar connectors in SurfSense. ### Google OAuth for Connectors (Optional)
To set up Google OAuth: **Note**: Google OAuth setup is **required** in your `.env` files only if you want to use the Gmail and Google Calendar connectors in SurfSense.
To set up Google OAuth for Gmail/Calendar connectors:
1. Login to your [Google Developer Console](https://console.cloud.google.com/) 1. Login to your [Google Developer Console](https://console.cloud.google.com/)
2. Enable the required APIs: 2. Enable the required APIs:
- **People API** (required for basic Google OAuth)
- **Gmail API** (required if you want to use the Gmail connector) - **Gmail API** (required if you want to use the Gmail connector)
- **Google Calendar API** (required if you want to use the Google Calendar connector) - **Google Calendar API** (required if you want to use the Google Calendar connector)
![Google Developer Console People API](/docs/google_oauth_people_api.png) 3. Set up OAuth consent screen
3. Set up OAuth consent screen. 4. Create OAuth client ID and secret
![Google Developer Console OAuth consent screen](/docs/google_oauth_screen.png) 5. Add the redirect URIs:
4. Create OAuth client ID and secret. - For Gmail: `http://your-domain/api/v1/auth/google/gmail/connector/callback`
![Google Developer Console OAuth client ID](/docs/google_oauth_client.png) - For Calendar: `http://your-domain/api/v1/auth/google/calendar/connector/callback`
5. It should look like this.
![Google Developer Console Config](/docs/google_oauth_config.png)
--- ---