THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

Browse Source

docs: Add more detailed upgrade guide

tags/v1.3.0
Suwon Chae 3 years ago
parent
commit
0933b6fc39
2 changed files with 45 additions and 9 deletions
  1. +12
    -1
      docs/ko/yona-social-login-settings.md
  2. +33
    -8
      docs/ko/yona-upgrade.md

+ 12
- 1
docs/ko/yona-social-login-settings.md View File

@@ -2,9 +2,20 @@
----
- Yona는 v1.3 기준으로 Github과 Gmail OAuth 로그인을 지원합니다.
- 해당 설정은 conf 디렉터리의 social-login.conf 파일에서 설정합니다.
- application.conf 파일 맨 아래에 `include "social-login.conf"` 부분이 추가되어 있는지 확인 해 주세요
- 만약 소셜로그인 설정을 제거하거나 제한하고 싶다면 conf 폴더의 application.social.login.support 항목을 수정하세요
- 상세 설정들은 [application.conf 설명](application-conf-desc.md) 파일을 참고해주세요.
- 공개망(Public IP Network)에서 Yona 서버를 운영한다면 자체 가입 및 로그인은 제한하는 것을 권장합니다.
- 소셜 로그인용 최초 로그인시에 만약 기존 가입된 계정의 이메일 유저가 아니라면 자동가입이 일어난다면 메일을 발송합니다.
- 소셜 로그인용 최초 로그인시에 만약 기존 가입된 계정의 이메일 유저가 아니라면 자동가입이 일어난다면 자동 생성된 암호등의 정보가 포함된 메일을 발송합니다.

관련 설정
---
conf 폴더의 application.conf 파일 및 social-login.conf 파일을 통해 설정이 가능합니다.

- 오직 소셜로그인(Github/Gmail)을 통한 가입/로그인만으로 제한 (자체 계정 생성 및 로그인 금지)
- application.use.social.login.only = true
- 지원 소셜로그인 제공자 설정 가능
- application.social.login.support = "github, google"
- application.conf 끝 부분의 메일 play-easymail 설정을 해 놓으면 이때 새로 가입/로그인된 유저에게 안내 메일이 발송됩니다.

```


+ 33
- 8
docs/ko/yona-upgrade.md View File

@@ -1,7 +1,7 @@
#### 업그레이드

v1.3 이상
----
- 기존 운영중인 Yona를 중단합니다.
- 새로 내려받은 Yona 파일의 압축을 해제합니다.
- 실행시 사용했던 YONA_DATA 환경변수를 지정합니다.
@@ -10,13 +10,38 @@ v1.3 이상
참고: [Yona 실행 및 재시작 방법](yona-run-and-restart)


v1.3 이전 버전
----
설치할 때와 똑같이, 최신 버전을 내려받아 Yona가 설치된 디렉터리에 압축파일을
풉니다.

**주의사항! `repo`와 `uploads` 디렉터리를 삭제하거나
덮어쓰지 않도록 주의하세요!**
v1.3 이전 버전에서 v1.3 이상으로 업그레이드를 할 경우
---
이번에는 조금 손이 갑니다만 이후 업그레이드를 더 편하게 만들었습니다. 번거로우시겠지만 차분히 읽고 설정부탁드려요.

- 다음 3가지를 수정해 주셔야 합니다.
- logger 설정파일내의 변수 설정
- social login 설정을 위해 application.conf 파일 맨 아래에 include "social-login.conf" 추가
- [소셜로그인 설정](yona-social-login-settings.md) 참고
- 보관이 필요한 파일들을 특정 폴더로 옮겨 놓은 다음 YONA_HOME대신 YONA_DATA로 지정해서 실행

### 상세설명

- 1.3부터 업그레이드가 더 편해지도록 DATA와 실행파일 부분이 분리되었습니다.
- 더 이상 YONA_HOME 변수를 사용하지 않습니다.
- conf, logs, uploads, repo를 원하는 폴더로 이동한 다음 해당 폴더를 YONA_DATA 환경 변수로 지정합니다.

예를 들어
```
/yona-data
/conf
/logs
/uploads
/repo
```
로 만들었다면
```
YONA_DATA=/yona-data;export YONA_DATA
bin/yona
```
와 같은 식으로 실행합니다. 알아서 conf 폴더의 설정파일들을 참고하게 되어 있습니다.

좀더 자세한 실행 옵션들은 [Yona 실행시 추가 가능한 옵션](yona-run-options.md) 파일을 참고해서 설정해주세요.


Yobi에서 Yona로 업그레이드 하려는 경우


Loading…
Cancel
Save