blsmedia/bot
2
0
Fork 0
Code Activity

📝 Split Google requirements for each APIs: auth, sheets, fonts

Browse Source
This commit is contained in:
Baptiste Arnaud
2024-03-19 11:18:09 +01:00
parent a4c865ca26
commit f0172198b9
1 changed files with 59 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
apps/docs/self-hosting/configuration.mdx
View File

@ -43,21 +43,48 @@ Used for sending email notifications and authentication
| SMTP_SECURE | false | If true the connection will use TLS when connecting to server. If false (the default) then TLS is used if server supports the STARTTLS extension. In most cases set this value to true if you are connecting to port 465. For port 587 or 25 keep it false | | SMTP_SECURE | false | If true the connection will use TLS when connecting to server. If false (the default) then TLS is used if server supports the STARTTLS extension. In most cases set this value to true if you are connecting to port 465. For port 587 or 25 keep it false |
| SMTP_AUTH_DISABLED | false | To disable the authentication by email but still use the provided config for notifications | | SMTP_AUTH_DISABLED | false | To disable the authentication by email but still use the provided config for notifications |
## Google (Auth, Sheets, Fonts) ## Google Auth
Used authentication in the builder and for the Google Sheets integration step.
<Accordion title="Requirements"> <Accordion title="Requirements">
1. Enable the APIs you want: Google Sheets API, Google Picker API (Used for the Google Sheets integration to pick a spreadsheet), Web Fonts Developer API 1. Head over the Credentials tab: https://console.developers.google.com/apis/credentials
2. Create an API key. This will be your `NEXT_PUBLIC_GOOGLE_API_KEY`
3. Create a OAuth client ID. This will be your `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET`
Make sure to set the following scopes: `userinfo.email`
The "Authorized redirect URIs" used when creating the credentials must include your full domain and end in the callback path:
- For production:
- https://\<YOUR_DOMAIN\>/api/auth/callback/google
- https://\<YOUR_DOMAIN\>/api/credentials/google-sheets/callback
- For development:
- http://localhost:3000/api/auth/callback/google
- http://localhost:3000/api/credentials/google-sheets/callback
</Accordion>
| Parameter | Default | Description |
| -------------------------- | ------- | --------------------------------------------- |
| GOOGLE_CLIENT_ID | | The Client ID from the Google API Console |
| GOOGLE_CLIENT_SECRET | | The Client secret from the Google API Console |
| NEXT_PUBLIC_GOOGLE_API_KEY | | The API Key from the Google API Console |
## Google Sheets
<Accordion title="Requirements">
1. Enable the following APIs in the Google Cloud Console: Google Sheets API, Google Picker API
2. Head over the Credentials tab: https://console.developers.google.com/apis/credentials 2. Head over the Credentials tab: https://console.developers.google.com/apis/credentials
3. Create an API key with access to the Google Picker API and Web Fonts Developer API (optional). This will be your `NEXT_PUBLIC_GOOGLE_API_KEY` 3. Create an API key with access to the Google Picker API. This will be your `NEXT_PUBLIC_GOOGLE_API_KEY`
4. Create a OAuth client ID. This will be your `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET` 4. Create a OAuth client ID. This will be your `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET`
Make sure to set the required scopes (`userinfo.email`, `spreadsheets`, `drive.file`) in your console Make sure to set the following scopes: `userinfo.email`, `spreadsheets`, `drive.file`
The "Authorized redirect URIs" used when creating the credentials must include your full domain and end in the callback path: The "Authorized redirect URIs" used when creating the credentials must include your full domain and end in the callback path:
@ -78,6 +105,24 @@ Used authentication in the builder and for the Google Sheets integration step.
| GOOGLE_CLIENT_SECRET | | The Client secret from the Google API Console | | GOOGLE_CLIENT_SECRET | | The Client secret from the Google API Console |
| NEXT_PUBLIC_GOOGLE_API_KEY | | The API Key from the Google API Console | | NEXT_PUBLIC_GOOGLE_API_KEY | | The API Key from the Google API Console |
## Google Fonts
Used authentication in the builder and for the Google Sheets integration step.
<Accordion title="Requirements">
1. Enable the following API in the Google Cloud Console: Web Fonts Developer API
2. Head over the Credentials tab: https://console.developers.google.com/apis/credentials
3. Create an API key with access to the Web Fonts Developer API. This will be your `NEXT_PUBLIC_GOOGLE_API_KEY`
</Accordion>
| Parameter | Default | Description |
| -------------------------- | ------- | --------------------------------------- |
| NEXT_PUBLIC_GOOGLE_API_KEY | | The API Key from the Google API Console |
## GitHub (Auth) ## GitHub (Auth)
Used for authenticating with GitHub. By default, it uses the credentials of a Typebot-dev app. Used for authenticating with GitHub. By default, it uses the credentials of a Typebot-dev app.
@ -238,14 +283,14 @@ In order to be able to test your bot on WhatsApp from the Preview drawer, you ne
</Accordion> </Accordion>
| Parameter | Default | Description | | Parameter | Default | Description |
| ------------------------------------- | -------------------------- | ------------------------------------------------------- | | ------------------------------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| META_SYSTEM_USER_TOKEN | | The system user token used to send WhatsApp messages | | META_SYSTEM_USER_TOKEN | | The system user token used to send WhatsApp messages |
| WHATSAPP_PREVIEW_FROM_PHONE_NUMBER_ID | | The phone number ID from which the message will be sent | | WHATSAPP_PREVIEW_FROM_PHONE_NUMBER_ID | | The phone number ID from which the message will be sent |
| WHATSAPP_PREVIEW_TEMPLATE_NAME | | The preview start template message name | | WHATSAPP_PREVIEW_TEMPLATE_NAME | | The preview start template message name |
| WHATSAPP_PREVIEW_TEMPLATE_LANG | en_US | The preview start template message name | | WHATSAPP_PREVIEW_TEMPLATE_LANG | en_US | The preview start template message name |
| WHATSAPP_CLOUD_API_URL | https://graph.facebook.com | The WhatsApp Cloud API base URL | | WHATSAPP_CLOUD_API_URL | https://graph.facebook.com | The WhatsApp Cloud API base URL |
| WHATSAPP_INTERACTIVE_GROUP_SIZE | 3 | The array size of items to send to API on choice input. You can't choose a number higher than 3 if you are using the official cloud API URL. | | WHATSAPP_INTERACTIVE_GROUP_SIZE | 3 | The array size of items to send to API on choice input. You can't choose a number higher than 3 if you are using the official cloud API URL. |
## Others ## Others