docs: update documentation with recent improvements

## CLAUDE.md Updates
- Add comprehensive environment variable documentation
  * Basic settings vs External API endpoints separation
  * 7 new customizable API URLs with descriptions
  * Environment-specific configuration guidance
- Add new "Performance Optimizations" section
  * N+1 query elimination details (99% reduction)
  * API call optimization (80% improvement)
  * Caching strategy documentation
- Enhance External Integrations section
  * Add URL customization note
  * Explain self-hosting and environment-specific endpoints

## README.md Updates
- Add performance highlights section
  * N+1 query improvements
  * Parallel API calls
  * Circuit breaker and retry logic
- Restructure environment setup (steps 1-6)
  * Separate required vs optional secrets
  * Add KV namespace creation as separate step
  * Document all configurable environment variables
- Add comprehensive deployment section
  * Pre-deployment checklist
  * Post-deployment verification steps
  * Critical warnings (WEBHOOK_SECRET, KV namespace)
  * Health check and monitoring commands

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
kappa
2026-01-19 22:25:09 +09:00
parent 8d1f0f7fdc
commit 344332ed1e
2 changed files with 166 additions and 12 deletions

112
README.md
View File

@@ -23,6 +23,14 @@
* 🌐 **도메인 관리**: 도메인 검색, 추천(AI), 가격 조회, 등록, DNS 관리 통합
***서버리스**: Cloudflare Workers 위에서 동작하여 별도의 서버 관리 불필요
### 🚀 성능 최적화
* **N+1 쿼리 제거**: Cron 작업 99% 쿼리 감소 (100건: 101 → 1 쿼리)
* **병렬 API 호출**: 도메인 추천 80% 속도 향상
* **KV 캐싱**: TLD 가격 1시간 캐싱으로 중복 조회 방지
* **Circuit Breaker**: OpenAI API 장애 시 자동 차단 및 복구
* **Retry 로직**: 15개 외부 API에 지수 백오프 + 지터 적용
---
## 🚀 빠른 시작 (배포 가이드)
@@ -43,22 +51,110 @@ npx wrangler d1 execute telegram-conversations --file=schema.sql
```
*생성된 `database_id`를 `wrangler.toml`에 반영해야 합니다.*
### 3. 비밀키 설정 (Secrets)
### 3. KV Namespace 생성
```bash
npx wrangler secret put BOT_TOKEN # Telegram Bot Token
npx wrangler secret put OPENAI_API_KEY # OpenAI API Key
npx wrangler secret put WEBHOOK_SECRET # Webhook 검증용 Secret
# Rate Limiting용 KV Namespace 생성 (필수)
npx wrangler kv:namespace create RATE_LIMIT_KV
# 출력된 id를 wrangler.toml의 [[kv_namespaces]] 섹션에 입력
```
### 4. 배포 및 웹훅 연결
```bash
# 배포
npx wrangler deploy
### 4. 환경변수 설정
#### 필수 Secrets
```bash
# Telegram Bot 설정
npx wrangler secret put BOT_TOKEN # @BotFather에서 발급
npx wrangler secret put WEBHOOK_SECRET # 임의의 강력한 문자열 (필수!)
# OpenAI API
npx wrangler secret put OPENAI_API_KEY # OpenAI API 키
```
#### 선택적 Secrets (기능별)
```bash
# 도메인 관련 (도메인 기능 사용 시)
npx wrangler secret put NAMECHEAP_API_KEY # namecheap-api 래퍼 인증
npx wrangler secret put NAMECHEAP_API_KEY_INTERNAL # Namecheap 실제 API 키
# 검색 (웹 검색 기능 사용 시)
npx wrangler secret put BRAVE_API_KEY # Brave Search API 키
# 예치금 API (namecheap-api 연동 시)
npx wrangler secret put DEPOSIT_API_SECRET # 외부 서비스 연동용
```
#### 환경별 설정 (선택)
`wrangler.toml`의 환경변수는 기본값이 설정되어 있어 생략 가능합니다.
환경별로 다른 엔드포인트를 사용하려면 override하세요:
```toml
[vars]
OPENAI_API_BASE = "https://your-custom-gateway.com/openai"
NAMECHEAP_API_URL = "https://your-api.example.com"
```
**사용 가능한 환경변수:**
- `OPENAI_API_BASE` - OpenAI API Gateway
- `NAMECHEAP_API_URL` - Namecheap API 래퍼
- `WHOIS_API_URL` - WHOIS 조회 서비스
- `CONTEXT7_API_BASE` - 문서 조회 API
- `BRAVE_API_BASE` - 검색 API
- `WTTR_IN_URL` - 날씨 API
- `HOSTING_SITE_URL` - 공식 웹사이트
### 5. 배포
#### 배포 전 체크리스트
```bash
# 1. 로컬 테스트
npm run dev
# 2. TypeScript 컴파일 확인
npx tsc --noEmit
# 3. 환경변수 확인
npx wrangler secret list
# 4. KV Namespace 확인
npx wrangler kv:namespace list
```
#### 배포 실행
```bash
npm run deploy
```
#### 배포 후 확인
```bash
# Health check
curl https://telegram-summary-bot.kappa-d8e.workers.dev/health
# Webhook 상태
curl https://telegram-summary-bot.kappa-d8e.workers.dev/webhook-info
# 실시간 로그
npm run tail
```
### 6. Webhook 연결
```bash
# 웹훅 설정 (배포된 URL 사용)
curl https://<YOUR_WORKER_URL>/setup-webhook
```
#### ⚠️ 주의사항
- **WEBHOOK_SECRET 필수**: 미설정 시 모든 webhook 요청이 거부됩니다.
- **KV Namespace 필수**: 미생성 시 Rate Limiting이 비활성화되어 DoS 공격에 취약합니다.
- **환경변수 기본값**: 대부분의 외부 API URL은 기본값이 설정되어 있습니다. 프로덕션 환경에서는 기본값을 그대로 사용하거나, 필요시에만 override하세요.
---
## 🛠 기술 스택