docs: add Google Cloud Storage for S3 Destination #75
Conversation
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
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for configuring Google Cloud Storage as an S3-compatible backup destination in Dokploy. It provides step-by-step instructions for setting up GCS buckets, service accounts, and HMAC keys.
- Documents the setup process for Google Cloud Storage integration
- Provides a mapping table between GCS and Dokploy configuration fields
- Includes example values for configuration parameters
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 3. Return to Cloud Storage again, and click `Settings` on the left navigation menu. | ||
| 4. Click `Interoperability` tab. This is where you will create Amazon S3-compatible ID and access keys. | ||
| 5. Copy the value in `Storage URI`. You will need this for the Endpoint value in Dokploy. | ||
| 6. Under `Service account HMAC`, click `Create a key for a service account`. Select the service account you created earlier and click `Create`. You will get an Access Key and a Secret Key. |
There was a problem hiding this comment.
Minor correction: 'Secret Key' should be 'Secret' to match the terminology used in the mapping table below.
Suggested change
| 6. Under `Service account HMAC`, click `Create a key for a service account`. Select the service account you created earlier and click `Create`. You will get an Access Key and a Secret Key. | |
| 6. Under `Service account HMAC`, click `Create a key for a service account`. Select the service account you created earlier and click `Create`. You will get an Access Key and a Secret. |
Comment on lines
+21
to
+22
| | `Access Key` | `Access Key ID` | `f3811c6d27415a9s6cv943b6743ad784` | | ||
| | `Secret` | `Secret Access Key` | `aa55ee40b4049e93b7252bf698408cc22a3c2856d2530s7c1cb7670e318f15e58` | |
There was a problem hiding this comment.
The example Access Key contains 's' and 'v' characters which are not valid in hexadecimal strings. Should be corrected to use only valid hexadecimal characters (0-9, a-f).
Suggested change
| | `Access Key` | `Access Key ID` | `f3811c6d27415a9s6cv943b6743ad784` | | |
| | `Secret` | `Secret Access Key` | `aa55ee40b4049e93b7252bf698408cc22a3c2856d2530s7c1cb7670e318f15e58` | | |
| | `Access Key` | `Access Key ID` | `f3811c6d27415a9a6cb943b6743ad784` | | |
| | `Secret` | `Secret Access Key` | `aa55ee40b4049e93b7252bf698408cc22a3c2856d2530a7c1cb7670e318f15e58` | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Hi, first of all thanks for this awesome project! I really like it and use it for my hobby projects.
This PR adds a new sub page under S3 Destination. It describes the instruction on how to set up Google Cloud Storage and Dokploy to use the storage service as an S3 destination for backup.