fix: 포기

Author: seunnna7

.dockerignore

@@ -0,0 +1,23 @@
+.git
+.github
+.venv
+venv
+__pycache__
+*.py[cod]
+
+# 로컬 개발용 DB/미디어는 이미지에 넣지 않는다.
+# 서버에서는 named volume에 별도로 보관된다.
+db.sqlite3
+media/
+staticfiles/
+data/
+
+# 시크릿은 이미지에 절대 굽지 않는다. EC2의 .env를 런타임에 주입한다.
+.env
+*.env
+!.env.example
+
+.idea
+.vscode
+docs
+README.md

.env.example

@@ -1,3 +1,21 @@
+# 로컬 개발용 예시. 이 파일을 .env로 복사해서 값을 채운다.
+# 아래 DJANGO_* 값들은 로컬에서는 비워둬도 된다(기본값이 개발용으로 잡혀 있음).
+# EC2의 ~/heartmark/.env 에는 반드시 채워야 한다.
+
+# --- 배포 환경에서만 필요한 값 ---
+# 서버용 시크릿 키. 아래 명령으로 새로 만들어 쓸 것:
+#   python -c "import secrets; print(secrets.token_urlsafe(64))"
+# Django의 get_random_secret_key()를 써도 되지만 #, $, ' 같은 문자가 섞일 수 있다.
+# 이 .env는 docker compose가 변수 치환에도 사용하므로 그런 문자는 값이 깨질 수 있어
+# 영숫자와 -_ 만 나오는 token_urlsafe를 권장한다.
+DJANGO_SECRET_KEY=
+# EC2 퍼블릭 IP나 도메인. 콤마로 여러 개 지정 가능.
+DJANGO_ALLOWED_HOSTS=
+# 스킴을 포함해야 한다. 예: http://12.34.56.78
+DJANGO_CSRF_TRUSTED_ORIGINS=
+
+# --- 사이트/소셜 로그인 ---
+# 배포 시에는 EC2 주소로 바꿔야 소셜 로그인 redirect가 맞는다.
 SITE_DOMAIN=127.0.0.1:8000
 SITE_NAME=HeartMark Local
 GOOGLE_CLIENT_ID=
@@ -7,5 +25,6 @@ NAVER_CLIENT_SECRET=
 KAKAO_CLIENT_ID=
 KAKAO_CLIENT_SECRET=
 
+# --- 카카오맵 ---
 KAKAO_REST_KEY=
-KAKAO_JS_KEY=
+KAKAO_JS_KEY=

.gitattributes

@@ -0,0 +1,10 @@
+# Windows에서 작업해도 shell 스크립트는 항상 LF로 유지한다.
+# CRLF가 섞이면 리눅스 컨테이너에서 shebang이 깨져
+# "entrypoint.sh: no such file or directory" 같은 엉뚱한 에러가 난다.
+*.sh text eol=lf
+
+# 컨테이너 안에서 읽히는 설정 파일들도 마찬가지.
+Dockerfile text eol=lf
+*.conf text eol=lf
+*.yml text eol=lf
+*.yaml text eol=lf

.github/workflows/deploy.yml

@@ -4,33 +4,69 @@ on:
   push:
     branches:
       - staging      # staging 브랜치에 push할 때 실행
+  workflow_dispatch:  # Actions 탭에서 수동 실행도 가능하게 함
 
 jobs:
   deploy:
-    runs-on: ubuntu-latest    # GitHub Actions 실행 환경
+    runs-on: ubuntu-latest
 
     steps:
       - name: 코드 체크아웃
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Docker Hub 로그인
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
       - name: Docker 이미지 빌드 및 push
+        # docker-compose.yml의 ${DOCKER_USERNAME}는 runner의 환경변수를 읽는다.
+        # login-action은 로그인만 할 뿐 이 값을 심어주지 않으므로 직접 넣어야 한다.
+        env:
+          DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
         run: |
           docker compose build
           docker compose push
 
