Files
TK-FB-Project/README.md
Hyungi Ahn 1e7155b864 refactor: Phase 1 - 긴급 보안 및 중복 제거
## 🚨 보안 강화
- 하드코딩된 비밀번호를 환경변수로 전환
- .env.example 생성 및 보안 가이드 추가
- docker-compose.yml 환경변수 적용
- README.md에서 실제 비밀번호 제거

## 🗑️ 중복 제거
- synology_deployment/ 디렉토리 제거 (268MB)
- synology_deployment*.tar.gz 아카이브 제거 (234MB)
- 총 502MB의 중복 파일 삭제

## 🧹 백업 파일 정리
- *.backup 파일 제거 (10개)
- *복사본* 파일 제거
- *이전* 파일 제거
- json(백업)/ 디렉토리 제거

## 📋 .gitignore 업데이트
- 백업 파일 패턴 추가
- 보안 파일 제외 (.env, *.pem, *.key)
- 임시 파일 제외 (*.tmp, *.new)
- 빌드 아티팩트 제외 (*.tar.gz)

## 📚 문서화
- docs/ 디렉토리 구조 생성
- 리팩토링 분석 및 계획 문서 작성
- 코딩 스타일 가이드 작성
- 개발 환경 설정 가이드 작성
- 시스템 아키텍처 문서 작성

## 변경된 파일
- .env.example (신규)
- .gitignore (업데이트)
- docker-compose.yml (환경변수 적용)
- README.md (보안 정보 제거)
- docs/* (신규 문서 7개)

## 보안 개선 효과
 비밀번호 노출 위험 제거
 Git 히스토리에서 민감 정보 분리
 환경별 설정 분리 가능
 배포 보안 강화

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-11 10:16:57 +09:00

86 lines
2.2 KiB
Markdown

# TK-FB-Project - 통합 실행 가이드
## ⚙️ 사전 준비
### 환경 변수 설정 (필수)
처음 실행하기 전에 환경 변수 파일을 생성해야 합니다:
```bash
# 1. .env.example을 복사하여 .env 파일 생성
cp .env.example .env
# 2. .env 파일을 편집하여 실제 비밀번호로 변경
nano .env # 또는 vi, code 등 사용
# 3. 강력한 비밀번호로 변경 (예시)
# MYSQL_ROOT_PASSWORD=your_secure_password_here
# MYSQL_PASSWORD=your_secure_password_here
# JWT_SECRET=your_random_jwt_secret_min_32_chars
```
**중요**: `.env` 파일은 절대 Git에 커밋하지 마세요!
## 🚀 한 번에 모든 서비스 실행
### 🎯 간편 실행 (권장)
```bash
cd /Users/hyungi/docker/TK-FB-Project
./start.sh
```
### 🛑 간편 중지
```bash
./stop.sh
```
### 📋 직접 실행
```bash
docker-compose up -d
docker-compose down
```
## 📊 서비스 목록
| 서비스 | 포트 | 접속 URL | 설명 |
|--------|------|----------|------|
| **웹 UI** | 20000 | http://localhost:20000 | 메인 웹 인터페이스 |
| **API 서버** | 20005 | http://localhost:20005 | Node.js API 서버 ✅ |
| **FastAPI 브릿지** | 20010 | http://localhost:20010 | Python FastAPI 서비스 |
| **phpMyAdmin** | 20080 | http://localhost:20080 | DB 관리도구 |
| **MariaDB** | 20306 | - | 데이터베이스 서버 |
## 🛠️ 관리 명령어
### 모든 서비스 중지
```bash
cd /Users/hyungi/docker/TK-FB-Project
docker-compose down
```
### 서비스 상태 확인
```bash
docker ps | grep fb_
```
### 로그 확인
```bash
docker-compose logs -f
```
## 💾 데이터베이스 정보
- **호스트**: localhost:20306
- **데이터베이스**: hyungi (`.env` 파일의 `MYSQL_DATABASE`)
- **사용자**: hyungi_user (`.env` 파일의 `MYSQL_USER`)
- **비밀번호**: `.env` 파일에서 설정한 `MYSQL_PASSWORD`
- **Root 비밀번호**: `.env` 파일에서 설정한 `MYSQL_ROOT_PASSWORD`
**참고**: 실제 비밀번호는 `.env` 파일을 확인하세요.
## ✨ 주요 개선사항
1. **통합 실행**: 한 번의 명령으로 모든 서비스 실행
2. **깔끔한 DB 초기화**: 마이그레이션 오류 해결
3. **일관된 네이밍**: fb_ 접두사로 컨테이너 구분
4. **안정적인 포트**: 20000번대 포트 사용