refactor(storage): rename aws storage to s3, update env vars and docs for S3-compatible storage support (CloudFlare R2, DigitalOcean Spaces, etc.)

Author: DevStarlight

.env.example

@@ -62,7 +62,7 @@ LIVEKIT_API_SECRET=
 
 # - SQLite (default - no configuration needed)
 # - PostgreSQL (DB_TYPE=pg with DB_URL)
-# 
+#
 # If DB_TYPE and DB_URL are not provided or empty,
 # the application will automatically use SQLite in the world folder.
 
@@ -72,3 +72,29 @@ DB_TYPE=
 # Database connection URL - leave empty for SQLite
 # For PostgreSQL, use format: postgres://username:password@host:port/database?schema=public
 DB_URL=
+
+# ==============================================
+# STORAGE CONFIGURATION
+# ==============================================
+# Configure your file storage system here.
+# 
+# Supported storage types:
+# - Local file system (default - no configuration needed)
+# - S3-compatible storage (CloudFlare R2, AWS S3, DigitalOcean Spaces, etc.)
+#
+# If STORAGE_TYPE is set to 's3', S3-compatible storage will be used.
+# If STORAGE_TYPE is empty or not set, local file storage will be used.
+# 
+# S3 credentials can be provided via environment variables below,
+# or through AWS CLI configuration, IAM roles, or instance profiles.
+
+# S3 storage configuration (only required when using S3)
+# To use S3-compatible storage, set STORAGE_TYPE and other S3 variables below
+STORAGE_TYPE=
+S3_BUCKET_NAME=bucket-name
+S3_ACCESS_KEY_ID=access-key-id
+S3_SECRET_ACCESS_KEY=secret-key-id
+S3_REGION=eu-west-1
+S3_ASSETS_PREFIX=
+S3_COLLECTIONS_PREFIX=
+S3_STORAGE_PREFIX=

src/server/storage/AwsS3Storage.js renamed to src/server/storage/S3Storage.js

@@ -4,7 +4,7 @@ import fs from 'fs-extra'
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner'
 import { S3Client, PutObjectCommand, GetObjectCommand, HeadObjectCommand, ListObjectsV2Command, DeleteObjectCommand } from '@aws-sdk/client-s3'
 
-export class AwsS3Storage {
+export class S3Storage {
   constructor(config) {
     this.bucketName = config.bucketName
     this.region = config.region || 'us-east-1'

src/server/storage/StorageManager.js

@@ -1,16 +1,21 @@
 import path from 'path'
 import { throttle } from 'lodash-es'
 
-import { AwsS3Storage } from './AwsS3Storage.js'
+import { S3Storage } from './S3Storage.js'
 import { FileStorage } from './FileStorage.js'
 
 export class StorageManager {
+  static STORAGE_TYPE = {
+    LOCAL: 'local',
+    S3: 's3',
+  }
+
   constructor() {
     this.storage = null
     this.isS3 = false
     this.storageData = {}
     this.storageLoaded = false
-    
+
     // Throttle saves to avoid too many writes
     this.saveStorageData = throttle(() => this.persistStorageData(), 1000, { leading: true, trailing: true })
   }
@@ -30,26 +35,26 @@ export class StorageManager {
         storagePrefix: process.env.S3_STORAGE_PREFIX || 'storage/',
         cloudfrontUrl: process.env.CLOUDFRONT_URL,
       }
-      
-      if (process.env.AWS_ACCESS_KEY_ID && process.env.AWS_SECRET_ACCESS_KEY) {
+
+      if (process.env.S3_ACCESS_KEY_ID && process.env.S3_SECRET_ACCESS_KEY) {
         s3Config.credentials = {
-          accessKeyId: process.env.AWS_ACCESS_KEY_ID,
-          secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
+          accessKeyId: process.env.S3_ACCESS_KEY_ID,
+          secretAccessKey: process.env.S3_SECRET_ACCESS_KEY,
         }
       }
-      
-      this.storage = new AwsS3Storage(s3Config)
-      
+
+      this.storage = new S3Storage(s3Config)
+
       console.log('Initializing S3 storage...')
       await this.storage.initialize()
-      
+
     } else {
       // Initialize local file storage
       this.isS3 = false
       this.storage = new FileStorage({
         assetsUrl: '/assets/',
       })
-      
+
       console.log('Initializing local file storage...')
       await this.storage.initialize()
     }
@@ -96,7 +101,7 @@ export class StorageManager {
       console.warn('Storage not yet loaded, cannot set value')
       return
     }
-    
+
     try {
       // Ensure value is serializable
       value = JSON.parse(JSON.stringify(value))
@@ -115,7 +120,7 @@ export class StorageManager {
       console.warn('Storage not yet loaded, cannot persist')
       return
     }
-    
+
     try {
       await this.storage.saveStorageData(this.storageData)
       // console.log('Storage data persisted successfully')
@@ -180,7 +185,7 @@ export class StorageManager {
     if (this.isS3) {
       // If CloudFront URL is configured, use it with assets prefix
       if (process.env.CLOUDFRONT_URL) {
-        const baseUrl = process.env.CLOUDFRONT_URL.endsWith('/') 
+        const baseUrl = process.env.CLOUDFRONT_URL.endsWith('/')
           ? process.env.CLOUDFRONT_URL.slice(0, -1)  // Remove trailing slash
           : process.env.CLOUDFRONT_URL
         const assetsPrefix = (process.env.S3_ASSETS_PREFIX || 'assets/').replace(/\/$/, '') // Remove trailing slash