From 84e6ff4718089715be0ae838e57243077598776d Mon Sep 17 00:00:00 2001
From: phoenix <mail@kundeng.us>
Date: Sat, 8 Aug 2026 12:45:54 -0400
Subject: [PATCH] Updating readme

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index 797cb43..9261adc 100644
--- a/README.md
+++ b/README.md
@@ -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