본문으로 건너뛰기

환경 변수 구성

.env.example 파일을 복사하여 .env 파일을 생성한 후, 아래 가이드를 참고하여 환경 변수를 설정합니다.

cp .env.example .env

필수 환경 변수​

로컬 환경에서 서비스를 실행하기 위해 반드시 설정해야 하는 환경 변수들입니다.

CLOVA Studio​

API 키 발급 방법은 CLOVA Studio 공식 문서를 참고하세요.

변수명설명
HCX_API_KEYHyperCLOVA X API 키
CLOVA_STUDIO_URLCLOVA Studio API URL
CLOVA_STUDIO_HOSTCLOVA Studio 호스트
CLOVA_STUDIO_API_KEYCLOVA Studio API 키
CLOVA_STUDIO_GW_API_KEYCLOVA Studio Gateway API 키
CLOVA_STUDIO_REQUEST_IDCLOVA Studio 요청 ID
CLOVA_STUDIO_APP_IDCLOVA Studio 앱 ID

Swagger UI​

변수명설명
SWAGGER_USERNAMESwagger UI 사용자명
SWAGGER_PASSWORDSwagger UI 비밀번호

Internal API​

변수명설명예시
INTERNAL_API_KEY문제 등록 API 인증용 키. 임의의 문자열 사용 가능my-secret-api-key-1234

로컬 스토리지​

변수명설명예시
SECRET_KEYURL 서명에 사용되는 시크릿 키. 임의의 문자열 사용 가능my-secret-key-5678

선택 환경 변수​

기본값이 설정되어 있으나, 필요에 따라서 다른 값으로 변경하여 사용할 수 있습니다.

기본 설정​

변수명설명기본값
ENV실행 환경LOCAL
STORAGE스토리지 타입LOCAL
CORS_ORIGINSCORS 허용 도메인*

데이터베이스 (MySQL)​

변수명설명기본값
MYSQL_USERMySQL 사용자명local
MYSQL_PASSWORDMySQL 비밀번호local_password
MYSQL_HOSTMySQL 호스트0.0.0.0
MYSQL_PORTMySQL 포트3306
MYSQL_DB데이터베이스명local

Redis​

변수명설명기본값
RC_SEED_URLRedis 클러스터 URLredis:6379
RC_PASSWORDRedis 비밀번호local_password
RC_TTLRedis TTL (초)3600

Weaviate (벡터 DB)​

변수명설명기본값
WEAVIATE_HOSTWeaviate 호스트localhost
WEAVIATE_PORTWeaviate 포트8081
PROBLEM_INDEX문제 인덱스명Problem_opensource
CURRICULUM_INDEX커리큘럼 인덱스명Curriculum_opensource

모델 서버​

변수명설명기본값
MODEL_SERVER_GRPC_URL모델 서버 gRPC URLedu-model-server:8051
RESPONSE_MODEL응답 생성 모델hcx-005
GRPC_PORTgRPC 포트8051
EMBEDDING_TYPE임베딩 타입clovastudio

로컬 스토리지​

변수명설명기본값
UPLOAD_DIR파일 업로드 디렉토리static
URL_EXPIRY_SECONDSURL 만료 시간 (초)3600
BASE_URL베이스 URLhttp://localhost:8000/api/v1

서버 URL​

변수명설명기본값
DATA_SERVER_URL데이터 서버 URLhttp://localhost:8001/api/v1
BE_SERVER_URL백엔드 서버 URLhttp://localhost:8000/api/v1