+      - name: 배포 파일 EC2로 전송
+        # EC2에는 소스가 없으므로 compose 파일과 nginx 설정을 매 배포마다 보내준다.
+        # .env는 서버에서 직접 관리하며 여기서 덮어쓰지 않는다.
+        uses: appleboy/scp-action@v0.1.7
+        with:
+          host: ${{ secrets.EC2_HOST }}
+          username: ubuntu
+          key: ${{ secrets.EC2_KEY }}
+          source: "docker-compose.prod.yml,docker/nginx/default.conf"
+          target: "~/heartmark"
+
       - name: EC2에 배포
-        uses: appleboy/ssh-action@v0.1.6
+        uses: appleboy/ssh-action@v1.2.0
         with:
           host: ${{ secrets.EC2_HOST }}
           username: ubuntu
           key: ${{ secrets.EC2_KEY }}
+          envs: DOCKER_USERNAME,DOCKER_PASSWORD
           script: |
-            cd ~
-            docker compose pull
-            docker compose up -d
+            set -e
+            cd ~/heartmark
+
+            # .env가 없으면 앱이 시크릿 없이 떠서 소셜 로그인 등이 조용히 깨진다.
+            # 배포를 진행하기 전에 확실히 실패시킨다.
+            if [ ! -f .env ]; then
+              echo ".env가 없습니다. ~/heartmark/.env를 먼저 만들어주세요."
+              exit 1
+            fi
+
+            # private 이미지를 pull하려면 EC2에서도 로그인이 필요하다.
+            echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
+
+            docker compose -f docker-compose.prod.yml pull
+            docker compose -f docker-compose.prod.yml up -d
+
+            # 이전 배포에서 남은 태그 없는 이미지를 정리한다.
+            # EC2 디스크가 작으면 금방 가득 차기 때문에 매 배포마다 돌린다.
+            docker image prune -f
+        env:
+          DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}

Dockerfile

@@ -0,0 +1,40 @@
+FROM python:3.11-slim
+
+# Python 로그가 버퍼링 없이 바로 docker logs에 찍히도록 함.
+ENV PYTHONUNBUFFERED=1 \
+    PYTHONDONTWRITEBYTECODE=1
+
+WORKDIR /app
+
+# Pillow(이미지 처리)와 cryptography 빌드에 필요한 시스템 패키지.
+# 설치 후 apt 캐시를 지워 이미지 용량을 줄인다.
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+        build-essential \
+        libjpeg-dev \
+        zlib1g-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+# requirements를 먼저 복사해서 의존성 레이어를 캐시한다.
+# 코드만 바뀐 경우 이 레이어는 재사용되어 빌드가 빨라진다.
+COPY requirements.txt .
+RUN pip install --no-cache-dir --upgrade pip \
+    && pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+# SQLite 파일과 업로드 미디어가 저장될 디렉토리.
+# compose에서 named volume을 여기에 마운트해 재배포 시에도 데이터가 유지된다.
+RUN mkdir -p /app/data /app/media /app/staticfiles
+
+RUN chmod +x /app/docker/entrypoint.sh
+
+EXPOSE 8000
+
+ENTRYPOINT ["/app/docker/entrypoint.sh"]
+CMD ["gunicorn", "config.wsgi:application", \
+     "--bind", "0.0.0.0:8000", \
+     "--workers", "3", \
+     "--timeout", "60", \
+     "--access-logfile", "-", \
+     "--error-logfile", "-"]

bgm/migrations/0003_seed_background_music.py

