[Notice] Announcing the End of Demo Server [Read me]
docs: Update docs and support english docs
@fd582b8e2edf618b31004cc0812faf1c1b090252
--- README.md
+++ README.md
... | ... | @@ -107,15 +107,16 @@ |
107 | 107 |
--- |
108 | 108 |
Currently, Yona offers two distributions per version. |
109 | 109 |
|
110 |
-- MariaDB Version |
|
111 |
- - Recommended version. |
|
112 |
- - Distributed as a file in the similar format as yona-v1.3.0-bin.zip |
|
113 |
- - It takes a little effort to install DB, but it can be operated stably. |
|
114 |
-- Embedded H2 DB Version |
|
115 |
- - Portable version that can be downloaded and run immediately. No need to setting a DB. |
|
116 |
- - Distributed as a file in the similar format as yona-h2-v1.3.0-bin.zip |
|
117 |
- - It can be used portable. For example, along with USB etc. And it can be carried around with zip as a whole of work. |
|
118 |
- - Not suitable for large-scale team. (over 500 people) |
|
110 |
+#### MariaDB Version |
|
111 |
+- Recommended version. |
|
112 |
+- Distributed as a file in the similar format as yona-v1.3.0-bin.zip |
|
113 |
+- It takes a little effort to install DB, but it can be operated stably. |
|
114 |
+ |
|
115 |
+#### Embedded H2 DB Version |
|
116 |
+- Portable version that can be downloaded and run immediately. No need to setting a DB. |
|
117 |
+- Distributed as a file in the similar format as yona-h2-v1.3.0-bin.zip |
|
118 |
+- It can be used portable. For example, along with USB etc. And it can be carried around with zip as a whole of work. |
|
119 |
+ - Not suitable for large-scale team. (over 500 people) |
|
119 | 120 |
|
120 | 121 |
|
121 | 122 |
How to install |
--- docs/db-error-767.md
+++ docs/db-error-767.md
... | ... | @@ -1,4 +1,4 @@ |
1 |
-### MariaDB 767 byte 에러 |
|
1 |
+### MariaDB 767 byte Error |
|
2 | 2 |
|
3 | 3 |
``` |
4 | 4 |
[info] play - database [default] connected at jdbc:mysql://127.0.0.1:3306/yona |
... | ... | @@ -7,14 +7,15 @@ |
7 | 7 |
@6p6j2gap7: Database 'default' is in an inconsistent state! |
8 | 8 |
``` |
9 | 9 |
|
10 |
-이런 에러가 나오는 경우는 아래 두 가지 옵션이 정상적으로 반영되지 않아서 입니다. |
|
10 |
+If you see this error, check following two options are properly apllied. |
|
11 | 11 |
``` |
12 | 12 |
innodb_file_format=barracuda |
13 | 13 |
innodb_large_prefix=on |
14 | 14 |
``` |
15 | 15 |
|
16 |
-위 내용은 my.cnf 에 추가한다음 DB를 시작해 주세요. |
|
17 |
-재시작후 root 유저로 접속해서 |
|
16 |
+Add the above to my.cnf and start the DB. |
|
17 |
+ |
|
18 |
+After restarting, connect as root user |
|
18 | 19 |
``` |
19 | 20 |
|
20 | 21 |
MariaDB [(none)]> SHOW VARIABLES LIKE 'innodb_lar%'; |
... | ... | @@ -34,6 +35,4 @@ |
34 | 35 |
| innodb_file_per_table | ON | |
35 | 36 |
+--------------------------+-----------+ |
36 | 37 |
``` |
37 |
-처럼 on 되어 있고 file format도 barracuda로 되어 있는지 확인해 보세요. |
|
38 |
- |
|
39 |
-기타 관련해서는 [이슈 #924](https://github.com/naver/yobi/issues/924)을 참고해 주세요(No newline at end of file) |
|
38 |
+Make sure that the items above are on and that the file format is also barracuda. |
--- docs/install-mariadb.md
+++ docs/install-mariadb.md
... | ... | @@ -1,34 +1,33 @@ |
1 | 1 |
MariaDB 설치 |
2 | 2 |
=== |
3 | 3 |
|
4 |
-아래 설명은 진행 과정만 참고만 하시고 실제로는 MariaDB 10.1.10 이상을 설치해 주세요 |
|
4 |
+Please refer to the procedure below and install MariaDB 10.1.20 or later. |
|
5 | 5 |
|
6 | 6 |
1. Linux |
7 |
- - 배포본의 저장소 및 설치 스크립트는 다음 선택 페이지의 설명을 참고하여 설치 합니다. |
|
8 | 7 |
- [Setting up MariaDB Repositories](https://downloads.mariadb.org/mariadb/repositories/) |
9 | 8 |
|
10 | 9 |
2. Mac |
11 |
- - brew install 을 이용해서 설치를 권장합니다. |
|
10 |
+ - Recommed to use `brew install` |
|
12 | 11 |
- https://mariadb.com/blog/installing-mariadb-10010-mac-os-x-homebrew |
13 | 12 |
|
14 | 13 |
3. Windows |
15 | 14 |
- https://downloads.mariadb.org/mariadb/10.1.11/#os_group=windows |
16 | 15 |
|
17 |
-##### DB 설치후 유저 및 Database 생성 |
|
16 |
+##### Create user and database after installing DB |
|
18 | 17 |
|
19 |
-기본 진행 내용은 MariaDB에 root 유저로 접속한 다음 yona 유저를 만들고 DB를 만들고 해당 DB의 모든 권한을 yona 유저에게 주는 작업입니다. |
|
18 |
+The basic procedure is to connect to MariaDB as root user, create yona user, create DB, and give all permissions of yona user to DB. |
|
20 | 19 |
|
21 |
-MariaDB root 유저로 접속 |
|
20 |
+Connect to MariaDB with root |
|
22 | 21 |
``` |
23 | 22 |
mysql -uroot |
24 | 23 |
``` |
25 | 24 |
|
26 |
-yona 유저 생성. password는 IDENTIFIED BY 다음에 지정한 문자가 됩니다. 아래 예)에서는 yonadan |
|
25 |
+Create user `yona` and set password. 'yonadan' is just example, so change it. |
|
27 | 26 |
``` |
28 | 27 |
create user 'yona'@'localhost' IDENTIFIED BY 'yonadan'; |
29 | 28 |
``` |
30 | 29 |
|
31 |
-DB 생성 UTF8 확장문자열을 저장할 수 있는 포맷으로 지정해서 생성합니다. |
|
30 |
+To use UTF8 extended chars, set file format to BARACUDA. |
|
32 | 31 |
|
33 | 32 |
``` |
34 | 33 |
set global innodb_file_format = BARRACUDA; |
... | ... | @@ -40,27 +39,28 @@ |
40 | 39 |
; |
41 | 40 |
``` |
42 | 41 |
|
43 |
-yona 유저에게 yona 데이터베이스 권한 부여 |
|
42 |
+Grant priviledges |
|
44 | 43 |
|
45 | 44 |
``` |
46 | 45 |
GRANT ALL ON yona.* to 'yona'@'localhost'; |
47 | 46 |
``` |
48 | 47 |
|
49 |
-`exit`명령어로 쉘로 빠져 나온 다음 yona 유저로 정상 접속되고 yona DB가 사용 가능한지 확인해 봅니다. |
|
50 |
-참고로 -p 다음에 쓴 글자가 위에서 만든 패스워드입니다. |
|
48 |
+Exit to the shell with `exit` command and check that yona DB is available and yona user is connected normally. |
|
49 |
+Note that the letter after the -p is the password created above. |
|
51 | 50 |
|
52 | 51 |
``` |
53 | 52 |
mysql -u yona -p'yonadan' |
54 | 53 |
use yona |
55 | 54 |
``` |
56 | 55 |
|
57 |
-/etc/my.cnf 파일을 만들어서 아래 내용을 추가해 주세요. |
|
58 |
-(mac os 유저의 경우에는 db 실행유저의 ~/.my.cnf에 아래 내용을 추가해 주세요) |
|
59 |
-샘플참고: https://github.com/yona-projects/yona/blob/next/support-script/mariadb/my.cnf |
|
56 |
+Please make a /etc/my.cnf file and add the following. |
|
60 | 57 |
|
61 |
-- Unicode 4Byte 확장 문자열을 지원하기 위해 utf8mb4를 사용하도록 되어 있습니다. |
|
62 |
-- lower_case_table_name=1 는 테이블명이나 컬럼명 조회시 대소문자를 구분하지 않도록 만드는 옵션입니다. |
|
63 |
-- collation-server 는 정렬시의 기준옵션을 설정하는 부분입니다. |
|
58 |
+(If you are a mac os user, add the following line to ~/.my.cnf file) |
|
59 |
+Example: https://github.com/yona-projects/yona/blob/next/support-script/mariadb/my.cnf |
|
60 |
+ |
|
61 |
+- It is supposed to use utf8mb4 to support Unicode 4Byte extension strings. |
|
62 |
+- `lower_case_table_name=1` is option makes the case of table or column names case insensitive. |
|
63 |
+- collation-server is criteria options when sorting. |
|
64 | 64 |
|
65 | 65 |
``` |
66 | 66 |
[client] |
... | ... | @@ -78,33 +78,29 @@ |
78 | 78 |
innodb_large_prefix=on |
79 | 79 |
``` |
80 | 80 |
|
81 |
-꼭 /etc 아래가 아니더라도 [my.cnf 위치 탐색순서](https://mariadb.com/kb/en/mariadb/configuring-mariadb-with-mycnf/) 를 보고 적당한 곳에 my.cnf 파일을 만들어서 넣어도 무방하다고 알려져 있습니다. (Mac OS 유저는 우선은 위 설명대로 해주세요. 추가 확인이 필요합니다) |
|
81 |
+Also, see [configuring-mariadb-with-mycnf](https://mariadb.com/kb/en/mariadb/configuring-mariadb-with-mycnf/) |
|
82 | 82 |
|
83 |
-이제 Yona 를 설치합니다. |
|
83 |
+Now, let's start to install Yona! |
|
84 | 84 |
|
85 | 85 |
|
86 |
--- 이하 내용은 참고용입니다 -- |
|
86 |
+-- The following is for reference only -- |
|
87 | 87 |
|
88 |
-### 만약 DB관련 작업을 한 후 정상적으로 페이지가 뜨지 않을 경우 아래 항목을 확인해 주세요. |
|
88 |
+### If the page does not open properly after working on the DB, check the items below. |
|
89 | 89 |
|
90 |
-- application.conf 가 제대로 읽히는지 |
|
91 |
-- application.secret 적용여부 |
|
92 |
-- db.default.url 확인 |
|
90 |
+- application.conf |
|
91 |
+- application.secret |
|
92 |
+- db.default.url |
|
93 | 93 |
|
94 |
-### MariaDB 재시작 방법 |
|
95 |
-자주하진 마세요! |
|
96 |
-DB를 설치한 유저로 DB를 재시작합니다. (root나 sudo 설치했을 경우 명령어 앞에 sudo를 붙여주세요) |
|
94 |
+### MariaDB Restart |
|
97 | 95 |
``` |
98 | 96 |
service mysql restart |
99 | 97 |
|
100 |
-혹은 |
|
98 |
+or |
|
101 | 99 |
|
102 | 100 |
/etc/init.d/mysql restart |
103 | 101 |
|
104 |
-혹은 |
|
102 |
+or |
|
105 | 103 |
|
106 | 104 |
mysql.server restart |
107 | 105 |
``` |
108 |
-참고: http://coolestguidesontheplanet.com/start-stop-mysql-from-the-command-line-terminal-osx-linux/ |
|
109 |
- |
|
110 |
-DB가 정상적으로 재시작되었으면 |
|
106 |
+See: http://coolestguidesontheplanet.com/start-stop-mysql-from-the-command-line-terminal-osx-linux/ |
--- docs/install-yona-server.md
+++ docs/install-yona-server.md
... | ... | @@ -1,31 +1,32 @@ |
1 |
-Yona 설치 |
|
1 |
+Yona Install |
|
2 | 2 |
=== |
3 | 3 |
|
4 |
-Yona 최신 버전을 https://github.com/yona-projects/yona/releases 에서 다운받아 압축을 풉니다. |
|
5 |
-wget으로 받아서 unzip으로 압축을 푼다면 미리 다운로드 링크 주소를 확인한 다음 내려받습니다. |
|
4 |
+Download the latest version of Yona from https://github.com/yona-projects/yona/releases and unzip it. |
|
5 |
+Also, consider to use wget like followings. |
|
6 | 6 |
|
7 |
-예) |
|
7 |
+ex) |
|
8 | 8 |
|
9 | 9 |
wget https://github.com/yona-projects/yona/releases/download/v1.3.0/yona-v1.3.0-bin.zip |
10 | 10 |
unzip yona.zip |
11 | 11 |
|
12 |
-### application.conf 파일 등 설정파일 생성하기 |
|
12 |
+### application.conf generating and setting |
|
13 | 13 |
|
14 |
-압축이 풀린 곳으로 이동해서 bin/yona 을 실행합니다. (Java 8 이상이 필요합니다) |
|
15 |
-**주의**: 아래와 같이 yona 설치 폴더에서 실행하여야 합니다. 또한 윈도우 사용자는 bin/yona 대신 bin/yona.bat을 실행해야 합니다. |
|
14 |
+Go to the unpacked location and run `bin/yona`. (Requires Java 8 or later) |
|
15 |
+**Note**: You should run it from yona installation folder as below. Windows users should also run `bin/yona.bat` instead of `bin/yona`. |
|
16 | 16 |
|
17 | 17 |
``` |
18 | 18 |
cd yona |
19 | 19 |
bin/yona |
20 | 20 |
``` |
21 | 21 |
|
22 |
-실행하면 패스워드가 틀렸다는 에러와 함께 실행이 종료 될겁니다. 이제 압축을 풀었을때는 안 보였던 conf 디렉터리가 보일 겁니다. |
|
22 |
+Execution will terminate with an error that the password is wrong. It's noraml. Don't worry. :) |
|
23 |
+You should now see the conf directory that you were not able to see when you extracted it. |
|
23 | 24 |
|
24 |
-#### DB 설정 수정 |
|
25 |
+#### DB configuration |
|
25 | 26 |
|
26 |
-앞서 설치한 MariaDB에 맞게 DB 연결 설정을 수정해야 합니다. |
|
27 |
+You need to modify the DB connection settings to connect the MariaDB you installed earlier. |
|
27 | 28 |
|
28 |
-conf 폴더 아래의 application.conf 파일에서 아래 부분에서 password를 위에서 설정한 password로 수정해 주세요 |
|
29 |
+In the application.conf file under the conf folder, change the password in the following section to the db password set above |
|
29 | 30 |
``` |
30 | 31 |
... |
31 | 32 |
db.default.driver=org.mariadb.jdbc.Driver |
... | ... | @@ -35,36 +36,32 @@ |
35 | 36 |
... |
36 | 37 |
``` |
37 | 38 |
|
38 |
-`yonadan`은 예시일뿐 그대로 사용하지 않는 걸 권장합니다. |
|
39 |
+`yonadan` is just example, recommed change it to your own password. |
|
39 | 40 |
|
40 | 41 |
|
41 |
-본격적인 첫 화면 보기 위한 실행 |
|
42 |
+Run for first page |
|
42 | 43 |
---- |
43 | 44 |
|
44 |
-yona v1.3 이상부터는 data 폴더만 지정해주면 어느 위치에서 yona를 실행시켜도 무방하게 변경되었습니다. 이후에 버전 업그레이드시에도 특별히 데이터 폴더들을 옮기거나 할 필요가 없습니다. |
|
45 |
- |
|
46 |
-- conf 폴더와 각종 데이터를 유지할 폴더를 하나 만듭니다. |
|
45 |
+- Create a folder to hold various data including conf folder. |
|
47 | 46 |
``` |
48 |
-예) |
|
47 |
+ex) |
|
49 | 48 |
|
50 | 49 |
/yona-data |
51 | 50 |
``` |
52 |
-- conf 폴더를 위에서 만든 /yona-data로 복사합니다. |
|
51 |
+- copy conf folder to `/yona-data` created above. |
|
53 | 52 |
``` |
54 |
-예) 현재 위치가 /Users/doortts/Download/yona-v1.3.0-bin 이라고 가정했을때 |
|
53 |
+Ex) Assuming your current location is /Users/doortts/Download/yona-v1.3.0-bin |
|
55 | 54 |
|
56 | 55 |
cp -r conf /yona-data |
57 | 56 |
``` |
58 | 57 |
|
59 |
-- YONA_DATA 환경변수를 지정하고 Yona 실행 |
|
58 |
+- Specify the YONA_DATA environment variable and run Yona |
|
60 | 59 |
``` |
61 |
-예) 현재 위치가 /Users/doortts/Download/yona-v1.3.0-bin 이라고 가정했을때 |
|
60 |
+Ex) Assuming your current location is /Users/doortts/Download/yona-v1.3.0-bin |
|
62 | 61 |
|
63 | 62 |
YONA_DATA=/yona-data;export YONA_DATA |
64 | 63 |
bin/yona |
65 | 64 |
``` |
66 | 65 |
|
67 |
-이어서 본격적인 실행 방법에 대해서는 [yona-run-and-upgrade.md](yona-run-and-upgrade.md)를 참고해주세요. |
|
68 |
- |
|
69 |
-만약 사용버전이 v1.3 이전일 경우에는 [yona-run-under-v1.3](yona-run-under-v1.3.md) 를 참고해주세요. |
|
66 |
+Then, please refer to [yona-run-and-upgrade.md](yona-run-and-upgrade.md) for details. |
|
70 | 67 |
|
--- docs/ko/install-mariadb.md
+++ docs/ko/install-mariadb.md
... | ... | @@ -82,6 +82,8 @@ |
82 | 82 |
|
83 | 83 |
이제 Yona 를 설치합니다. |
84 | 84 |
|
85 |
+[Install Yona Server](install-yona-server.md) |
|
86 |
+ |
|
85 | 87 |
|
86 | 88 |
-- 이하 내용은 참고용입니다 -- |
87 | 89 |
|
--- docs/ko/install-yona-server.md
+++ docs/ko/install-yona-server.md
... | ... | @@ -43,7 +43,7 @@ |
43 | 43 |
|
44 | 44 |
yona v1.3 이상부터는 data 폴더만 지정해주면 어느 위치에서 yona를 실행시켜도 무방하게 변경되었습니다. 이후에 버전 업그레이드시에도 특별히 데이터 폴더들을 옮기거나 할 필요가 없습니다. |
45 | 45 |
|
46 |
-- conf 폴더와 각종 데이터를 유지할 폴더를 하나 만듭니다. |
|
46 |
+- conf 폴더를 비롯해 각종 데이터를 유지할 폴더를 하나 만듭니다. |
|
47 | 47 |
``` |
48 | 48 |
예) |
49 | 49 |
|
--- docs/ko/trouble-shootings.md
+++ docs/ko/trouble-shootings.md
... | ... | @@ -31,3 +31,13 @@ |
31 | 31 |
|
32 | 32 |
SET JAVA_OPTS=-DapplyEvolutions.default=true |
33 | 33 |
bin\yona |
34 |
+ |
|
35 |
+### RuntimeException: Provider 'google' missing needed setting 'clientId' |
|
36 |
+ |
|
37 |
+application.conf 파일에서 관련 설정을 읽어 들일 수 없을때 발상하는 오류. |
|
38 |
+ |
|
39 |
+application.conf 맨 하단에 아래 설정을 추가해 주세요. |
|
40 |
+ |
|
41 |
+``` |
|
42 |
+include "social-login.conf" |
|
43 |
+``` |
--- docs/ko/yona-run-options.md
+++ docs/ko/yona-run-options.md
... | ... | @@ -59,9 +59,10 @@ |
59 | 59 |
|
60 | 60 |
### 메모리 할당 증가 |
61 | 61 |
|
62 |
-`_JAVA_OPTIONS` 환경변수를 이용해 자바 환경 변수를 지정할 수도 있습니다. 시스템 |
|
62 |
+`SET JAVA_OPTS` 환경변수 설정을 이용해 자바 환경 변수를 지정할 수도 있습니다. 시스템 |
|
63 | 63 |
메모리가 4기가 이상이라면, 다음과 같은 옵션으로 실행하는 걸 권장합니다. |
64 | 64 |
|
65 |
+ |
|
65 | 66 |
``` |
66 | 67 |
예) yona-run.bat 파일로 만들어 본 실행 스크립트 작성 예. 메모리 2G 할당 |
67 | 68 |
SET YONA_DATA=c:\yona-data |
--- docs/system-requirements.md
+++ docs/system-requirements.md
... | ... | @@ -1,7 +1,7 @@ |
1 | 1 |
Server |
2 | 2 |
------ |
3 | 3 |
|
4 |
-* Java SE 7 or 8 JDK |
|
4 |
+* Java SE 8 or later JDK |
|
5 | 5 |
|
6 | 6 |
Client |
7 | 7 |
------ |
--- docs/trouble-shootings.md
+++ docs/trouble-shootings.md
... | ... | @@ -1,33 +1,40 @@ |
1 |
-### 설치시 오류 [1]입력 줄이 너무 깁니다. |
|
2 |
-Windows OS에서는 명령줄 길이 한계로 너무 하위로 들어가지 않도록 \ 아래에 폴더를 만들어 주세요. |
|
3 |
-드라이브 아래에 바로 폴더를 만드는 걸 권장합니다. |
|
1 |
+### "Input line is too long" error in BAT File |
|
2 |
+On the Windows OS, create a folder under \ so that it does not fall too far into the command line length limit. |
|
3 |
+We recommend creating the folder directly under the drive. |
|
4 | 4 |
|
5 | 5 |
``` |
6 |
-Windows OS Yona 권장 폴더 |
|
7 |
-C:\yona\yona-1.3.0 <- yona 폴더아래에 버전별로 압축해제 |
|
8 |
-C:\yona-data <- conf 파일, logs, uploads, repo 폴더가 생성되고 유지되는 곳. YONA_DATA 환경 변수로 지정 |
|
6 |
+Windows OS Yona recommanded folder |
|
7 |
+C:\yona\yona-1.3.0 <- Unzip under the yona folder by version |
|
8 |
+C:\yona-data <- Conf files, logs, uploads, repo where folders are created and maintained. Specify with the YONA_DATA environment variable |
|
9 | 9 |
``` |
10 | 10 |
|
11 |
-만약 부득이하게 Program Files 등의 하위 폴더에 설치해야 한다면 아래 링크를 참고해주세요. |
|
12 |
-https://github.com/yona-projects/yona/issues/130 |
|
13 |
- |
|
14 |
-### MariaDB 767 byte 에러가 발생했다면? |
|
15 |
-만약 콘솔에 DB 관련 에러 특히 |
|
11 |
+### Specified key was too long; max key length is 767 bytes |
|
12 |
+If you see following errors at console, |
|
16 | 13 |
``` |
17 | 14 |
[error] play - Specified key was too long; max key length is 767 bytes [ERROR:1071, SQLSTATE:42000] |
18 | 15 |
``` |
19 |
-가 발생할 경우 [MariaDB 767 byte 에러](db-error-767.md) 항목을 참고해 주세요 |
|
16 |
+See [MariaDB 767 byte error](db-error-767.md) |
|
20 | 17 |
|
21 | 18 |
|
22 |
-### Yona 버전 업그레이드시 옵션 조절 |
|
19 |
+### Option adjustment when upgrading Yona version |
|
23 | 20 |
|
24 |
-업그레이드를 하는 경우 다음과 같이 데이터베이스 스키마 마이그레이션이 |
|
25 |
-필요하다는 경고 메시지와 함께 실행되지 않는 상황을 겪을 수 있습니다. |
|
21 |
+If you are upgrading, migrate the database schema as follows: |
|
22 |
+You may experience a situation that does not work with a warning message that you need it. |
|
26 | 23 |
|
27 | 24 |
[warn] play - Your production database [default] needs evolutions! |
28 | 25 |
|
29 |
-그런 경우에는 자동으로 마이그레이션이 되도록 다음과 같이 |
|
30 |
-applyEvolutions.default 자바 프로퍼티를 true로 설정합니다. |
|
26 |
+In such a case, the migration should be done as follows |
|
27 |
+ApplyEvolutions.default Sets the Java property to true. |
|
31 | 28 |
|
32 | 29 |
SET JAVA_OPTS=-DapplyEvolutions.default=true |
33 | 30 |
bin\yona |
31 |
+ |
|
32 |
+### RuntimeException: Provider 'google' missing needed setting 'clientId' |
|
33 |
+ |
|
34 |
+An error that occurs when the related settings can not be read from the application.conf file. |
|
35 |
+ |
|
36 |
+Please add the following settings to the bottom of application.conf. |
|
37 |
+ |
|
38 |
+``` |
|
39 |
+include "social-login.conf" |
|
40 |
+``` |
--- docs/troubleshoot.md
... | ... | @@ -1,12 +0,0 @@ |
1 | -This document is a troubleshooting guide to help you resolve well-known | |
2 | -problems you might have with Yobi. | |
3 | - | |
4 | -### Cannot commit a large file into a SVN repository | |
5 | - | |
6 | -If it takes a lot of time to commit a large file into a SVN repository so that | |
7 | -you can't commit the file, the cause may be a lack of memory. Please allocate | |
8 | -more memory to Yobi by using java options as follows: | |
9 | - | |
10 | - _JAVA_OPTIONS="-Xmx4096m -Xms2048m" activator "start -DapplyEvolutions.default=true -Dhttp.port=9000" | |
11 | - | |
12 | -Thanks to @zepinos for reporting at https://github.com/naver/yobi/issues/901. |
--- docs/yona-backup-restore.md
+++ docs/yona-backup-restore.md
... | ... | @@ -1,30 +1,19 @@ |
1 |
-백업하기 |
|
1 |
+Backup and Restore |
|
2 | 2 |
=== |
3 | 3 |
|
4 |
-DB 백업 및 이전 복구 방법 |
|
4 |
+DB |
|
5 | 5 |
--- |
6 |
-[DB 백업 및 이전 복구 방법](https://github.com/yona-projects/yona/wiki/DB-%EB%B0%B1%EC%97%85-%EB%B0%8F-%EC%9D%B4%EC%A0%84-%EB%B3%B5%EA%B5%AC-%EB%B0%A9%EB%B2%95) |
|
6 |
+See: https://mariadb.com/kb/en/mariadb/backup-and-restore-overview |
|
7 | 7 |
|
8 |
-참고: https://mariadb.com/kb/en/mariadb/backup-and-restore-overview |
|
9 |
- |
|
10 |
-각종 설정 및 파일들 백업 |
|
8 |
+Back up various settings and files |
|
11 | 9 |
--- |
12 |
-YONA_DATA 환경변수로 지정된 디렉터리를 통째로 압축해서 보관합니다. |
|
10 |
+The entire directory specified by the YONA_DATA environment variable is kept compressed. |
|
13 | 11 |
|
14 | 12 |
|
15 |
-참고: YONA_DATA에 생성된 디렉터리 설명 |
|
13 |
+Note: The directory description created in YONA_DATA |
|
14 |
+```` |
|
15 |
+- conf - where server configuration files are located |
|
16 |
+- uploads - where uploaded attachments are located |
|
17 |
+- repo - code repository files |
|
18 |
+- logs - log files |
|
16 | 19 |
``` |
17 |
-- conf - 서버 설정파일들이 있는 곳 |
|
18 |
-- uploads - 업로드된 첨부파일들이 있는 곳 |
|
19 |
-- repo - 코드 저장소 파일들 |
|
20 |
-- logs - 로그 파일들 |
|
21 |
-``` |
|
22 |
- |
|
23 |
- |
|
24 |
-#### v1.3 이전 |
|
25 |
- |
|
26 |
-코드 저장소의 파일과 업로드 파일은 아래 디렉터리에 저장됩니다. |
|
27 |
- |
|
28 |
- directory: repo, uploads |
|
29 |
- |
|
30 |
-주기적으로 두 디렉터리는 따로 잘 백업해 주세요. |
--- docs/yona-mail-settings.md
+++ docs/yona-mail-settings.md
... | ... | @@ -1,11 +1,10 @@ |
1 |
-각종 알림을 메일로 발송하도록 설정하는 방법 |
|
1 |
+How to set up sending notifications by email |
|
2 | 2 |
=== |
3 | 3 |
|
4 |
-메일 발송 기능 |
|
4 |
+Mail sending function |
|
5 | 5 |
---- |
6 |
-- conf 디렉터리에 있는 application.conf 파일을 열어 Mailer 항목내용을 수정합니다. |
|
7 |
-- 주의할 부분!! |
|
8 |
- - `smtp.mock = true`로 되어 있는 부분을 false로 바꿔야 실제 메일이 발송됩니다. |
|
6 |
+- Open the application.conf file in the conf directory to modify the contents of the Mailer entry. |
|
7 |
+- You must change `smtp.mock = true` to false, then the actual mail will be sent. |
|
9 | 8 |
|
10 | 9 |
|
11 | 10 |
``` |
... | ... | @@ -26,10 +25,10 @@ |
26 | 25 |
smtp.archive.size = 5 |
27 | 26 |
``` |
28 | 27 |
|
29 |
-메일로 Yona에 이슈나 댓글이 등록될 수 있게 설정하는 방법 |
|
28 |
+How to set up an issue or comment on Yona by mail |
|
30 | 29 |
--- |
31 |
-- Yona는 MailBox 기능을 이용해서 알림메일에 직접 답장을 해서 댓글을 등록하거나 특정 프로젝트로 메일을 이용해 이슈를 등록하는 기능을 제공하고 있습니다. |
|
32 |
-- 이 기능을 사용하려면 메일박스 설정을 해야 합니다. |
|
30 |
+- Yona uses the MailBox function to reply directly to the notification mail and register the comment, or to register the issue by mail to a specific project. |
|
31 |
+- To use this function, you have to set up mailbox. |
|
33 | 32 |
|
34 | 33 |
``` |
35 | 34 |
# Mailbox Service |
--- docs/yona-run-and-restart.md
+++ docs/yona-run-and-restart.md
... | ... | @@ -1,32 +1,26 @@ |
1 |
-Yona 실행 방법 |
|
1 |
+How to run Yona |
|
2 | 2 |
=== |
3 | 3 |
|
4 |
-압축이 풀린 디렉터리로 이동해서 yona를 실행합니다. |
|
4 |
+Go to the unpacked directory and run yona. |
|
5 | 5 |
|
6 | 6 |
``` |
7 | 7 |
YONA_DATA=/yona-data;export YONA_DATA |
8 | 8 |
bin/yona |
9 | 9 |
``` |
10 |
-**[주의!] 이때 bin 폴더 아래로 이동해서 직접 `yona`를 실행하지 않도록 유의해주세요** |
|
10 |
+**[Caution!] Please move below bin folder and do not run `yona` directly** |
|
11 | 11 |
|
12 |
-최초 화면 확인 |
|
12 |
+First Page |
|
13 | 13 |
---- |
14 |
-이제 웹 브라우저로 해당 서버 9000 포트(로컬환경이면 http://127.0.0.1:9000)에 접속하면 환영 페이지를 보실 수 있습니다. |
|
14 |
+You can now access the welcome page by accessing the appropriate server 9000 port (http://127.0.0.1:9000 in local environment) with your web browser. |
|
15 | 15 |
|
16 |
-어드민 설정을 마치고 Yona를 다시 시작합니다. |
|
16 |
+Finish setting admin and restart Yona. |
|
17 | 17 |
|
18 |
-**유의! Windows OS 사용자의 경우** |
|
19 |
-[#windows의-경우](yona-run-options.md#windows의-경우)를 꼭 참고해주세요 |
|
18 |
+**Note! For Windows OS users** |
|
19 |
+Please note [#windows-os](yona-run-options.md#windows-os) |
|
20 | 20 |
|
21 | 21 |
|
22 |
-Tip - Windows에서 yona 백그라운드 처리 |
|
23 |
---- |
|
24 |
-https://github.com/yona-projects/yona/issues/64 |
|
22 |
+### To restart |
|
25 | 23 |
|
26 |
- |
|
27 |
-### 재시작 방법 |
|
28 |
- |
|
29 |
-- Linux/Uinx 계열에서는 kill pid 명령으로 서비스를 중단합니다. |
|
30 |
-- [간단한 재시작 쉘 예제](https://github.com/yona-projects/yona/blob/next/restart.sh) |
|
31 |
-- 윈도우즈 사용자는 ctrl-c 로 실행중인 배치파일을 종료합니다. |
|
32 |
- |
|
24 |
+- In the Linux/Uinx, the kill pid command stops the service. |
|
25 |
+- [Simple Restart Shell Example](https://github.com/yona-projects/yona/blob/next/restart.sh) |
|
26 |
+- Windows users exit the batch file that is running with ctrl-c. |
--- docs/yona-run-options.md
+++ docs/yona-run-options.md
... | ... | @@ -1,20 +1,20 @@ |
1 |
-Yona 실행시 추가 가능한 옵션 |
|
1 |
+Additional options when running Yona |
|
2 | 2 |
=== |
3 | 3 |
|
4 |
-Linux, OSX의 경우 |
|
4 |
+Linux, OSX |
|
5 | 5 |
---- |
6 | 6 |
|
7 |
-### 메모리 할당 증가 |
|
7 |
+### Memory allocation |
|
8 | 8 |
|
9 |
-`_JAVA_OPTIONS` 환경변수를 이용해 자바 환경 변수를 지정할 수도 있습니다. 시스템 |
|
10 |
-메모리가 4기가 이상이라면, 다음과 같은 옵션으로 사용가능한 메모리를 증가시켜서 실행하는걸 권장합니다. |
|
9 |
+You can also use the `_JAVA_OPTIONS` environment variable to specify Java environment variables. |
|
10 |
+If the memory is more than 4GB, it is recommended to increase the available memory with the following options. |
|
11 | 11 |
|
12 | 12 |
_JAVA_OPTIONS="-Xmx2048m -Xms2048m" bin/yona |
13 | 13 |
|
14 |
-메모리 부족관련 에러가 발생할 경우 유용합니다. |
|
14 |
+This is useful when an error related to memory shortage occurs. |
|
15 | 15 |
|
16 | 16 |
``` |
17 |
-예) yona-run.sh 로 만들어 본 실행 스크립트 작성 예 |
|
17 |
+Ex) Example of writing an execution script created with yona-run.sh |
|
18 | 18 |
|
19 | 19 |
|
20 | 20 |
YONA_DATA=/yona-data;export YONA_DATA |
... | ... | @@ -22,14 +22,14 @@ |
22 | 22 |
|
23 | 23 |
``` |
24 | 24 |
|
25 |
-### 기본 포트 변경 |
|
25 |
+### Change default port |
|
26 | 26 |
|
27 |
-기본적으로 9000번 포트를 사용하지만, 다른 포트를 사용하고 싶다면 http.port 자바 |
|
28 |
-환경변수를 수정합니다. |
|
27 |
+By default it use port 9000. If you want to use a different port, |
|
28 |
+modify the environment variables. |
|
29 | 29 |
|
30 | 30 |
|
31 | 31 |
``` |
32 |
-예) yona-run.sh 로 만들어 본 실행 스크립트 작성 예. 80포트를 사용하고 메모리 2G로 동작 |
|
32 |
+Ex) Example of writing an execution script created with `yona-run.sh` It use 80 port and 2G memory. |
|
33 | 33 |
|
34 | 34 |
YONA_DATA=/yona-data;export YONA_DATA |
35 | 35 |
_JAVA_OPTIONS="-Dhttp.port=80 -Xmx2048m -Xms2048m" bin/yona |
... | ... | @@ -37,56 +37,56 @@ |
37 | 37 |
``` |
38 | 38 |
|
39 | 39 |
|
40 |
-Windows의 경우 |
|
40 |
+Windows os |
|
41 | 41 |
--- |
42 | 42 |
|
43 |
-Yona를 시작할 때, YONA_DATA 환경변수를 지정해서 아래 명령순서로 실행해주세요! |
|
44 |
-YONA_DATA의 지정 폴더는 내려받은 실행파일의 위치가 아니라 설정파일 및 첨부파일, 코드 저장소 등이 만들어질 위치를 지정합니다. |
|
45 |
-관련해서는 Yona 설치 가이드의 [install-yona-server.md#본격적인-첫-화면-보기-위한-실행](install-yona-server.md) 부분을 참고해주세요 |
|
43 |
+When you start Yona, specify the environment variable YONA_DATA and execute it in the following order! |
|
44 |
+The specified folder of YONA_DATA specifies the location where the configuration file, attachment, code repository, etc. will be created, not the location of the downloaded executable file. |
|
45 |
+Please refer to [install-yona-server.md](install-yona-server.md) in the Yona Installation Guide. |
|
46 | 46 |
|
47 | 47 |
``` |
48 |
-Windows OS Yona 권장 폴더 |
|
49 |
-C:\yona\yona-1.3.0 <- yona 폴더아래에 버전별로 압축해제 |
|
50 |
-C:\yona-data <- conf 파일, logs, uploads, repo 폴더가 생성되고 유지되는 곳. YONA_DATA 환경 변수로 지정 |
|
48 |
+Windows OS Yona Recommended folder |
|
49 |
+C:\yona\yona-1.3.0 <- unpack by version under the yona folder |
|
50 |
+C:\yona-data <- conf where files, logs, uploads, and repo folders are created and maintained. Specify with the YONA_DATA environment variable |
|
51 | 51 |
``` |
52 | 52 |
|
53 |
-아래와 같은 내용이 들어가 있는 run.bat을 따로 만드셔도 좋습니다! |
|
53 |
+You can also create run.bat with the following contents! |
|
54 | 54 |
|
55 | 55 |
``` |
56 | 56 |
SET YONA_DATA=c:\yona-data |
57 | 57 |
bin\yona.bat |
58 | 58 |
``` |
59 | 59 |
|
60 |
-### 메모리 할당 증가 |
|
60 |
+### Memory allocation |
|
61 | 61 |
|
62 |
-`_JAVA_OPTIONS` 환경변수를 이용해 자바 환경 변수를 지정할 수도 있습니다. 시스템 |
|
63 |
-메모리가 4기가 이상이라면, 다음과 같은 옵션으로 실행하는 걸 권장합니다. |
|
62 |
+You can also specify Java environment variables using the `SET JAVA_OPTS` environment variable setting. system |
|
63 |
+If you have more than 4 gigabytes of memory, we recommend running with the following options: |
|
64 | 64 |
|
65 | 65 |
``` |
66 |
-예) yona-run.bat 파일로 만들어 본 실행 스크립트 작성 예. 메모리 2G 할당 |
|
66 |
+Ex) Example of writing an execution script created with `yona-run.sh` It use 2G memory. |
|
67 | 67 |
SET YONA_DATA=c:\yona-data |
68 | 68 |
SET JAVA_OPTS=-Xmx2048m -Xms2048m |
69 | 69 |
bin\yona.bat |
70 | 70 |
``` |
71 | 71 |
|
72 |
-기본적으로 9000번 포트를 사용하지만, 다른 포트를 사용하고 싶다면 http.port 자바 |
|
73 |
-환경변수를 수정합니다. |
|
72 |
+By default it use port 9000. If you want to use a different port, |
|
73 |
+modify the environment variables. |
|
74 | 74 |
|
75 | 75 |
``` |
76 |
-예) yona-run.bat 파일로 만들어 본 실행 스크립트 작성 예. 80포트를 사용하고 메모리 2G로 동작 |
|
76 |
+Ex) Example of writing an execution script created with `yona-run.sh` It use 80 port and 2G memory. |
|
77 | 77 |
|
78 | 78 |
SET YONA_DATA=c:\yona-data |
79 | 79 |
SET JAVA_OPTS=-Dhttp.port=80 -Xmx2048m -Xms2048m |
80 | 80 |
bin\yona.bat |
81 | 81 |
``` |
82 | 82 |
|
83 |
-업그레이드를 하는 경우 다음과 같이 데이터베이스 스키마 마이그레이션이 |
|
84 |
-필요하다는 경고 메시지와 함께 실행되지 않는 상황을 겪을 수 있습니다. |
|
83 |
+If you are upgrading, migrate the database schema as follows: |
|
84 |
+You may experience a situation that does not work with a warning message that you need it. |
|
85 | 85 |
|
86 | 86 |
[warn] play - Your production database [default] needs evolutions! |
87 | 87 |
|
88 |
-그런 경우에는 자동으로 마이그레이션이 되도록 다음과 같이 |
|
89 |
-applyEvolutions.default 자바 프로퍼티를 true로 설정한 부분을 추가 합니다. |
|
88 |
+In such a case, the migration should be done as follows |
|
89 |
+ApplyEvolutions.default Adds a section with the Java property set to true. |
|
90 | 90 |
|
91 | 91 |
``` |
92 | 92 |
SET YONA_DATA=c:\yona-data |
... | ... | @@ -94,7 +94,7 @@ |
94 | 94 |
bin\yona.bat |
95 | 95 |
``` |
96 | 96 |
|
97 |
-#### 옵션에 대한 더 자세한 설명 |
|
97 |
+#### A more detailed description of the options |
|
98 | 98 |
|
99 |
-[http://www.playframework.com/documentation/2.3.6/Production](http://www.playframework.com/documentation/2.3.6/Production) 부분을 확인해 주세요. |
|
99 |
+[http://www.playframework.com/documentation/2.3.6/Production](http://www.playframework.com/documentation/2.3.6/Production) |
|
100 | 100 |
|
--- docs/yona-upgrade.md
+++ docs/yona-upgrade.md
... | ... | @@ -1,27 +1,6 @@ |
1 |
-#### 업그레이드 |
|
1 |
+#### How to upgrade |
|
2 | 2 |
|
3 |
-v1.3 이상 |
|
4 |
----- |
|
5 |
-- 기존 운영중인 Yona를 중단합니다. |
|
6 |
-- 새로 내려받은 Yona 파일의 압축을 해제합니다. |
|
7 |
-- 실행시 사용했던 YONA_DATA 환경변수를 지정합니다. |
|
8 |
-- bin/yona 를 실행합니다. |
|
9 |
- |
|
10 |
-참고: [Yona 실행 및 재시작 방법](yona-run-and-restart) |
|
11 |
- |
|
12 |
- |
|
13 |
-v1.3 이전 버전 |
|
14 |
----- |
|
15 |
-설치할 때와 똑같이, 최신 버전을 내려받아 Yona가 설치된 디렉터리에 압축파일을 |
|
16 |
-풉니다. |
|
17 |
- |
|
18 |
-**주의사항! `repo`와 `uploads` 디렉터리를 삭제하거나 |
|
19 |
-덮어쓰지 않도록 주의하세요!** |
|
20 |
- |
|
21 |
- |
|
22 |
-Yobi에서 Yona로 업그레이드 하려는 경우 |
|
23 |
---- |
|
24 |
-1. 위의 설치방법을 참고해서 Yona를 설치 합니다. |
|
25 |
-2. [Yobi 에서 Yona로 Migration 하는 방법](https://repo.yona.io/yona-projects/yona/post/1)을 참고해서 마이그레이션을 진행합니다. |
|
26 |
- |
|
27 |
- |
|
3 |
+- Stop Yona. |
|
4 |
+- Extract the newly downloaded Yona file. |
|
5 |
+- Specifies the YONA_DATA environment variable. |
|
6 |
+- Run `bin/yona`(No newline at end of file) |
Add a comment
Delete comment
Once you delete this comment, you won't be able to recover it. Are you sure you want to delete this comment?