rowboat/google-setup.md

159 lines
4.2 KiB
Markdown
Raw Normal View History

# Connecting Google to Rowboat
Rowboat requires a Google OAuth Client ID to connect to Gmail, Calendar, and Drive. Follow the steps below to generate your Client ID correctly.
---
## 1⃣ Open Google Cloud Console
Go to:
https://console.cloud.google.com/
Make sure you're logged into the Google account you want to use.
---
## 2⃣ Create a New Project
Go to:
https://console.cloud.google.com/projectcreate
- Click **Create Project**
- Give it a name (e.g. `Rowboat Integration`)
- Click **Create**
Once created, make sure the new project is selected in the top project dropdown.
![Select the new project in the dropdown](https://raw.githubusercontent.com/rowboatlabs/rowboat/main/apps/docs/docs/img/google-setup/01-select-project-dropdown.png)
---
## 3⃣ Enable Required APIs
Enable the following APIs for your project:
- Gmail API
https://console.cloud.google.com/apis/api/gmail.googleapis.com
- Google Calendar API
https://console.cloud.google.com/apis/api/calendar-json.googleapis.com
- Google Drive API
https://console.cloud.google.com/apis/api/drive.googleapis.com
For each API:
- Click **Enable**
![Enable the API](https://raw.githubusercontent.com/rowboatlabs/rowboat/main/apps/docs/docs/img/google-setup/02-enable-api.png)
---
## 4⃣ Configure OAuth Consent Screen
Go to:
https://console.cloud.google.com/auth/branding
### App Information
- App name: (e.g. `Rowboat`)
- User support email: Your email
### Audience
- Choose **External**
### Contact Information
- Add your email address
Click **Save and Continue** through the remaining steps.
You do NOT need to publish the app — keeping it in **Testing** mode is fine.
![OAuth consent screen](https://raw.githubusercontent.com/rowboatlabs/rowboat/main/apps/docs/docs/img/google-setup/03-oauth-consent-screen.png)
---
## 5⃣ Add Test Users
If your app is in Testing mode, you must add users manually.
Go to:
https://console.cloud.google.com/auth/audience
Under **Test Users**:
- Click **Add Users**
- Add the email address you plan to connect with Rowboat
Save changes.
![Add test users](https://raw.githubusercontent.com/rowboatlabs/rowboat/main/apps/docs/docs/img/google-setup/04-add-test-users.png)
---
## 6⃣ Create OAuth Client ID
Go to:
https://console.cloud.google.com/auth/clients
Click **Create Credentials → OAuth Client ID**
### Application Type
Select:
**Universal Windows Platform (UWP)**
- Name it anything (e.g. `Rowboat Desktop`)
- Store ID can be anything (e.g. `test` )
- Click **Create**
![Create OAuth Client ID (UWP)](https://raw.githubusercontent.com/rowboatlabs/rowboat/main/apps/docs/docs/img/google-setup/05-create-oauth-client-uwp.png)
### Authorized redirect URIs (if shown)
If your OAuth client configuration shows **Authorized redirect URIs**, add:
- `http://localhost:8080/oauth/callback`
Use this exactly: no trailing slash, port **8080**. This must match what the app uses for the OAuth callback. (Some client types, e.g. UWP, may not expose redirect URIs; that is fine.)
---
## 7⃣ Copy the Client ID
After creation, Google will show:
- **Client ID**
- **Client Secret**
Copy the **Client ID** and paste it into Rowboat where prompted.
![Copy Client ID](https://raw.githubusercontent.com/rowboatlabs/rowboat/main/apps/docs/docs/img/google-setup/06-copy-client-id.png)
---
## Troubleshooting
**Error after "Authorization Successful"**
If the browser shows "Authorization Successful" but the app then shows an error (e.g. "invalid response encountered" or "response parameter \"iss\" (issuer) missing"):
1. **Check the app logs** (e.g. terminal or dev tools) for the full error. The message there will often indicate the cause (e.g. redirect URI mismatch, missing parameter).
2. **Verify redirect URI in Google Cloud Console**: Open [Credentials → your OAuth 2.0 Client ID](https://console.cloud.google.com/auth/clients). If the client type allows **Authorized redirect URIs**, ensure `http://localhost:8080/oauth/callback` is listed exactly.
3. **Client type**: Use **Desktop** or **UWP** as the application type. A "Web application" client may require the redirect URI to be set and can behave differently with localhost.
---