read me 업데이트

This commit is contained in:
주수현
2025-07-28 13:43:55 +09:00
parent 6a1c561355
commit d365091ca1

View File

@@ -60,16 +60,6 @@ recycle 은 `core` 모듈을 기반으로 한 `admin`, `front`, `api` 어플리
`-- README.md
```
⚡ AWS S3 업로드를 이용하지 않는다면, pom.xml 에서 `aws`모듈 관련 내용을 삭제하면 된다.
⚡ `admin`, `front`, `api` 중 실제 프로젝트에서 사용할 모듈만 남기고 삭제해주세요.
✔️ Dockerfile 과 .gitlab-ci.yml 은 삭제해주세요 : ) recycle demo 용이기에 여려분의 프로젝트에서는 의미가 없습니다.
recycle 의 demo 가 궁금하다면 아래 URL 에서 확인 해주세요.
- `recycle-admin` - https://recycle-admin.etribe.co.kr 계정정보 (recycle-super/recycle1@#$)
- `recycle-api` - https://recycle-api.etribe.co.kr/swagger-ui/index.html
- `recycle-front` - https://recycle-front.etribe.co.kr/ 계정정보 (generalUser/generalUser1@#$)
### 각 모듈의 내부 구조(헥사고날 아키텍처 예시)
```
@@ -95,23 +85,23 @@ usecase/
프레임워크 실행 시 필요한 자바 VM 옵션은 아래와 같다.
| VM 변수 | 설명 | 설정 값 | 필수여부 |
|-------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|-------------------------|------|
| -Dspring.profiles.active | Spring active 프로파일 | local, dev, prod | Y |
| -Dapp.initData.core | 어플리케이션 초기 구동에 필요한 필수 데이터 생성여부 | true, false | N |
| -Dspring.sql.init.mode | SQL 초기화 모드를 설정 | always, embedded, never | N |
| -Dpath.upload.public | 파일 업로드 경로 | 기본값 (~/upload/public) | N |
| -Dpath.upload.tmpdir | 임시 파일 업로드 경로 | 기본값 (~/upload/tmpdir) | N |
| -Dlogging.file.path | 로그 파일 생성 경로 | 기본값 (~/logs) | N |
| -Dfile.encoding | JVM 속성 | `UTF-8` | Y |
| -Djava.net.preferIPv4Stack | JVM 속성. 클라이언트 IP체크시 IPv4 형식을 사용하기 위함. | true | Y |
| -Dcom.amazonaws.sdk.disableEc2Metadata | aws 모듈의 ec2 metadata 전송 끄기 | true | N |
| **-Dserver.port** | 서버 포트 (없다면 기본 8080) | 원하는 port | N |
| **-Dserver.forward-headers-strategy** | 프록시 서버(nginx, apache)에 정의된 `X-Forward-For`, `X-Forwarded-Proto` 설정값을 이용하려면 `native` 로 설정해주면 된다. (내장 컨테이너를 사용하는 경우에만 유효) | `native` | N |
| **-Dspring.datasource.driver-class-name** | JDBC Driver. 없다면 JDBC URL을 기준으로 JPA가 판단한다. | jdbc 드라이버 | Y |
| **-Dspring.datasource.url** | JDBC URL | jdbc url | N |
| **-Dspring.datasource.username** | DB Username | DB 사용자 | Y |
| **-Dspring.datasource.password** | DB Password | DB 패스워드 | Y |
| VM 변수 | 설명 | 설정 값 | 필수여부 |
|---------------------------------------------|---------------------------------------|-------------------------|------|
| -Dspring.profiles.active | Spring active 프로파일 | local, dev, prod | Y |
| -Dapp.initData.core | 어플리케이션 초기 구동에 필요한 필수 데이터 생성여부 | true, false | N |
| -Dspring.sql.init.mode | SQL 초기화 모드를 설정 | always, embedded, never | N |
| -Dpath.upload.public | 파일 업로드 경로 | 기본값 (~/upload/tmpdir) | N |
| -Dfile.encoding | JVM 속성 | `UTF-8` | Y |
| -Djava.net.preferIPv4Stack | JVM 속성. 클라이언트 IP체크시 IPv4 형식을 사용하기 위함. | true | Y |
| -Dlogging.level.org.springframework.security | 디버깅 레벨 | true | Y |
| -Daes.secret-key | 암호화 시크릿 키 | true | Y |
| **-Dserver.port** | 서버 포트 (없다면 기본 8080) | 원하는 port | Y |
| **-Dpath.upload.storage** | 파일 저장 방법 | jdbc 드라이버 | Y |
| **-Dpath.upload.sftp.public** | sftp 파일 경로 | jdbc url | Y |
| **-Dfile.upload.sftp.ip** | sftp 아이피 | SFTP 아이피 | Y |
| **-Dfile.upload.sftp.id** | sftp 아이디 | SFTP 사용자 | Y |
| **-Dfile.upload.sftp.password** | DB Password | SFTP 패스워드 | Y |
| **-Dfile.upload.sftp.port** | DB Port | SFTP 포트 | Y |
### VM Options 예시
@@ -120,11 +110,10 @@ usecase/
-Dspring.profiles.active=local
-Dapp.initData.core=false
-Dspring.sql.init.mode=never
-Dpath.upload.public=${user.home}/upload/public
-Dfile.encoding=UTF-8
-Djava.net.preferIPv4Stack=true
-Dcom.amazonaws.sdk.disableEc2Metadata=true
-Dserver.port=8080
-Dserver.forward-headers-strategy=native
-Dserver.port=8081
-Dlogging.level.org.springframework.security=DEBUG
-Daes.secret-key=092HW829O0A0AVR0
-Dpath.upload.storage=LOCAL
@@ -229,26 +218,14 @@ front-app-ERROR.log # 프론트 로그 중 ERROR 부분 필터링
```shell
-Dpath.upload.public=~/upload/public # 파일 업로드 경로
-Dpath.upload.tmpdir=~/upload/tmpdir # tmp 디렉토리 경로
```
파일 업로드 경로가 지정되면 사용자가 업로드한 파일은 이 경로를 기준으로 `주제`/`년월일` 폴더 아래에 저장됩니다.
tmpdir 은 서블릿 컨테이너가 multipart 파일 업로드 시 대용량 처리를 위해 임시파일을 저장하는 공간입니다.
파일 시스템 외에 AWS S3 로도 업로드해야 한다면, 아래 AWS CLI 를 이용하기 위한 정보를 제공해주어야 합니다.
```shell
-Dapp.aws.s3.accessKey=AKIAZF27HETWNITZBZOF # AMI 에서 발급한 사용자 엑세스 키
-Dapp.aws.s3.secretKey=IhnTG0X7Wav8ak3cbYR1l8UAjL+gbnXdWJRM11cx # AMI 에서 발급한 사용자 시크릿 키
-Dapp.aws.s3.bucketName=etribe # S3 버킷 이름
-Dapp.aws.s3.bucketFolder=/recycle/upload # S3 버킷 디렉토리
-Dapp.aws.s3.domain=dixjkmptx5pkm.cloudfront.net # S3 혹은 cloudfront 도메인
```
파일 업로드 경로가 지정되면 사용자가 업로드한 파일은 이 경로를 기준으로 `주제`/`년월일` 폴더 아래에 저장됩니다.
🔑 위 accessKey 정보는 제가 만든 임시 정보이며, recycle 데모용으로만 사용되니 참고해주세요.
💡 recycle 은 파일 시스템 업로드와 S3 업로드를 사용 목적에 맞게 선택할 수 있는 유연성을 제공합니다.
`FileUploadType`은 파일 업로드가 필요한 주제 도메인들이 정의된 enum 객체입니다. 여기 기술된 `FileStorageType` 속성에 따라 파일 업로드 경로가 결정됩니다.
💡
`FileUploadType`은 파일 업로드가 필요한 주제 도메인들이 정의된 enum 객체입니다. 여기 path.upload.storage 옵션에 따라 파일 업로드 경로가 결정됩니다.
### 파일 참조
@@ -363,7 +340,6 @@ WHERE seq = ${seq}
배포방식 설정을 위해 두가지 maven 프로파일을 제공한다.
* `jar` (default)
* `war` Jeus, WebLogic, Tomcat 등 별도 외장 컨테이너 이용시 사용
maven 빌드 시 프로파일을 지정하지 않으면 기본 `jar` 프로파일로 동작하고, `war` 의 경우 명시적인 지정이 필요하다.
@@ -378,28 +354,6 @@ $ ll admin/target
-rw-r--r-- 1 user 197121 94905770 4월 22 09:59 admin-0.0.1-SNAPSHOT.war
```
## 개발 서버 환경
### database - postgresql 14.17
```
URL: jdbc:postgresql://15.165.180.203:5432/korea_research
USERNAME: ko_research
PASSWORD: koresearch1@#4
```
### 🚀 ADMIN DEPLOY
#### `deploy_dev_admin` 브렌치로 merge! pipeline 실행 후 아래 URL 에서 확인가능.
* https://ko-research-admin.etribe.co.kr
### 🚀 FRONT DEPLOY
#### `deploy_dev_front` 브렌치로 merge! pipeline 실행 후 아래 URL 에서 확인가능.
* https://ko-research-front.etribe.co.kr
### 운영서버 배포 스크립트
## SFTP 접근