@@ -0,0 +1,78 @@
+from django.db import migrations
+
+# bgm/static/bgm/audio/ 에 들어 있는 음원 파일과 짝이 되는 DB 레코드.
+# 이 행이 없으면 파일이 있어도 BGM이 재생되지 않으므로(services.get_music_for_record가
+# mood_group으로 조회한다) 새 DB에 배포할 때마다 자동으로 생성되도록 마이그레이션으로 넣는다.
+#
+# 주의: mood_group 배정과 artist/라이선스 정보는 파일명에서 추정한 값이다.
+# 실제 출처(Pixabay 등)를 확인해서 source_url / license_name / license_url /
+# attribution_required 를 채워 넣을 것.
+SEED_MUSIC = [
+    {
+        "file_name": "alex-morgan-sad-piano-emotional-rain-story-575883.mp3",
+        "mood_group": "grief",
+        "title": "Sad Piano Emotional Rain Story",
+        "artist": "Alex Morgan",
+    },
+    {
+        "file_name": "nastelbom-love-466198.mp3",
+        "mood_group": "love",
+        "title": "Love",
+        "artist": "Nastelbom",
+    },
+    {
+        "file_name": "the_mountain-love-481753.mp3",
+        "mood_group": "love",
+        "title": "Love",
+        "artist": "The Mountain",
+    },
+    {
+        "file_name": "viacheslavstarostin-cute-pets-animals-music-382060.mp3",
+        "mood_group": "joy",
+        "title": "Cute Pets Animals Music",
+        "artist": "Viacheslav Starostin",
+    },
+    {
+        "file_name": "andriig-warm-warm-acoustic-music-573245.mp3",
+        "mood_group": "moody",
+        "title": "Warm Warm Acoustic Music",
+        "artist": "AndriiG",
+    },
+]
+
+
+def seed_background_music(apps, schema_editor):
+    BackgroundMusic = apps.get_model("bgm", "BackgroundMusic")
+
+    for entry in SEED_MUSIC:
+        # file_name을 기준으로 삼아 이미 넣어둔 음원은 건드리지 않는다.
+        BackgroundMusic.objects.update_or_create(
+            file_name=entry["file_name"],
+            defaults={
+                "mood_group": entry["mood_group"],
+                "title": entry["title"],
+                "artist": entry["artist"],
+                "is_active": True,
+            },
+        )
+
+
+def unseed_background_music(apps, schema_editor):
+    BackgroundMusic = apps.get_model("bgm", "BackgroundMusic")
+
+    # 기록에 연결된 음원은 RecordBackgroundMusic이 PROTECT로 잡고 있어 삭제되지 않는다.
+    # 되돌리기는 아직 아무 기록도 붙지 않은 경우에만 깔끔하게 동작한다.
+    BackgroundMusic.objects.filter(
+        file_name__in=[entry["file_name"] for entry in SEED_MUSIC]
+    ).delete()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bgm", "0002_recordbackgroundmusic"),
+    ]
+
+    operations = [
+        migrations.RunPython(seed_background_music, unseed_background_music),
+    ]

config/settings.py

@@ -25,9 +25,28 @@ def load_local_env():
 
 load_local_env()
 
-SECRET_KEY = "development-only"
-DEBUG = True
-ALLOWED_HOSTS = []
+# 배포 환경에서는 아래 값들을 모두 환경변수로 주입한다.
+# 기본값은 로컬 개발 기준이라, .env 없이도 로컬 실행은 그대로 동작한다.
+SECRET_KEY = os.environ.get("DJANGO_SECRET_KEY", "development-only")
+
+# 서버용 compose 파일에 DJANGO_DEBUG=False가 박혀 있으므로
+# 누가 .env를 빠뜨려도 프로덕션에서 DEBUG가 켜지지 않는다.
+DEBUG = os.environ.get("DJANGO_DEBUG", "True").lower() not in ("false", "0", "no")
+
+# "1.2.3.4,example.com" 형태의 콤마 구분 문자열을 받는다.
+ALLOWED_HOSTS = [
+    host.strip()
+    for host in os.environ.get("DJANGO_ALLOWED_HOSTS", "").split(",")
+    if host.strip()
+]
+
+# nginx 뒤에 있을 때 POST 요청의 CSRF origin 검사를 통과시키기 위한 값.
+# "http://1.2.3.4" 처럼 스킴을 반드시 포함해야 한다.
+CSRF_TRUSTED_ORIGINS = [
+    origin.strip()
+    for origin in os.environ.get("DJANGO_CSRF_TRUSTED_ORIGINS", "").split(",")
+    if origin.strip()
+]
 
 INSTALLED_APPS = [
     "django.contrib.admin",
@@ -84,10 +103,23 @@ def load_local_env():
 ]
 WSGI_APPLICATION = "config.wsgi.application"
 
