.env 설정

Sonamu는 sonamu.config.ts를 import하기 전에 API 패키지 루트의 dotenv 파일을 읽습니다. 공통 기본값은 .env, 환경별 값은 .env.<environment>, 머신별 로컬 override는 .env.local에 둡니다.

실제 비밀값이 들어 있는 .env 파일은 커밋하지 마세요. 예시나 템플릿 파일만 커밋하세요.

로딩 순서

현재 NODE_ENV에 대해 Sonamu는 다음 순서로 값을 적용합니다.

.env
.env.${NODE_ENV}
.env.local
export된 process 환경변수

뒤에 오는 값이 앞의 값을 덮습니다. NODE_ENV가 없으면 development를 사용합니다. 허용 값은 test, development, staging, production입니다.

파일 구조

packages/api/.env
packages/api/.env.development
packages/api/.env.staging
packages/api/.env.production
packages/api/.env.test
packages/api/.env.local

현재 환경의 파일이 있다면 공통 .env는 없어도 됩니다. 단, .env 또는 .env.${NODE_ENV} 중 하나는 있어야 합니다.

공통 값

.env

# 공통 기본값
PROJECT_NAME=MyProject
CONTAINER_NAME=myproject-postgres

# DB 기본값. 환경별 파일에서 필요한 값을 덮어쓸 수 있습니다.
SONAMU_DB_HOST=127.0.0.1
SONAMU_DB_PORT=5432
SONAMU_DB_USER=postgres
SONAMU_DB_PASSWORD=your-db-password

# 비밀값과 외부 서비스
SESSION_SECRET=your-session-secret
SESSION_SALT=your-session-salt
OPENAI_API_KEY=your-openai-api-key

환경별 값

개발
스테이징
프로덕션
테스트

.env.development

SONAMU_DB_HOST=127.0.0.1
SONAMU_DB_PORT=5432
SONAMU_DB_USER=postgres
SONAMU_DB_PASSWORD=your-dev-password
SONAMU_DB_NAME=myproject_development

.env.staging

SONAMU_DB_HOST=staging-db.example.com
SONAMU_DB_PORT=5432
SONAMU_DB_USER=myproject_staging
SONAMU_DB_PASSWORD=your-staging-password
SONAMU_DB_NAME=myproject_staging

.env.production

SONAMU_DB_HOST=prod-db.example.com
SONAMU_DB_PORT=5432
SONAMU_DB_USER=myproject_prod
SONAMU_DB_PASSWORD=your-production-password
SONAMU_DB_NAME=myproject_production

.env.test

SONAMU_DB_HOST=127.0.0.1
SONAMU_DB_PORT=5432
SONAMU_DB_USER=postgres
SONAMU_DB_PASSWORD=your-test-password
SONAMU_DB_NAME=myproject_test
SONAMU_DB_FIXTURE_NAME=myproject_fixture

sonamu.config.ts

sonamu.config.ts에서는 process.env를 그대로 읽을 수 있습니다. Sonamu는 config 파일을 import하기 전에 현재 환경 값을 먼저 로드합니다.

sonamu.config.ts

import { defineConfig } from "sonamu";

export default defineConfig({
  projectName: process.env.PROJECT_NAME ?? "MyProject",
  database: {
    database: "pg",
    defaultOptions: {
      pool: {
        min: 1,
        max: 10,
      },
    },
  },
});

제거된 database.name 또는 database.environments 필드는 사용하지 마세요. 데이터베이스 이름과 환경별 연결값은 이제 SONAMU_DB_* 변수와 projectName에서 결정됩니다.

전환 팁

DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DATABASE_NAME은 각각 SONAMU_DB_HOST, SONAMU_DB_PORT, SONAMU_DB_USER, SONAMU_DB_PASSWORD, SONAMU_DB_NAME으로 바꾸세요.
읽기 전용 replica는 SONAMU_DB_READONLY_*를 사용합니다. 없는 read-only 필드는 현재 환경의 main DB 값을 사용합니다.
fixture DB에는 SONAMU_DB_FIXTURE_*를 사용합니다.
공통 파일과 환경별 파일 다음에 적용할 로컬 override는 .env.local에 둡니다.

시작하기

핵심 개념

데이터베이스

API 개발

프론트엔드 통합

테스팅

고급 기능

도구 & CLI

설정

API 레퍼런스

문제 해결

자주 묻는 질문

로딩 순서

파일 구조

공통 값

환경별 값

sonamu.config.ts

전환 팁

​로딩 순서

​파일 구조

​공통 값

​환경별 값

​sonamu.config.ts

​전환 팁

로딩 순서

파일 구조

공통 값

환경별 값

sonamu.config.ts

전환 팁