More env renaming

Author: Rajat Saxena

README.md

@@ -23,7 +23,7 @@ Before you start uploading to your bucket, make sure you have set up the correct
 If you need to use a Cloudfront CDN, you can enable it in the app, by setting up the following values in your .env file.
 
 ```sh
-USE_CLOUDFRONT=true
+ACCESS_PRIVATE_BUCKET_VIA_CLOUDFRONT=true
 CDN_ENDPOINT=CLOUDFRONT_DISTRIBUTION_NAME
 CLOUDFRONT_PRIVATE_KEY="PRIVATE_KEY"
 CLOUDFRONT_KEY_PAIR_ID=KEY_PAIR_ID

apps/api/src/config/constants.ts

@@ -54,7 +54,8 @@ export const PATH_PREFIX = process.env.PATH_PREFIX || "";
 export const HOUR_IN_SECONDS = 1000 * 60 * 60;
 
 // Cloudfront config
-export const USE_CLOUDFRONT = process.env.USE_CLOUDFRONT === "true";
+export const ACCESS_PRIVATE_BUCKET_VIA_CLOUDFRONT =
+    process.env.ACCESS_PRIVATE_BUCKET_VIA_CLOUDFRONT === "true";
 export const CLOUDFRONT_KEY_PAIR_ID = process.env.CLOUDFRONT_KEY_PAIR_ID || "";
 export const CLOUDFRONT_PRIVATE_KEY = process.env.CLOUDFRONT_PRIVATE_KEY || "";
 export const CDN_MAX_AGE = process.env.CDN_MAX_AGE

apps/api/src/media/service.ts

@@ -6,7 +6,7 @@ import {
     imagePattern,
     videoPattern,
     imagePatternForThumbnailGeneration,
-    USE_CLOUDFRONT,
+    ACCESS_PRIVATE_BUCKET_VIA_CLOUDFRONT,
     PATH_PREFIX,
     DISABLE_TAGGING,
 } from "../config/constants";
@@ -298,7 +298,7 @@ async function getPrivateFileUrl(media: MediaWithUserId, thumb?: boolean) {
         filename,
     });
 
-    return USE_CLOUDFRONT
+    return ACCESS_PRIVATE_BUCKET_VIA_CLOUDFRONT
         ? generateCloudfrontSignedUrl(key)
         : await generateSignedUrl(key);
 }

apps/docs/content/docs/self-hosting.mdx

@@ -22,4 +22,30 @@ Coming soon
         }
     ]
 }
+```
+
+## S3 Storages
+
+### AWS S3
+
+```
+CLOUD_KEY=your_aws_access_key
+CLOUD_SECRET=your_aws_secret_key
+CLOUD_BUCKET_NAME=your_bucket_name
+CLOUD_REGION=ap-southeast-1
+CDN_ENDPOINT=https://your-cloudfront-endpoint.example.com # OR https://<bucket-name>.s3.<region>.amazonaws.com
+ACCESS_PRIVATE_BUCKET_VIA_CLOUDFRONT=true # If you want to access the private bucket's content via Cloudfront
+CLOUDFRONT_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\nYOUR_PRIVATE_KEY_CONTENTS\n-----END PRIVATE KEY-----"
+CLOUDFRONT_KEY_PAIR_ID=YOUR_KEY_PAIR_ID
+```
+
+### Cloudflare R2
+
+```
+CLOUD_KEY=your_cloudflare_r2_access_key
+CLOUD_SECRET=your_cloudflare_r2_secret_key
+CLOUD_BUCKET_NAME=your_bucket_name
+CLOUD_REGION=auto
+CLOUD_ENDPOINT=https://<your-account-id>.r2.cloudflarestorage.com
+CDN_ENDPOINT=https://<your-cdn-endpoint>.r2.dev
 ```

docker-compose.yml

@@ -16,7 +16,7 @@ services:
       - TEMP_FILE_DIR_FOR_UPLOADS=${TEMP_FILE_DIR_FOR_UPLOADS?'A temporary directory for uploads transformations is required'}
       - PORT=8000
       - ENABLE_TRUST_PROXY=${ENABLE_TRUST_PROXY}
-      - USE_CLOUDFRONT=${USE_CLOUDFRONT} 
+      - ACCESS_PRIVATE_BUCKET_VIA_CLOUDFRONT=${ACCESS_PRIVATE_BUCKET_VIA_CLOUDFRONT} 
       - CDN_ENDPOINT=${CDN_ENDPOINT} 
       - CLOUDFRONT_KEY_PAIR_ID=${CLOUDFRONT_KEY_PAIR_ID} 
       - CLOUDFRONT_PRIVATE_KEY=${CLOUDFRONT_PRIVATE_KEY}