2
0

📝 Improve Google config instructions

This commit is contained in:
Baptiste Arnaud
2022-12-02 09:37:48 +01:00
parent 94a57aea21
commit 41149b07c6
3 changed files with 27 additions and 8 deletions

View File

@ -42,12 +42,21 @@ The Authorization callback URL should be `$NEXTAUTH_URL/api/auth/callback/google
| GOOGLE_CLIENT_ID | -- | The Client ID from the Google API Console |
| GOOGLE_CLIENT_SECRET | -- | The Client secret from the Google API Console |
Used for Google Fonts:
Used for Google Fonts (Optional):
| Parameter | Default | Description |
| -------------------------- | ------- | --------------------------------------- |
| NEXT_PUBLIC_GOOGLE_API_KEY | -- | The API Key from the Google API Console |
### Configuration
https://console.developers.google.com/apis/credentials
The "Authorized redirect URIs" used when creating the credentials must include your full domain and end in the callback path. For example,
- For production: https://{YOUR_DOMAIN}/api/auth/callback/google
- For development: http://localhost:3000/api/auth/callback/google
## GitHub (Auth)
Used for authenticating with GitHub. By default, it uses the credentials of a Typebot-dev app.
@ -66,10 +75,10 @@ Follow the official GitLab guide for creating OAuth2 applications [here](https:/
The Authorization callback URL should be `$NEXTAUTH_URL/api/auth/callback/gitlab`
| Parameter | Default | Description |
| ---------------------- | ------------------ | ------------------------------------------------------------------------------------ | --- |
| ---------------------- | ------------------ | ------------------------------------------------------------------------------------ |
| GITLAB_CLIENT_ID | -- | Application client ID. Also used to check if it is enabled in the front-end |
| GITLAB_CLIENT_SECRET | -- | Application secret |
| GITLAB_BASE_URL | https://gitlab.com | Base URL of the GitLab instance | |
| GITLAB_BASE_URL | https://gitlab.com | Base URL of the GitLab instance |
| GITLAB_REQUIRED_GROUPS | -- | Comma-separated list of groups the user has to be a direct member of, e.g. `foo,bar` |
| GITLAB_NAME | GitLab | Name of the GitLab instance, used for the SSO Login Button |
@ -104,11 +113,11 @@ Used for uploading images, videos, etc... It can be any S3 compatible object sto
| S3_SECRET_KEY | -- | S3 secret key. |
| S3_BUCKET | typebot | Name of the bucket where assets will be uploaded in. |
| S3_PORT | -- | S3 Host port number |
| S3_ENDPOINT | -- | S3 secret key. |
| S3_ENDPOINT | -- | S3 endpoint (i.e. `s3.domain.com`). |
| S3_SSL | true | Use SSL when establishing the connection. |
| S3_REGION | -- | S3 region. |
Note that for AWS S3, your endpoint is usually: `https://s3.<S3_REGION>.amazonaws.com`
Note that for AWS S3, your endpoint is usually: `s3.<S3_REGION>.amazonaws.com`
Your bucket must have the following policy that tells S3 to allow public read when an object is located under the public folder:

View File

@ -37,6 +37,15 @@ Used when executing a Google Sheets block. Make sure to set the required scopes
| GOOGLE_CLIENT_ID | -- | The Client ID from the Google API Console |
| GOOGLE_CLIENT_SECRET | -- | The Client secret from the Google API Console |
### Configuration
https://console.developers.google.com/apis/credentials
The "Authorized redirect URIs" used when creating the credentials must include your full domain and end in the callback path. For example,
- For production: https://{YOUR_DOMAIN}/api/auth/callback/google
- For development: http://localhost:3000/api/auth/callback/google
## S3 Storage (File upload input)
Used for the file upload input. It can be any S3 compatible object storage service (Minio, Digital Oceans Space, AWS S3...)
@ -47,11 +56,11 @@ Used for the file upload input. It can be any S3 compatible object storage servi
| S3_SECRET_KEY | -- | S3 secret key. |
| S3_BUCKET | typebot | Name of the bucket where assets will be uploaded in. |
| S3_PORT | -- | S3 Host port number |
| S3_ENDPOINT | -- | S3 secret key. |
| S3_ENDPOINT | -- | S3 endpoint (i.e. `s3.domain.com`). |
| S3_SSL | true | Use SSL when establishing the connection. |
| S3_REGION | -- | S3 region. |
Note that for AWS S3, your endpoint is usually: `https://s3.<S3_REGION>.amazonaws.com`
Note that for AWS S3, your endpoint is usually: `s3.<S3_REGION>.amazonaws.com`
Your bucket must have the following policy that tells S3 to allow public read when an object is located under the public folder:

View File

@ -12,9 +12,10 @@ services:
POSTGRES_PASSWORD: 'typebot'
minio:
image: minio/minio
command: server /data
command: server /data --console-address ":9001"
ports:
- '9000:9000'
- '9001:9001'
environment:
MINIO_ROOT_USER: minio
MINIO_ROOT_PASSWORD: minio123