2026-08-08 14:29:15 -04:00
1 changed files with 15 additions and 0 deletions
@@ -19,6 +19,21 @@ Copy the `.env.docker.sample` file to `.env`. Ensure that the `ROOT_DIRECTORY` v
 and exists on the docker image's filesystem. The credentials for the database doesn't need to be
 changed for development, but if deploying it, it should be modified.

+### S3 Setup
+Using the copied `.env.docker.sample`, ensure that the following has been properly populated.
+```
+S3_ENDPOINT_URL - URL of the S3 bucket
+S3_BUCKET_NAME - Name of the S3 bucket
+GARAGE_S3_REGION - Region of the S3 bucket
+GARAGE_RPC_SECRET - A 32-bit hex string
+GARAGE_DEFAULT_ACCESS_KEY - Access key starting with GK followed with a 16-bit hex string
+GARAGE_DEFAULT_SECRET_KEY - Secret key with a 32-bit hex string
+```
+
+The other S3-related environment variables can be left as is for the sake of getting
+started.
+
+
 Build containers
 ```
 docker compose build --ssh default