chore: add AWS_S3_KEY_PREFIX environment variable support.

Author: plingdevelop

.env.example

@@ -5,13 +5,13 @@
 # -------------------------------
 # General / Logs
 # -------------------------------
-# 클론시 유일한 환경변수 값
+# 클론시 유일한 환경변수 값 (*)
 COMPOSE_PROJECT_NAME=code-push-server
 LOG_LEVEL=debug
 LOG_FORMAT=text
 
 # -------------------------------
-# Database (MySQL)
+# Database (MySQL) (*)
 # - 유저/앱/패키지 메타데이터 저장
 # -------------------------------
 RDS_USERNAME=codepush
@@ -21,12 +21,12 @@ RDS_HOST=127.0.0.1
 RDS_PORT=3306
 
 # -------------------------------
-# Storage Settings
+# Storage Settings (*)
 # storageType: local | s3 | qiniu | oss | tencentcloud
 # -------------------------------
 STORAGE_TYPE=local
 
-# Local storage (default)
+# Local storage (default) (*)
 # 저장 파일이 위치할 경로 (미설정 시 OS tmpdir 사용)
 STORAGE_DIR=./storage
 
@@ -38,22 +38,25 @@ LOCAL_DOWNLOAD_URL=http://127.0.0.1:3000/download
 DOWNLOAD_URL=http://127.0.0.1:3000/download
 
 # -------------------------------
-# JWT Token
+# JWT Token (*)
 # -------------------------------
 TOKEN_SECRET=REPLACE_WITH_RANDOM_LONG_SECRET
 
 # -------------------------------
-# Common Behavior
+# Common Behavior 
 # -------------------------------
+# 프로덕션 배포 및 계정생성 후 false 로 수정
 ALLOW_REGISTRATION=true
 TRY_LOGIN_TIMES=4
 DIFF_NUMS=3
-DATA_DIR=./data
+# DATA_DIR=./data
+# 클라우드 배포시 보통 data 디렉토리에 쓰기 권한이 없음
+DATA_DIR=
 UPDATE_CHECK_CACHE=false
 ROLLOUT_CLIENT_UNIQUE_ID_CACHE=false
 
 # -------------------------------
-# Redis (optional: only needed for login attempt limit or caching)
+# Redis (optional: only needed for login attempt limit or caching) (*)
 # -------------------------------
 REDIS_HOST=127.0.0.1
 REDIS_PORT=6379
@@ -77,12 +80,15 @@ QINIU_SECRET_KEY=
 QINIU_BUCKET_NAME=
 QINIU_DOWNLOAD_URL=
 
+# AWS IAM - admin_codepush with the customS3BucketAccessForCodePush policy (*)
 AWS_ACCESS_KEY_ID=
 AWS_SECRET_ACCESS_KEY=
 AWS_SESSION_TOKEN=
 AWS_BUCKET_NAME=
 AWS_REGION=
 AWS_DOWNLOAD_URL=
+# 버킷내 경로 프리픽스 (optional)
+AWS_S3_KEY_PREFIX=codepush/
 
 OSS_ACCESS_KEY_ID=
 OSS_SECRET_ACCESS_KEY=

.gitignore

@@ -19,4 +19,6 @@ node_modules/
 .idea
 
 # environment variables
-.env
+!.env.example
+.env
+.env.*

Procfile

@@ -0,0 +1 @@
+web: npm start

README.ko.md

@@ -11,6 +11,7 @@ Microsoft 공식 CodePush 서비스는 아시아 지역에서 속도가 느린 
 
 -   Node.js v24.6.0
 -   npm install -g install @shm-open/code-push-cli
+-   data, storage 이름으로 디렉토리 생성후 서버 구동
 
 ## 이 포크(Fork)에 대하여
 

data/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

src/core/config.ts

@@ -53,6 +53,7 @@ export const config = {
         region: process.env.AWS_REGION,
         // binary files download host address.
         downloadUrl: process.env.AWS_DOWNLOAD_URL || process.env.DOWNLOAD_URL,
+        prefix: process.env.AWS_S3_KEY_PREFIX, // (optional)
     },
     // Config for Aliyun OSS (https://www.aliyun.com/product/oss) when storageType value is "oss".
     oss: {

src/core/utils/storage.ts

@@ -78,6 +78,18 @@ function uploadFileToLocal(key: string, filePath: string, logger: Logger): Promi
 function uploadFileToS3(key: string, filePath: string, logger: Logger): Promise<void> {
     return new Promise((resolve, reject) => {
         logger.info('try uploadFileToS3', { key });
+
+        // config.s3.prefix에서 prefix 읽기
+        let prefix = _.get(config, 's3.prefix', '') as string | undefined;
+        prefix = (prefix || '').trim();
+
+        if (prefix.length > 0 && !prefix.endsWith('/')) {
+            prefix += '/';
+        }
+
+        const finalKey = prefix ? `${prefix}${key}` : key;
+        logger.info('uploadFileToS3 resolved finalKey', { key: finalKey });
+
         AWS.config.update({
             accessKeyId: _.get(config, 's3.accessKeyId'),
             secretAccessKey: _.get(config, 's3.secretAccessKey'),
@@ -92,7 +104,7 @@ function uploadFileToS3(key: string, filePath: string, logger: Logger): Promise<
             }
             s3.upload(
                 {
-                    Key: key,
+                    Key: finalKey, // prefix 적용된 key
                     Body: data,
                     ACL: 'public-read',
                     Bucket: _.get(config, 's3.bucketName'),
@@ -101,7 +113,7 @@ function uploadFileToS3(key: string, filePath: string, logger: Logger): Promise<
                     if (error) {
                         reject(new AppError(error));
                     } else {
-                        logger.info('uploadFileToS3 success', { key });
+                        logger.info('uploadFileToS3 success', { key: finalKey });
                         resolve();
                     }
                 },

storage/.gitignore

@@ -0,0 +1,3 @@
+*
+!README.md
+!.gitignore

storage/README.md

@@ -0,0 +1,7 @@
+## 다운로드 에셋 저장용 디렉토리
+
+-   storageType = 'local' 한정 사용
+-   런타임 오류 해결용
+    ```
+    [dev:run] level=error, time=2025-11-16 14:34:04.503, msg=Please create dir ./storage, name=Error, stack=Error: Please create dir ./storage
+    ```