Setup Guide

Setup Guide

로컬 실행

사전 요구사항

• Python 3.11+
• Gmail 계정 (앱 비밀번호 필요)
• Groq API 키

1. 저장소 클론

git clone https://github.com/minjungsung/hackdigest.git
cd hackdigest

2. 의존성 설치

pip install -r requirements.txt

주요 의존성:

패키지	버전	용도
feedparser	6.0.14	RSS 피드 파싱
requests	2.33.0	HTTP 요청
trafilatura	1.12.2	기사 본문 추출

3. 환경변수 설정

export GROQ_API_KEY="gsk_..."
export EMAIL_FROM="your-email@gmail.com"
export EMAIL_APP_PASSWORD="xxxx xxxx xxxx xxxx"
export EMAIL_TEST_TO="test@example.com"  # 테스트 모드

환경변수 상세

변수	필수	설명
GROQ_API_KEY	✅	Groq Console에서 발급
EMAIL_FROM	✅	Gmail 발신 주소
EMAIL_APP_PASSWORD	✅	Gmail 앱 비밀번호 (생성 방법)
EMAIL_TEST_TO	❌	설정 시 테스트 모드: 이 주소로만 발송

4. 실행

# 테스트 모드 (EMAIL_TEST_TO로만 발송)
EMAIL_TEST_TO="you@example.com" python -m src.main

# 전체 구독자에게 발송 (주의!)
python -m src.main

GitHub Actions 설정

Repository Secrets

GitHub 리포 → Settings → Secrets and variables → Actions:

Secret	설명
GROQ_API_KEY	Groq API 키
EMAIL_FROM	Gmail 발신 주소
EMAIL_APP_PASSWORD	Gmail 앱 비밀번호
EMAIL_TEST_TO	테스트 수신 주소

Workflows

daily-digest.yml — 매일 다이제스트 발송

• 트리거: workflow_dispatch (수동 또는 cronjob.io)
• 입력: test_mode (boolean) — 테스트 수신자에게만 발송
• 단계:
  1. 보안 스캔 (하드코딩 시크릿 검사)
  2. 캐시 복원
  3. 파이프라인 실행
  4. 캐시 저장

subscribers.yml — 구독자 관리

• 트리거: repository_dispatch (Cloudflare Worker에서) 또는 workflow_dispatch (수동)
• 입력: action (add/remove/update), email, language, topics
• 동작: subscribers.json 수정 → 환영 이메일 발송 → 커밋+푸시

스케줄링 (cronjob.io)

매일 KST 10:15에 자동 실행하려면:

1. cronjob.io 가입
2. 새 cronjob 생성
3. URL: https://api.github.com/repos/minjungsung/hackdigest/actions/workflows/daily-digest.yml/dispatches
4. Method: POST
5. Headers: Authorization: Bearer {GITHUB_PAT}, Accept: application/vnd.github+json
6. Body: {"ref":"main","inputs":{"test_mode":"false"}}
7. Schedule: 15 1 * * * (UTC 01:15 = KST 10:15)

Cloudflare Worker 배포

1. 설치

cd worker
npm install

2. Wrangler 로그인

npx wrangler login

3. 배포

npx wrangler deploy

4. 시크릿 설정

npx wrangler secret put GITHUB_TOKEN
# Fine-grained PAT with Contents:write for hackdigest repo

wrangler.toml 설정

name = "hackdigest-subscribe"
main = "src/index.js"
compatibility_date = "2024-01-01"

구독 페이지 (GitHub Pages)

docs/index.html은 GitHub Pages로 자동 배포됩니다.

설정: Repository → Settings → Pages → Source: Deploy from a branch → Branch: main / /docs