Repository navigation
Expand file tree
/
Copy pathdocker-compose.yml
More file actions
191 lines (185 loc) · 10.6 KB
/
Copy pathdocker-compose.yml
File metadata and controls
191 lines (185 loc) · 10.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
# StudyClub 로컬 개발 스택 — mysql + api + frontend(core 4700 / back-office 4701 / playground 4702) + discord
#
# cp .env.example .env # 처음 한 번. 구글 OAuth 값은 담당자(@titaniper)에게 DM 으로 받는다
# docker compose up -d --build # 전체 기동 → http://localhost:4700
# docker compose logs -f api # 로그
# docker compose down # 정지 (-v 붙이면 DB 볼륨까지 삭제)
#
# 기본값은 전부 **로컬끼리** 붙는다 — 서비스 간에는 내부 주소(api:8080, mysql:3306), 브라우저는 localhost.
# 처음부터 끝까지는 ONBOARDING.md.
#
# 시크릿/설정은 .env 로 주입 (PUBLIC 레포 — .env 는 gitignore, .env.example 참고).
#
# ⚠️ 프론트 포트 4700/4701 은 바꾸지 않는다 — GCP 에 등록된 구글 콜백(http://localhost:4700/api/auth/callback)과
# 백엔드 CORS 기본값이 이 번호에 묶여 있다. 로컬 pnpm run dev 와 동시에 띄우면 포트가 겹치니 한쪽만 쓴다.
#
# ⚠️ name 명시 필수 — 디렉토리 basename 이 'engineering' 이라 다른 서비스(place 등)와
# compose 프로젝트명이 충돌한다. 'studyclub' 로 고정해 격리.
name: studyclub
services:
mysql:
image: mysql:8.0
container_name: studyclub-mysql
restart: unless-stopped
environment:
MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
MYSQL_DATABASE: ${MYSQL_DATABASE}
MYSQL_USER: ${MYSQL_USER}
MYSQL_PASSWORD: ${MYSQL_PASSWORD}
command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
ports:
- "${MYSQL_PORT:-23310}:3306"
volumes:
- studyclub-mysql-data:/var/lib/mysql
healthcheck:
test: ["CMD", "mysqladmin", "ping", "-h", "127.0.0.1", "-uroot", "-p${MYSQL_ROOT_PASSWORD}"]
interval: 5s
timeout: 5s
retries: 30
api:
build:
context: ./backend
dockerfile: Dockerfile
container_name: studyclub-api
restart: unless-stopped
depends_on:
mysql:
condition: service_healthy
environment:
DB_URL: jdbc:mysql://mysql:3306/${MYSQL_DATABASE}?useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=UTC&characterEncoding=UTF-8
DB_USERNAME: ${MYSQL_USER}
DB_PASSWORD: ${MYSQL_PASSWORD}
GOOGLE_CLIENT_ID: ${GOOGLE_CLIENT_ID}
GOOGLE_CLIENT_SECRET: ${GOOGLE_CLIENT_SECRET}
NOTIFICATION_SITE_BASE_URL: ${NOTIFICATION_SITE_BASE_URL:-http://localhost:4700}
GOOGLE_REDIRECT_URI: ${GOOGLE_REDIRECT_URI:-http://localhost:4700/api/auth/callback}
JWT_SECRET: ${JWT_SECRET}
LOG_JSON_CONSOLE: ${LOG_JSON_CONSOLE:-}
MAIL_NOTIFY_CONFIGURATION_SET_NAME: ${MAIL_NOTIFY_CONFIGURATION_SET_NAME}
MAIL_NOTIFY_REGION: ${MAIL_NOTIFY_REGION}
MAIL_NOTIFY_SUB_DOMAIN: ${MAIL_NOTIFY_SUB_DOMAIN}
MAIL_NOTIFY_FROM_ADDRESS: ${MAIL_NOTIFY_FROM_ADDRESS}
MAIL_NOTIFY_ACCESS_KEY_ID: ${MAIL_NOTIFY_ACCESS_KEY_ID}
MAIL_NOTIFY_SECRET_ACCESS_KEY: ${MAIL_NOTIFY_SECRET_ACCESS_KEY}
# 파일 저장소 (specs/profile-image/spec.md). 비어 있으면 올리기만 503, 나머지는 정상
AWS_REGION: ${AWS_REGION:-}
S3_BUCKET: ${S3_BUCKET:-}
AWS_ACCESS_KEY_ID: ${AWS_ACCESS_KEY_ID:-}
AWS_SECRET_ACCESS_KEY: ${AWS_SECRET_ACCESS_KEY:-}
S3_PUBLIC_BASE_URL: ${S3_PUBLIC_BASE_URL:-}
# 로컬 기본은 키 없이 로컬 저장소 — 사진은 컨테이너 안 폴더에 쓰고 브라우저는 호스트 포트로 받는다. stage S3 로 확인할 땐 .env 에 false
STORAGE_LOCAL_ENABLED: ${STORAGE_LOCAL_ENABLED:-true}
STORAGE_LOCAL_PUBLIC_BASE_URL: http://localhost:${API_PORT:-28080}/local-storage
# 봇 ↔ 백엔드 양방향 서비스 키 (같은 값). 비어 있으면 백엔드는 봇을 부르지 않는다 (specs/discord-study-link)
DISCORD_API_KEY: ${DISCORD_API_KEY:-}
# 서버 분석 이벤트 (specs/analytics). 비어 있으면 보내지 않는다
AMPLITUDE_API_KEY: ${AMPLITUDE_API_KEY:-}
GA4_MEASUREMENT_ID: ${GA4_MEASUREMENT_ID:-}
GA4_API_SECRET: ${GA4_API_SECRET:-}
DISCORD_BOT_URL: ${DISCORD_BOT_URL:-http://discord:4800}
# 시스템 호출의 X-Discord-User-ID (봇 자신의 유저 ID). 비어 있으면 스터디 role 동기화가 실패한다 (DiscordBotClient.systemUserId)
DISCORD_CONFIG_BOT_ID: ${DISCORD_CONFIG_BOT_ID:-}
# 디스코드 role 어긋남을 되돌릴지. 기본은 로그만 (specs/discord-role-sync)
DISCORD_ROLE_SYNC_ENFORCE: ${DISCORD_ROLE_SYNC_ENFORCE:-false}
# 디스코드 계정 연동 OAuth. 비어 있으면 연동만 503 (specs/study-application 「디스코드 계정 연동」)
DISCORD_CONFIG_GUILD_ID: ${DISCORD_CONFIG_GUILD_ID:-}
DISCORD_OAUTH_CLIENT_ID: ${DISCORD_OAUTH_CLIENT_ID:-}
DISCORD_OAUTH_CLIENT_SECRET: ${DISCORD_OAUTH_CLIENT_SECRET:-}
DISCORD_OAUTH_REDIRECT_URI: ${DISCORD_OAUTH_REDIRECT_URI:-}
ports:
- "${API_PORT:-28080}:8080"
healthcheck:
test: ["CMD-SHELL", "bash -c '</dev/tcp/127.0.0.1/8080'"]
interval: 5s
timeout: 3s
retries: 30
start_period: 10s
# 단일 컨테이너에서 turbo 로 두 앱 동시 dev (install race 회피). per-app 스토리지
# prefix(sc_/bo_)는 코드 상수라 공유 env 여도 무방.
frontend:
image: node:20-alpine
container_name: studyclub-frontend
restart: unless-stopped
working_dir: /app
# node 이미지엔 pnpm 이 없다 → corepack 으로 켠다. 볼륨에 npm 시절 node_modules 가 남아 있으면
# pnpm 이 재설치 확인을 묻는데(TTY 없음 → 실패) confirmModulesPurge=false 로 묻지 않고 진행.
command: sh -c "corepack enable && pnpm install --config.confirmModulesPurge=false && pnpm run dev"
depends_on:
api:
condition: service_healthy
environment:
# macOS 도커 bind-mount 는 inotify 이벤트가 컨테이너로 전파 안 됨 → 폴링으로 HMR 활성화
WATCHPACK_POLLING: "true"
CHOKIDAR_USEPOLLING: "true"
# 서버측(Next route handler)이 컨테이너 내부에서 백엔드에 닿는 URL.
# .env 의 API_BASE_URL(로컬 pnpm 용 localhost:28080)은 컨테이너 안에선 안 닿아서 여기서 고정한다.
API_BASE_URL: http://api:8080
# 브라우저용 (호스트에서 접근)
NEXT_PUBLIC_API_BASE_URL: http://localhost:${API_PORT:-28080}
NEXT_PUBLIC_GOOGLE_CLIENT_ID: ${GOOGLE_CLIENT_ID}
NEXT_PUBLIC_OAUTH_REDIRECT_URI: ${GOOGLE_REDIRECT_URI:-http://localhost:4700/api/auth/callback}
# 디스코드 연동 팝업 client id. 비면 개발 서버는 팝업 없이 목 코드를 보낸다 (백엔드에 OAuth 설정이 없으면 503)
NEXT_PUBLIC_DISCORD_CLIENT_ID: ${DISCORD_OAUTH_CLIENT_ID:-}
# ── 운영 API 에 붙이기 (화면만 볼 때) ──────────────────────────────────────────
# 위 세 줄 대신 아래를 쓰고 `docker compose up -d --no-deps frontend` 로 frontend 만 띄운다.
# 콜백은 운영 페이지가 받아 localhost 로그인 창으로 code 를 넘긴다. ⚠️ 운영 데이터 — 쓰기는 실제로 반영된다.
# API_BASE_URL: https://api.studyclub.life
# NEXT_PUBLIC_API_BASE_URL: https://api.studyclub.life
# NEXT_PUBLIC_OAUTH_REDIRECT_URI: https://studyclub.life/api/auth/callback
# ── stage ──────────────────────────────────────────────────────────────────
# stage API 는 외부 주소가 없다 (클러스터 내부 전용). stage 로 확인할 일은 담당자(@titaniper)에게 문의.
ports:
- "${CORE_FRONT_PORT:-4700}:4700" # core-front
- "${BO_FRONT_PORT:-4701}:4701" # back-office-front
- "${PLAYGROUND_PORT:-4702}:4702" # playground (프로토타입)
volumes:
- ./frontend:/app
- studyclub-frontend-node-modules:/app/node_modules
# .next 는 컨테이너 전용 볼륨으로 뺀다 — 호스트와 공유하면 컨테이너 경로(/app/...)가 박힌 캐시가 남아
# 로컬 npm run dev 가 Turbopack panic(Read-only file system)으로 죽는다.
- studyclub-frontend-next-core:/app/apps/core-front/.next
- studyclub-frontend-next-bo:/app/apps/back-office-front/.next
- studyclub-frontend-next-playground:/app/apps/playground/.next
# .next 는 컨테이너 전용 볼륨으로 뺀다 — 호스트와 공유하면 컨테이너 경로(/app/...)가 박힌 캐시가 남아
# 로컬 pnpm run dev 가 Turbopack panic(Read-only file system)으로 죽는다.
discord:
image: studyclub-discord
container_name: studyclub-discord
build: ./discord
env_file: ./.env
environment:
# 컨테이너 안에서는 호스트 포트가 아니라 내부 주소다 (frontend 와 같은 이유).
API_BASE_URL: http://api:8080
ports:
- "${DISCORD_PORT:-24800}:4800"
# create-study 의 스터디 이름 예약(SQLite, /app/data/discord.sqlite3)이 컨테이너 재생성 후에도 남도록.
volumes:
- studyclub-discord-data:/app/data
restart: unless-stopped
healthcheck:
test: ["CMD", "python", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:4800/api/v1/health')"]
interval: 30s
timeout: 5s
retries: 3
volumes:
studyclub-mysql-data:
studyclub-frontend-node-modules:
studyclub-frontend-next-core:
studyclub-frontend-next-bo:
studyclub-frontend-next-playground:
studyclub-discord-data:
# ─── stage / prod 는 compose 로 띄우지 않는다 ─────────────────────────────────────
# 운영·stage 는 k8s 에 배포된다 (이미지 빌드·배포는 .github/workflows, 클러스터 설정은 인프라 레포).
# 거기서 쓰는 값(DB·JWT·OAuth·SES)은 내부 시크릿 저장소에서 주입되며 이 레포에는 없다.
#
# 운영 DB 를 로컬 api 에 붙이는 것은 금지 — 로컬 코드의 마이그레이션(V{n})이 운영 스키마에 적용된다.
# 필요한 확인은 위 frontend 의 「운영 API 에 붙이기」로 하고, 그 이상은 담당자(@titaniper)에게 문의.
#
# 참고용 — 운영과 같은 설정으로 로컬 api 를 띄워 볼 때 달라지는 env (값은 담당자에게):
# api:
# environment:
# DB_URL: jdbc:mysql://<운영 DB 호스트>/studyclub # ⚠️ 위 금지 사항 참고
# JWT_SECRET: <운영 서명키>
# LOG_JSON_CONSOLE: ecs
# API_DOCS_ENABLED: "false"
# stage 만: DDL_AUTO=update, FLYWAY_ENABLED=false (docs/backend-development-guide/database-guide.md)