-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for configuring bucket credentials for S3, GCP, and…
… Cloudflare. (#33)
- Loading branch information
1 parent
8098172
commit 8b8b034
Showing
8 changed files
with
110 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
title: Cloudflare R2 | ||
subtitle: Store recordings of chat conversations in Cloudflare R2 | ||
slug: providers/cloud/cloudflare | ||
--- | ||
|
||
Your assistants can be configured to record chat conversations and upload | ||
the recordings to a bucket in Cloudflare R2 when the conversation ends. You will | ||
need to configure the credential and bucket settings in the "Cloud Providers" | ||
section of the "Provider Credentials" page in the Vapi dashboard. | ||
|
||
See these [instructions](https://developers.cloudflare.com/r2/api/s3/tokens/) for generating R2 tokens and access keys. | ||
|
||
## Credential Settings | ||
|
||
Setting | Description | ||
------------------------ | ------------------------------------------------------- | ||
Cloudflare Account ID | Your customer account id for Cloudflare | ||
Cloudflare Account Email | The email address associated with the account id | ||
Cloudflare API Key/Token | The value of an API Key/Token generated for the account (Cloudflare uses the terms API Key and API Token interchangeably) | ||
Bucket Name | The name of the bucket in R2 to upload recordings to | ||
Bucket URL | This is required only for buckets with a custom hostname or domain name. Enter the hostname for the bucket. You will need to set up a CORS policy in R2 for the hostname/domain name. See [instructions](https://developers.cloudflare.com/r2/buckets/cors/) for configuring CORS. | ||
Bucket Path Prefix | An optional path prefix for recordings uploaded to the bucket | ||
Bucket Access Key ID | The access key id associated with the API token you generated for R2 (this a string of 32 characters) | ||
Bucket Secret Access Key | The secret access key associated with the API token you generated for R2 (this is a string of 64 characters) | ||
|
||
## Example | ||
|
||
<Frame caption="Example Configuration"> | ||
<img src="../../static/images/credentials/provider/cloud-provider-cloudflare-r2.png" /> | ||
</Frame> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
title: GCP Cloud Storage | ||
subtitle: Store recordings of chat conversations in GCP Cloud Storage | ||
slug: providers/cloud/gcp | ||
--- | ||
|
||
Your assistants can be configured to record chat conversations and upload | ||
the recordings to a bucket in GCP Cloud Storage when the conversation ends. You will | ||
need to configure the credential and bucket settings in the "Cloud Providers" | ||
section of the "Provider Credentials" page in the Vapi dashboard. | ||
|
||
See these [instructions](https://cloud.google.com/iam/docs/keys-create-delete) for generating service account keys for GCP. | ||
|
||
See these [instructions](https://cloud.google.com/storage/docs/authentication/hmackeys) for generating HMAC Keys for Cloud Storage. | ||
|
||
## Credential Settings | ||
|
||
Setting | Description | ||
------------------------------ | ------------------------------------------------------- | ||
Credential Reference Name | The credential reference name | ||
GCP Service Account Key (JSON) | The service account key in JSON format | ||
Bucket Name | The name of the bucket to upload recordings to | ||
Bucket Region | The name of the region where the bucket is located | ||
Bucket Path Prefix | An optional path prefix for recordings uploaded to the bucket | ||
HMAC Access Key | The HMAC access key for the GCP Cloud Storage API (This is a string of 24 characters when linked to a user account or a string of 61 characters when linked to a service account.) | ||
HMAC Secret | The HMAC secret for the GCP Clodu Storage API (This is a 40-character base-64 encoded string.) | ||
|
||
## Example | ||
|
||
<Frame caption="Example Configuration"> | ||
<img src="../../static/images/credentials/provider/cloud-provider-gcp-hmac.png" /> | ||
</Frame> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
title: AWS S3 | ||
subtitle: Store recordings of chat conversations in AWS S3 | ||
slug: providers/cloud/s3 | ||
--- | ||
|
||
Your assistants can be configured to record chat conversations and upload | ||
the recordings to a bucket in AWS S3 when the conversation ends. You will | ||
need to configure the credential and bucket settings in the "Cloud Providers" | ||
section of the "Provider Credentials" page in the Vapi dashboard. | ||
|
||
See these [instructions](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-keys-admin-managed.html) for generating AWS access keys. | ||
|
||
## Credential Settings | ||
|
||
Setting | Description | ||
------------------------ | ------------------------------------------------------- | ||
AWS Access Key ID | The access key id for AWS | ||
AWS Secret Access Key | The secret access key for AWS | ||
S3 Bucket Name | The name of the bucket to upload recordings to | ||
S3 Path Prefix | An optional path prefix for recordings uploaded to the bucket | ||
|
||
## Example | ||
|
||
<Frame caption="Example Configuration"> | ||
<img src="../../static/images/credentials/provider/cloud-provider-aws-s3.png" /> | ||
</Frame> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+168 KB
fern/static/images/credentials/provider/cloud-provider-cloudflare-r2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.