Skip to content

Commit 18f0721

Browse files
committed
docs: clarify S3 storage configuration for path-style and virtual-hosted-style endpoints
1 parent 0740aaf commit 18f0721

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ If running in production, it might be easier to use a 3rd party SMTP server as i
109109
| `_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. |
110110
| `_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. |
111111
| `_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. |
112-
| `_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. |
113-
| `_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://'). |
112+
| `_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. |
113+
| `_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. |
114114
| `_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. |
115115
| `_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. |
116116
| `_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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,18 @@ _APP_STORAGE_S3_ACCESS_KEY=[ACCESS_KEY_ID]
5656
_APP_STORAGE_S3_SECRET=[SECRET_ACCESS_KEY]
5757
```
5858

59+
Starting from version 1.7.0, you can also use S3-compatible providers by configuring the endpoint:
60+
61+
```bash
62+
# For path-style requests (bucket in the path)
63+
_APP_STORAGE_S3_ENDPOINT=[PROVIDER_ENDPOINT] # e.g., s3.amazonaws.com (without https://)
64+
_APP_STORAGE_S3_BUCKET=[BUCKET_NAME] # bucket name required here
65+
66+
# OR for virtual-hosted-style paths (bucket in the endpoint)
67+
_APP_STORAGE_S3_ENDPOINT=[BUCKET_NAME].[PROVIDER_ENDPOINT] # e.g., bucket-name.s3.amazonaws.com
68+
_APP_STORAGE_S3_BUCKET= # leave this empty when bucket is in the endpoint
69+
```
70+
5971
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:
6072

6173
```bash

0 commit comments

Comments
 (0)