Merge pull request #41 from gokaygurcan/patch-1

docs: update Cloudflare R2 instructions
This commit is contained in:
Mauricio Siu 2025-05-24 17:33:23 -06:00 committed by GitHub
commit 1f4a30d6c0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -6,19 +6,21 @@ description: 'Configure R2 buckets for backup storage. This includes setting up
Cloudflare is a popular choice for hosting static assets, such as images, videos, and documents. It is a cloud-based service that allows you to store and retrieve data from anywhere in the world. This is a great option for storing backups, as it is easy to set up and manage.
1. Create a new bucket and any name you want.
2. Go to initial R2 Screen, and go to `Manager R2 API Tokens` and create a new token.
3. Set a Token Name
1. Go to `R2 Object Storage`, and create a new bucket with any name you want by clicking `Create bucket` button.
2. Go back to `R2 Object Storage`, and select `Manage API tokens` from the select box.
3. Create a new `User API Token`, and give it a meaninful name.
4. Set `Object Read & Write` Permission.
5. (Optional) Set Specify bucket, by default it will include all buckets.
6. Create the token.
Now copy the following variables:
- `Access Key` -> `Access Key (Dokploy)` = eg. `f3811c6d27415a9s6cv943b6743ad784`
- `Secret Key` -> `Secret Key (Dokploy)` = eg. `aa55ee40b4049e93b7252bf698408cc22a3c2856d2530s7c1cb7670e318f15e58`
- `Region` -> `Region (Dokploy)` = eg. `WNAM, ENAM, etc` it will depend on the region you are using.
- `Endpoint` -> `Endpoint (Dokploy)` = eg. `https://8ah554705io7842d54c499fbee1156c1c.r2.cloudflarestorage.com`
- `Bucket` -> `Bucket (Dokploy)` = eg. `dokploy-backups` use the name of the bucket you created.
| (from) Cloudflare | (to) Dokploy | Example value |
|---------------------|---------------------|----------------------------------------------------------------------|
| `Access Key ID` | `Access Key Id` | `f3811c6d27415a9s6cv943b6743ad784` |
| `Secret Access Key` | `Secret Access Key` | `aa55ee40b4049e93b7252bf698408cc22a3c2856d2530s7c1cb7670e318f15e58` |
| `Region` | `Region` | `WNAM, ENAM, etc` it will depend on the region you are using. |
| `Endpoint` | `Endpoint` | `https://8ah554705io7842d54c499fbee1156c1c.r2.cloudflarestorage.com` |
| `Bucket` | `Bucket` | `dokploy-backups` use the name of the bucket you created. |
Test the connection and you should see a success message.
Test the connection and you should see a success message.