docs: Document bring your own Cloud Storage bucket#1856
Open
IchordeDionysos wants to merge 1 commit into
Open
Conversation
superagent-security
Bot
added
contributor:verified
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Comment on lines
+61
to
+71
| 5. **Configure CORS Settings**: | ||
| - Switch to the "Configuration" tab, scroll down to "Cross-origin resource sharing" | ||
| - Click "Edit" and "Allow cross-origin resource sharing" | ||
| - Add the following CORS configuration: | ||
| - Allowed origins: `https://cap.so,https://www.cap.so,https://cap.link,https://www.cap.link` | ||
| - Under "Specify methods", select "GET", "HEAD", and "PUT" | ||
| - For allowed response headers enter: `*` | ||
| - For cache expiry time enter: `3000` | ||
| - Click "Save" | ||
|
|
||
| 4. **Retrieve your S3 Interoperability credentials**: |
Contributor
There was a problem hiding this comment.
Suggested change
| 5. **Configure CORS Settings**: | |
| - Switch to the "Configuration" tab, scroll down to "Cross-origin resource sharing" | |
| - Click "Edit" and "Allow cross-origin resource sharing" | |
| - Add the following CORS configuration: | |
| - Allowed origins: `https://cap.so,https://www.cap.so,https://cap.link,https://www.cap.link` | |
| - Under "Specify methods", select "GET", "HEAD", and "PUT" | |
| - For allowed response headers enter: `*` | |
| - For cache expiry time enter: `3000` | |
| - Click "Save" | |
| 4. **Retrieve your S3 Interoperability credentials**: | |
| 4. **Configure CORS Settings**: | |
| - Switch to the "Configuration" tab, scroll down to "Cross-origin resource sharing" | |
| - Click "Edit" and "Allow cross-origin resource sharing" | |
| - Add the following CORS configuration: | |
| - Allowed origins: `https://cap.so,https://www.cap.so,https://cap.link,https://www.cap.link` | |
| - Under "Specify methods", select "GET", "HEAD", and "PUT" | |
| - For allowed response headers enter: `*` | |
| - For cache expiry time enter: `3000` | |
| - Click "Save" | |
| 5. **Retrieve your S3 Interoperability credentials**: |
Prompt To Fix With AI
This is a comment left during a code review.
Path: apps/web/content/docs/s3-config/google-cloud-storage.mdx
Line: 61-71
Comment:
Steps 4 and 5 are numbered out of order — the list jumps from item 3 directly to item 5, then back to item 4. A user following the guide sequentially would be confused about whether to do CORS first or retrieve credentials first, and would have no item 4 at first glance.
```suggestion
4. **Configure CORS Settings**:
- Switch to the "Configuration" tab, scroll down to "Cross-origin resource sharing"
- Click "Edit" and "Allow cross-origin resource sharing"
- Add the following CORS configuration:
- Allowed origins: `https://cap.so,https://www.cap.so,https://cap.link,https://www.cap.link`
- Under "Specify methods", select "GET", "HEAD", and "PUT"
- For allowed response headers enter: `*`
- For cache expiry time enter: `3000`
- Click "Save"
5. **Retrieve your S3 Interoperability credentials**:
```
How can I resolve this? If you propose a fix, please make it concise.| - Secret Access Key (from interoperability credentials creation) | ||
| - Endpoint (enter "https://storage.googleapis.com") | ||
| - Bucket Name: Your bucket name | ||
| - Region: Your bucket's region (e.g., us-east-1) |
Contributor
There was a problem hiding this comment.
us-east-1 is an AWS region identifier format. Google Cloud Storage regions use a different naming convention (e.g., us-east1, us-central1, europe-west1), without the hyphen before the trailing number. Using an AWS-style name will cause the Cap Desktop configuration to fail when the app tries to resolve the GCS endpoint.
Suggested change
| - Region: Your bucket's region (e.g., us-east-1) | |
| - Region: Your bucket's region (e.g., `us-central1` or `europe-west1`) |
Prompt To Fix With AI
This is a comment left during a code review.
Path: apps/web/content/docs/s3-config/google-cloud-storage.mdx
Line: 86
Comment:
The example region `us-east-1` is an AWS region identifier format. Google Cloud Storage regions use a different naming convention (e.g., `us-east1`, `us-central1`, `europe-west1`), without the hyphen before the trailing number. Using an AWS-style name will cause the Cap Desktop configuration to fail when the app tries to resolve the GCS endpoint.
```suggestion
- Region: Your bucket's region (e.g., `us-central1` or `europe-west1`)
```
How can I resolve this? If you propose a fix, please make it concise.|
|
||
| 1. **Create Service Account First**: | ||
|
|
||
| - Go to in IAM and Admin > Service Accounts, click "Create service account" |
Contributor
There was a problem hiding this comment.
Suggested change
| - Go to in IAM and Admin > Service Accounts, click "Create service account" | |
| - Go to IAM and Admin > Service Accounts, click "Create service account" |
Prompt To Fix With AI
This is a comment left during a code review.
Path: apps/web/content/docs/s3-config/google-cloud-storage.mdx
Line: 30
Comment:
Spurious "in" makes the instruction grammatically incorrect — should read "Go to IAM and Admin".
```suggestion
- Go to IAM and Admin > Service Accounts, click "Create service account"
```
How can I resolve this? If you propose a fix, please make it concise.
Comment on lines
+47
to
+48
| - Under "Data protection", decided whether you want to keep "Soft-delete policy" enabled (this will allow you to recover accidentally deleted files) | ||
| Under "Data protection", keep "Object versioning" disabled |
Contributor
There was a problem hiding this comment.
Data protection bullet is missing its leading - so it renders as a continuation of the first bullet rather than a separate list item.
Suggested change
| - Under "Data protection", decided whether you want to keep "Soft-delete policy" enabled (this will allow you to recover accidentally deleted files) | |
| Under "Data protection", keep "Object versioning" disabled | |
| - Under "Data protection", decide whether you want to keep "Soft-delete policy" enabled (this will allow you to recover accidentally deleted files) | |
| - Under "Data protection", keep "Object versioning" disabled |
Prompt To Fix With AI
This is a comment left during a code review.
Path: apps/web/content/docs/s3-config/google-cloud-storage.mdx
Line: 47-48
Comment:
"decided" should be "decide" (imperative mood), and the second `Data protection` bullet is missing its leading `- ` so it renders as a continuation of the first bullet rather than a separate list item.
```suggestion
- Under "Data protection", decide whether you want to keep "Soft-delete policy" enabled (this will allow you to recover accidentally deleted files)
- Under "Data protection", keep "Object versioning" disabled
```
How can I resolve this? If you propose a fix, please make it concise.|
|
||
| 4. **Retrieve your S3 Interoperability credentials**: | ||
| - In Cloud Storage switch to "Settings" via the side panel. | ||
| - Go to "Interopability" tab |
Contributor
There was a problem hiding this comment.
Suggested change
| - Go to "Interopability" tab | |
| - Go to "Interoperability" tab |
Prompt To Fix With AI
This is a comment left during a code review.
Path: apps/web/content/docs/s3-config/google-cloud-storage.mdx
Line: 73
Comment:
"Interopability" is a misspelling; the correct spelling is "Interoperability". A user searching the GCS UI for the misspelled tab name may not find it.
```suggestion
- Go to "Interoperability" tab
```
How can I resolve this? If you propose a fix, please make it concise.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds documentation on how to configure cap.so to work with your own Cloud Storage bucket.
Greptile Summary
This PR adds a new MDX documentation page guiding users through connecting a Google Cloud Storage bucket to Cap Desktop via S3 interoperability credentials.
us-east-1) uses AWS naming convention; GCS regions follow a different format (us-central1,europe-west1) and the wrong value here will cause the Cap Desktop connection to fail.Confidence Score: 3/5
Two factual errors in the guide would cause users to either get confused by mis-ordered steps or end up with a broken Cap Desktop connection due to the wrong region format.
The mis-numbered sub-steps and the incorrect AWS-style region example are both actionable errors that directly affect users following the documentation — one breaks the logical flow and the other leads to a misconfigured connection that won't work.
apps/web/content/docs/s3-config/google-cloud-storage.mdx — step ordering and region identifier need correction before publishing
Important Files Changed
Prompt To Fix All With AI
Reviews (1): Last reviewed commit: "docs: Document bring your own Cloud Stor..." | Re-trigger Greptile