+# 컨테이너에서는 DB 파일을 /app/data 아래에 둔다.
+# BASE_DIR(=/app)에 볼륨을 마운트하면 코드가 덮여버리므로 경로를 분리했다.
+DB_PATH = os.environ.get("DJANGO_DB_PATH") or (BASE_DIR / "db.sqlite3")
+
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",
-        "NAME": BASE_DIR / "db.sqlite3",
+        "NAME": DB_PATH,
+        "OPTIONS": {
+            # WAL 모드는 읽기와 쓰기가 서로를 막지 않게 해준다.
+            # gunicorn 워커가 여러 개인 환경에서 "database is locked"를 크게 줄여준다.
+            "init_command": "PRAGMA journal_mode=WAL; PRAGMA synchronous=NORMAL;",
+            # 잠금이 걸렸을 때 바로 실패하지 않고 최대 20초까지 기다린다.
+            "timeout": 20,
+            # 쓰기 트랜잭션의 잠금을 시작 시점에 잡아 갱신 충돌을 방지한다.
+            "transaction_mode": "IMMEDIATE",
+        },
     }
 }
 
@@ -96,9 +128,16 @@ def load_local_env():
 USE_I18N = True
 USE_TZ = True
 STATIC_URL = "static/"
-STATICFILES_DIRS = [BASE_DIR / "static"]
+
+# collectstatic이 각 앱의 static/을 모아두는 위치. nginx가 이 디렉토리를 서빙한다.
+STATIC_ROOT = os.environ.get("DJANGO_STATIC_ROOT") or (BASE_DIR / "staticfiles")
+
+# 프로젝트 루트의 static/은 현재 존재하지 않는다.
+# 없는 경로를 그대로 두면 collectstatic이 W004 경고를 내므로 있을 때만 넣는다.
+STATICFILES_DIRS = [BASE_DIR / "static"] if (BASE_DIR / "static").exists() else []
+
 MEDIA_URL = "media/"
-MEDIA_ROOT = BASE_DIR / "media"
+MEDIA_ROOT = os.environ.get("DJANGO_MEDIA_ROOT") or (BASE_DIR / "media")
 
 LOGIN_URL = "/accounts/login/"
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

docker-compose.prod.yml

@@ -0,0 +1,46 @@
+# EC2에서 실행되는 배포용 compose 파일.
+# build 섹션이 없다. 이미지는 CI가 Docker Hub에 올린 것을 pull해서 쓴다.
+#
+# EC2의 ~/heartmark/ 에 이 파일과 docker/nginx/default.conf, .env 가 있어야 한다.
+# .env는 CI가 건드리지 않으니 서버에서 한 번 만들어두고 계속 재사용한다.
+
+services:
+  web:
+    image: ${DOCKER_USERNAME}/heartmark:staging
+    env_file:
+      - .env
+    environment:
+      # 서버에서는 DEBUG를 코드로 못 켜게 여기에 못박는다.
+      # .env를 실수로 빠뜨려도 프로덕션에서 DEBUG가 켜지지 않는다.
+      DJANGO_DEBUG: "False"
+      DJANGO_DB_PATH: /app/data/db.sqlite3
+      DJANGO_MEDIA_ROOT: /app/media
+      DJANGO_STATIC_ROOT: /app/staticfiles
+    volumes:
+      # SQLite 파일, 업로드 미디어, 정적 파일을 볼륨에 둔다.
+      # 이미지가 새로 배포돼도 이 세 개는 그대로 남는다.
+      - db_data:/app/data
+      - media_data:/app/media
+      - static_data:/app/staticfiles
+    # 외부로 포트를 열지 않는다. nginx만 이 컨테이너에 접근한다.
+    expose:
+      - "8000"
+    restart: unless-stopped
+
+  nginx:
+    image: nginx:1.27-alpine
+    ports:
+      - "80:80"
+    volumes:
+      - ./docker/nginx/default.conf:/etc/nginx/conf.d/default.conf:ro
+      # web이 collectstatic으로 채운 정적 파일을 같은 볼륨으로 읽는다.
+      - static_data:/app/staticfiles:ro
+      - media_data:/app/media:ro
+    depends_on:
+      - web
+    restart: unless-stopped
+
+volumes:
+  db_data:
+  media_data:
+  static_data: