cozo-api

https://cozo.me 사이트의 API 백엔드를 담당하는 https://api.cozo.me 서버

로컬 개발

로컬 개발에 필요한 mysql, redis, elasticsearch를 docker 디렉토리 아래 준비된 Docker Compose 파일을 이용하여 실행한다.

$ cd docker
$ docker compose up -d

production에서 실행시 필요한 환경 변수

• SPRING_PROFILES_ACTIVE: production
• DB_USERNAME: MySQL user
• DB_PASSWORD: MySQL password
• SLACK_WEBHOOK_URL: Slack webhook URL
• TURNSTILE_SECRET: Cloudflare Turnstile secret
• YOUTUBE_API_KEY: YouTube API key
• OTLP_METRICS_ENABLED: OTLP metrics export 활성화 여부 (true / false)
• OTLP_METRICS_URL: Grafana Cloud OTLP metrics endpoint 전체 경로 (예: https://.../otlp/v1/metrics)
• OTLP_AUTH_HEADER: Grafana Cloud OTLP 인증 헤더 값 (예: Basic ...)
• OTLP_METRICS_STEP: 메트릭 export 주기 (기본값 1m)
• OTLP_SERVICE_NAME: OTLP service.name 리소스 속성 (기본값 cozo-api)
• OTLP_SERVICE_NAMESPACE: OTLP service.namespace 리소스 속성 (기본값 cozo)
• OTLP_DEPLOYMENT_ENVIRONMENT: OTLP deployment.environment 리소스 속성 (기본값 SPRING_PROFILES_ACTIVE 값)

GitHub Action

• .github/workflows/build.yml: 프로젝트 빌드 후 GitHub Container Registry에 Docker 이미지를 푸시
  • 필요한 Secrets
    • SLACK_WEBHOOK_URL: https://hooks.slack.com/services/ABCDEFGHI/JKLMNOPQRST/abcdefghijklmnOPQRSTU012

참고

• cozo-web / 웹 클라이언트