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

@@ -43,7 +43,7 @@ LIVEKIT_API_SECRET=
 # Supported databases:
 # - 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.
 
@@ -52,4 +52,30 @@ DB_TYPE=
 
 # Database connection URL - leave empty for SQLite
 # For PostgreSQL, use format: postgres://username:password@host:port/database?schema=public
-DB_URL=
+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,10 +1,15 @@
 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
@@ -19,12 +24,12 @@ export class StorageManager {
    * Initialize storage based on environment configuration
    */
   async initialize() {
-    const storageType = process.env.STORAGE_TYPE || 'local'
+    const storageType = process.env.STORAGE_TYPE || StorageManager.STORAGE_TYPE.LOCAL;
 
-    if (storageType === 'aws') {
+    if (storageType === StorageManager.STORAGE_TYPE.S3) {
       // Validate required S3 configuration
       if (!process.env.S3_BUCKET_NAME) {
-        throw new Error('S3_BUCKET_NAME is required when STORAGE_TYPE=aws')
+        throw new Error('S3_BUCKET_NAME is required when STORAGE_TYPE=s3')
       }
 
       // Initialize S3 storage
@@ -38,16 +43,16 @@ export class StorageManager {
         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 AWS S3 storage...')
+      console.log('Initializing S3 storage...')
       await this.storage.initialize()
 
     } else if (storageType === 'local') {
@@ -60,7 +65,7 @@ export class StorageManager {
       console.log('Initializing local file storage...')
       await this.storage.initialize()
     } else {
-      throw new Error(`Unsupported storage type: ${storageType}. Supported types: 'local', 'aws'`)
+      throw new Error(`Unsupported storage type: ${storageType}. Supported types: 'local', 's3'`)
     }
 
     // Initialize storage data