Improves docs for storage (#486)

parcelvoy · Aug 9, 2024 · 8ac0405 · 8ac0405
1 parent 100b78f
commit 8ac0405
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 8 deletions.
diff --git a/docs/docs/advanced/storage.md b/docs/docs/advanced/storage.md
@@ -14,16 +14,21 @@ Under the hood it is utilizing the AWS S3 SDK so please consult whatever service
 The URL that is generated for referencing each image can be overriden using the `STORAGE_BASE_URL` key.
 
 ### Configuration
-| key | type | required | default |
-|--|--|--|--|
-| STORAGE_DRIVER | "s3" | true |
-| STORAGE_BASE_URL | string | true |
-| STORAGE_S3_BUCKET | string | true |
-| STORAGE_S3_ENDPOINT | string | false |
-| STORAGE_S3_FORCE_PATH_STYLE | boolean | false | false |
-| AWS_REGION | string | false | us-east-1 |
+| Key | Type | Required | Default | Details
+|--|--|--|--|--|
+| STORAGE_DRIVER | s3 | true |
+| STORAGE_BASE_URL | string | true || Override the base path used for image URLs
+| STORAGE_S3_BUCKET | string | true || The name of your bucket
+| STORAGE_S3_ENDPOINT | string | false || If using a service other than AWS S3, the endpoint for the object storage
+| STORAGE_S3_FORCE_PATH_STYLE | boolean | false | false | Enable if using a service other than AWS S3
+| AWS_REGION | string | false | us-east-1 | The region your bucket is in
 | AWS_ACCESS_KEY_ID | string | true |
 | AWS_SECRET_ACCESS_KEY | string | true |
 
+### Usage With Other S3-Compatible Services
+If you want to utilize a S3-compatible object storage service other than S3 you will need to configure a few additional parameters to ensure the AWS defaults are not being used:
+- `STORAGE_S3_FORCE_PATH_STYLE`: Set this to `true`
+- `STORAGE_S3_ENDPOINT`: Enter the base URL provided by the service you are using.
+
 ### Use with CDN
 If you are utilizing a CDN in front of your bucket, you can set the URL of the CDN to be used for all images by utilizing the `STORAGE_BASE_URL` parameter. Utilizing this parameter will rewrite all image URLs to use that as the base url instead of the S3 endpoint.
diff --git a/docs/docs/deploy/aws-ec2.md b/docs/docs/deploy/aws-ec2.md
@@ -58,3 +58,14 @@ docker compose up -d # run the Docker container
 
 7. Setup security groups
 Based on what port you are using for the UI portion, you will want to make sure you have configured that port to be open as well in your security groups.
+
+8. Upgrading versions
+:::note
+If you are running a single instance of Parcelvoy you will experience downtime when upgrading versions, it's recommended for high availability to run Parcelvoy in an auto-scaling group with rolling deployments.
+:::
+
+```
+docker compose down
+docker compose pull
+docker compose up -d
+```