fix: Correct README with actual service names and configurations

- 실제 docker-compose.yml 서비스 이름으로 수정
- 정확한 포트 매핑 정보 업데이트
- 환경 변수 설정 방법 구체화
- Pipeline 설정 파일 생성 방법 추가
- 존재하지 않는 서비스 제거 (korea-backend, usa-backend 등)
This commit is contained in:
jungwoo choi
2025-09-28 20:48:59 +09:00
parent 9e80618005
commit 1ff9afe6f4

119
README.md
View File

@ -34,15 +34,24 @@ Site11은 다국어 뉴스 콘텐츠를 자동으로 수집, 번역, 생성하
### 포트 사용 ### 포트 사용
``` ```
- 80: Nginx (Reverse Proxy) - 3000: Console Frontend
- 8000-8100: 마이크로서비스 백엔드 - 8011: Console Backend (API Gateway)
- 3000-3100: 프론트엔드 서비스 - 8012: Users Backend
- 27017: MongoDB - 8013: Notifications Backend
- 6379: Redis - 8014: OAuth Backend
- 9092: Kafka - 8015: Images Backend
- 2181: Zookeeper - 8016: Google Search Backend
- 9000: MinIO - 8017: RSS Feed Backend
- 8983: Solr - 8018: News Aggregator Backend
- 8019: AI Writer Backend
- 8100: Pipeline Monitor
- 8983: Solr Search Engine
- 9000: MinIO Object Storage
- 9001: MinIO Console
- 27017: MongoDB (내부)
- 6379: Redis (내부)
- 9092: Kafka (내부)
- 2181: Zookeeper (내부)
``` ```
## 빠른 시작 (Quick Start) ## 빠른 시작 (Quick Start)
@ -61,10 +70,13 @@ cd site11
# .env 파일 생성 # .env 파일 생성
cp .env.example .env cp .env.example .env
# 필수 환경 변수 설정 # 필수 환경 변수 편집 (실제 API 키로 교체 필요)
echo "COMPOSE_PROJECT_NAME=site11" >> .env vim .env
echo "DEEPL_API_KEY=your-deepl-api-key" >> .env # 다음 항목들을 추가:
echo "OPENAI_API_KEY=your-openai-api-key" >> .env # DEEPL_API_KEY=your-deepl-api-key
# OPENAI_API_KEY=your-openai-api-key
# CLAUDE_API_KEY=your-claude-api-key
# SERP_API_KEY=your-serp-api-key
``` ```
### 3. 전체 시스템 시작 ### 3. 전체 시스템 시작
@ -81,11 +93,17 @@ docker-compose logs -f
### 4. 서비스 확인 ### 4. 서비스 확인
```bash ```bash
# 헬스 체크 # Console API 헬스 체크
curl http://localhost:8000/health curl http://localhost:8011/health
# MongoDB 연결 확인 # MongoDB 연결 확인
docker exec -it site11_mongodb mongosh --eval "db.serverStatus()" docker exec -it site11_mongodb mongosh --eval "db.serverStatus()"
# Pipeline 모니터 확인
curl http://localhost:8100/health
# Console UI 접속
open http://localhost:3000
``` ```
## 상세 설치 가이드 (Detailed Installation) ## 상세 설치 가이드 (Detailed Installation)
@ -104,39 +122,47 @@ sleep 30
docker-compose ps mongodb redis kafka docker-compose ps mongodb redis kafka
``` ```
#### 2단계: Pipeline 서비스 #### 2단계: 핵심 백엔드 서비스
```bash
# 핵심 서비스 시작
docker-compose up -d console-backend users-backend \
oauth-backend images-backend files-backend \
statistics-backend search-backend
# 서비스 상태 확인
docker-compose ps | grep backend
```
#### 3단계: Pipeline 서비스
```bash ```bash
# Pipeline 서비스 시작 # Pipeline 서비스 시작
docker-compose up -d pipeline-scheduler pipeline-monitor \ docker-compose up -d pipeline-scheduler pipeline-monitor \
pipeline-rss-collector pipeline-google-search \ pipeline-rss-collector pipeline-google-search \
pipeline-ai-generator pipeline-translator \ pipeline-ai-article-generator pipeline-translator \
pipeline-image-generator pipeline-image-generator pipeline-language-sync
# Pipeline 모니터 확인 # Pipeline 모니터 확인
curl http://localhost:8100/status curl http://localhost:8100/health
``` ```
#### 3단계: 뉴스 서비스 #### 4단계: 뉴스 생성 서비스
```bash ```bash
# 국가별 뉴스 서비스 # 뉴스 관련 서비스
docker-compose up -d korea-backend korea-frontend \ docker-compose up -d news-aggregator-backend \
usa-backend usa-frontend \ ai-writer-backend ai-writer-worker \
japan-backend japan-frontend \ google-search-backend rss-feed-backend
china-backend china-frontend
# 기업 뉴스 서비스 # AI Writer 상태 확인
docker-compose up -d samsung-backend samsung-frontend \ curl http://localhost:8019/health
apple-backend apple-frontend \
google-backend google-frontend
``` ```
#### 4단계: 아티스트 서비스 #### 5단계: 프론트엔드 서비스
```bash ```bash
# K-POP 아티스트 서비스 # Console 프론트엔드
docker-compose up -d k-culture-backend \ docker-compose up -d console-frontend
blackpink-backend blackpink-frontend \
ive-backend ive-frontend \ # 웹 UI 접속
twice-backend twice-frontend # http://localhost:3000
``` ```
## 서비스 구조 (Service Architecture) ## 서비스 구조 (Service Architecture)
@ -161,10 +187,11 @@ pipeline-monitor (8100) # 실시간 모니터링
``` ```
### 콘텐츠 서비스 ### 콘텐츠 서비스
- **Media Empire** (8200/3200): 통합 다국어 뉴스 포털 - **Console** (8011/3000): 관리 콘솔
- **국가별 서비스**: Korea, USA, Japan, China - **AI Writer** (8019): AI 콘텐츠 생성
- **기업 서비스**: Samsung, Apple, Google, LG, Musk, WSJ - **News Aggregator** (8018): 뉴스 수집
- **아티스트 서비스**: K-Culture, Blackpink, IVE, Twice 등 - **Google Search** (8016): 검색 서비스
- **RSS Feed** (8017): RSS 피드 수집
## 서비스 관리 (Service Management) ## 서비스 관리 (Service Management)
@ -235,10 +262,16 @@ SERP_API_KEY=your-serp-api-key # Google 검색
### Pipeline 설정 ### Pipeline 설정
```bash ```bash
# services/pipeline/.env # services/pipeline/.env 파일 생성
WORKER_COUNT=3 # 워커 프로세스 수 cat > services/pipeline/.env << EOF
BATCH_SIZE=10 # 배치 처리 크기 DEEPL_API_KEY=your-deepl-api-key
TRANSLATION_DELAY=1.0 # 번역 지연 시간 OPENAI_API_KEY=your-openai-api-key
CLAUDE_API_KEY=your-claude-api-key
SERP_API_KEY=your-serp-api-key
WORKER_COUNT=3
BATCH_SIZE=10
TRANSLATION_DELAY=1.0
EOF
``` ```
## 개발 가이드 (Development Guide) ## 개발 가이드 (Development Guide)