commit ceee90447c34e5718375110f5d97fd9916290f2a parent e47d40ebfe29c81255caa5ca2d8626d239ff4e95 Author: Yongbin Kim <iam@yongbin.kim> Date: Tue, 31 Jan 2023 10:02:50 +0900 docs(README): 환경변수 관련 내용 추가 Signed-off-by: Yongbin Kim <iam@yongbin.kim> Diffstat:
| M | README.md | | | 38 | ++++++++++++++++++++++++++++++++++++++ |
1 file changed, 38 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -53,6 +53,44 @@ yarn start ``` +## 설정 + +설정은 환경 변수를 통해 이루어집니다. + +`.env` 파일을 작성하거나, 환경 변수를 직접 설정할 수 있습니다. + +- `WIKI_SITE_URL`: 사이트의 URL입니다. 이 값은 이메일 전송에 사용됩니다. +- `WIKI_DB_HOST`: 데이터베이스 호스트입니다. +- `WIKI_DB_NAME`: 데이터베이스 이름입니다. +- `WIKI_DB_USER`: 데이터베이스 사용자 이름입니다. +- `WIKI_DB_PASS`: 데이터베이스 사용자 비밀번호입니다. +- `WIKI_PAGE_CACHE_TTL`: 페이지 캐시 유효 시간입니다. 기본값은 3600초입니다. +- `WIKI_JWT_SECRET`: JWT 토큰의 시크릿입니다. +- `WIKI_JWT_COOKIE_PREFIX`: JWT 토큰을 저장할 쿠키의 접두사입니다. +- `WIKI_SMTP_HOST`: SMTP 호스트입니다. +- `WIKI_SMTP_PORT`: SMTP 포트입니다. +- `WIKI_SMTP_USER`: SMTP 사용자 이름입니다. +- `WIKI_SMTP_PASS`: SMTP 사용자 비밀번호입니다. +- `WIKI_SMTP_FORCE_TLS`: TLS를 강제로 사용할지 여부입니다. +- `WIKI_SMTP_FROM`: SMTP에서 사용할 이메일 주소입니다. +- `WIKI_HOME_WIKI`: 홈 위키 이름입니다. (사이트의 첫 페이지로 이동할 때 사용) +- `WIKI_PAGE_ENTRY`: 각 위키의 첫 페이지 이름입니다. +- `WIKI_SOCKET_URL`: 소켓 서버의 URL입니다. (이벤트 큐 서버에 접속하기 위해 사용) +- `WIKI_REDIS_URL`: Redis 서버의 URL입니다. +- `WIKI_REDIS_USERNAME`: Redis 서버의 사용자 이름입니다. +- `WIKI_REDIS_PASSWORD`: Redis 서버의 비밀번호입니다. +- `WIKI_REDIS_DB`: Redis 서버의 데이터베이스 번호입니다. + + +### 이벤트 큐 서버 설정 + +- `REDIS_URL`: Redis 서버의 URL입니다. +- `REDIS_USERNAME`: Redis 서버의 사용자 이름입니다. +- `REDIS_PASSWORD`: Redis 서버의 비밀번호입니다. +- `REDIS_DB`: Redis 서버의 데이터베이스 번호입니다. +- `WSS_PORT`: 이벤트 큐 소켓 서버의 포트입니다. + + ## 소스코드 개요 다음은 소스코드의 간략한 레이아웃 개요입니다.