Merge pull request #2046 from appwrite/clarify-bucket-app-storage-endpoint

Clarify S3 storage configuration for path-style and virtual-hosted-style endpoints

Author: stnguyen90

src/routes/docs/advanced/self-hosting/environment-variables/+page.markdoc

@@ -109,8 +109,8 @@ If running in production, it might be easier to use a 3rd party SMTP server as i
 | `_APP_STORAGE_S3_ACCESS_KEY`                | **version >= 0.13.0** AWS S3 storage access key. Required when the storage adapter is set to S3. You can get your access key from your AWS console.                                                                                |
 | `_APP_STORAGE_S3_SECRET`                    | **version >= 0.13.0** AWS S3 storage secret key. Required when the storage adapter is set to S3. You can get your secret key from your AWS console.                                                                               |
 | `_APP_STORAGE_S3_REGION`                    | **version >= 0.13.0** AWS S3 storage region. Required when storage adapter is set to S3. You can find your region info for your bucket from AWS console.                                                                          |
-| `_APP_STORAGE_S3_BUCKET`                    | **version >= 0.13.0** AWS S3 storage bucket. Required when storage adapter is set to S3. You can create buckets in your AWS console.                                                                                               |
-| `_APP_STORAGE_S3_ENDPOINT`                  | **version >= 1.7.0** Override the S3 endpoint to use an S3-compatible provider. This should just be the host (without 'https://').                                                                                                |
+| `_APP_STORAGE_S3_BUCKET`                    | **version >= 0.13.0** AWS S3 storage bucket. Required when storage adapter is set to S3 and using path-style requests (where the bucket is in the path). You can create buckets in your AWS console. If using virtual-hosted-style paths where the bucket is in the endpoint URL, this should be empty.                         |
+| `_APP_STORAGE_S3_ENDPOINT`                  | **version >= 1.7.0** Override the S3 endpoint to use an S3-compatible provider. This should just be the host (without 'https://'). If using virtual-hosted-style paths where the bucket is included in the endpoint (e.g., `bucket-name.s3.amazonaws.com`), `_APP_STORAGE_S3_BUCKET` should be empty. For path-style requests, the endpoint should not include the bucket name and `_APP_STORAGE_S3_BUCKET` should be set.      |
 | `_APP_STORAGE_DO_SPACES_ACCESS_KEY`         | **version >= 0.13.0** DigitalOcean spaces access key. Required when the storage adapter is set to DOSpaces. You can get your access key from your DigitalOcean console.                                                            |
 | `_APP_STORAGE_DO_SPACES_SECRET`             | **version >= 0.13.0** DigitalOcean spaces secret key. Required when the storage adapter is set to DOSpaces. You can get your secret key from your DigitalOcean console.                                                           |
 | `_APP_STORAGE_DO_SPACES_REGION`             | **version >= 0.13.0** DigitalOcean spaces region. Required when storage adapter is set to DOSpaces. You can find your region info for your space from DigitalOcean console.                                                       |

src/routes/integrations/storage-s3/+page.markdoc

@@ -8,13 +8,13 @@ isPartner: true
 isNew: false
 cover: /images/integrations/storage-s3/cover.png
 category: storage
-product: 
+product:
     avatar: '/images/integrations/avatars/aws.png'
     vendor: AWS
     description: 'Amazon S3 is an object storage service that offers industry-leading scalability, data availability, security, and performance.'
-platform: 
+platform:
     - 'Self-hosted'
-images: 
+images:
     - /images/integrations/storage-s3/cover.png
     - /images/integrations/storage-s3/bucket.png
     - /images/integrations/storage-s3/access-key.png
@@ -50,10 +50,22 @@ Visit the `.env` file created for your Appwrite instance and update the followin
 
 ```bash
 _APP_STORAGE_DEVICE=s3
-_APP_STORAGE_S3_BUCKET=[BUCKET_NAME]
-_APP_STORAGE_S3_REGION=[AWS_REGION]
-_APP_STORAGE_S3_ACCESS_KEY=[ACCESS_KEY_ID]
-_APP_STORAGE_S3_SECRET=[SECRET_ACCESS_KEY]
+_APP_STORAGE_S3_BUCKET=<BUCKET_NAME>
+_APP_STORAGE_S3_REGION=<AWS_REGION>
+_APP_STORAGE_S3_ACCESS_KEY=<ACCESS_KEY_ID>
+_APP_STORAGE_S3_SECRET=<SECRET_ACCESS_KEY>
+```
+
+Starting from version 1.7.0, you can also use S3-compatible providers by configuring the endpoint:
+
+```bash
+# For path-style requests (bucket in the path)
+_APP_STORAGE_S3_ENDPOINT=<PROVIDER_ENDPOINT> # e.g., s3.amazonaws.com (without https://)
+_APP_STORAGE_S3_BUCKET=<BUCKET_NAME> # bucket name required here
+
+# OR for virtual-hosted-style paths (bucket in the endpoint)
+_APP_STORAGE_S3_ENDPOINT=<BUCKET_NAME>.<PROVIDER_ENDPOINT> # e.g., bucket-name.s3.amazonaws.com
+_APP_STORAGE_S3_BUCKET= # leave this empty when bucket is in the endpoint
 ```
 
 After that, run the following Docker Compose commands in your terminal to restart your Appwrite containers and verify if the changes have been successfully applied: