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

test
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 9.4KB

1 year ago
1 year ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
  1. <a name="korean"></a>[[English]](#english)
  2. [![Build Status](https://travis-ci.org/yona-projects/yona.svg?branch=master)](https://travis-ci.org/yona-projects/yona)
  3. ![Downloads Status](https://img.shields.io/github/downloads/yona-projects/yona/total.svg)
  4. <img src='public/images/yona_logo.png' width='300px'>
  5. 21세기 협업 개발 플랫폼
  6. DEMO: [http://repo.yona.io](http://repo.yona.io)
  7. Official Site: [http://yona.io](http://yona.io)
  8. Yona?
  9. --
  10. - Git 저장소 기능이 내장된 설치형 이슈트래커
  11. - Naver, Naver Labs 를 비롯하여 게임회사, 통신회사 고객센터, 공공기관, 투자사, 학교, 기업등에서 수년 간 실제로 사용되어 왔고 개선되어 온(Real world battled) 애플리케이션입니다
  12. 주요기능
  13. ---
  14. - 서비스 종료나 데이터 종속 걱정없는 설치형
  15. - 프로젝트 기반의 유연한 이슈트래커와 게시판
  16. - 편리한 프로젝트간 이슈 이동
  17. - 서브 태스크 이슈
  18. - 본문 변경이력 보기
  19. - 이슈 템플릿 기능
  20. - 자체 내장된 코드 저장소
  21. - Git/SVN 선택 가능
  22. - 온라인 수정 및 커밋 지원
  23. - 프로젝트 멤버만 코드에 접근 가능 기능 등
  24. - 블럭기반 코드리뷰
  25. - 코드 블럭 및 리뷰 스레드 지원
  26. - 리뷰 점수 지원
  27. - 그룹 기능
  28. - 그룹 이슈 및 게시글 통합관리
  29. - 그룹 프로젝트, 그룹 멤버
  30. - 한글 기반
  31. - 프로젝트 이름 및 그룹 이름에 한글을 사용가능
  32. - LDAP 지원
  33. - LDAP 장애시에도 사용가능한 기능 제공
  34. - 다른 제품이나 서비스로의 마이그레이션 기능 제공
  35. - Github/Github Enterprise, 또 다른 Yona 인스턴스, Redmine 등
  36. - 로그인 관련 보안을 높일 수 있는 소셜로그인 지원
  37. 등을 비롯하여 일상적인 업무에서 SW 개발 전반에 필요한 다양한 기능을 포함하고 있습니다.
  38. 추가 읽을거리
  39. ---
  40. - [왜 Yona를 써야 하나요? (Why Yona?)](https://repo.yona.io/yona-projects/yona/post/3)
  41. - [기본 워크플로우](https://repo.yona.io/yona-projects/yona-help/post/2)
  42. 라이선스
  43. --
  44. Yona는 Apache 2.0 라이선스로 제공됩니다.
  45. **이어지는 설치 및 실행, 백업 등등에 대한 자세한 설명은 [Wiki](https://github.com/yona-projects/yona/wiki)에 따로 세분화되어 정리되어 있습니다.**
  46. Yona 설치 및 실행
  47. ===
  48. Yona 배포판
  49. ---
  50. 현재 Yona는 버전별로 두 개의 배포판을 [릴리즈 메뉴](https://github.com/yona-projects/yona/releases)를 통해 제공하고 있습니다.
  51. - MariaDB 버전
  52. - 기본 권장 버전
  53. - `yona-v1.11.0-bin.zip` 같은 형식으로 파일로 배포
  54. - DB 설치에 약간의 시간이 필요하지만 안정적으로 운영이 가능
  55. - H2 DB 내장형
  56. - DB 설정없이 내려받아서 바로 실행해서 쓸 수 있는 버전
  57. - `yona-h2-v1.11.0-bin.zip` 같은 형식으로 파일로 배포
  58. - USB 등에 담아서 이동해가면서 사용하거나 작업후 통째로 zip으로 묶어서 들고 다니는 것이 가능함
  59. - 대규모 사이트에서 사용하기에는 적합하지 않음. 참고: [Yona가 MariaDB를 기본 DB로 사용하게 된 이유](https://repo.yona.io/yona-projects/yona/post/4)
  60. Yona 설치
  61. ---
  62. Yona는 크게 다음과 같은 2단계로 설치합니다.
  63. - [MariaDB 설치](docs/ko/install-mariadb.md)
  64. - [Yona 설치](docs/ko/install-yona-server.md)
  65. #### Docker를 이용한 설치
  66. [Docker](https://www.docker.com/)를 이용해 설치하실분은 [pokev25](https://github.com/pokev25) 님의 https://github.com/pokev25/docker-yona 를 이용해주세요.
  67. #### Amazon AWS 에 설치
  68. https://okdevtv.com/mib/yona 에서 가이드를 볼 수 있습니다. by [Kenu](https://www.facebook.com/kenu.heo)님
  69. Yona 실행 및 업그레이드/백업 및 복구/문제 해결
  70. ---
  71. - [실행 및 재시작 방법](docs/ko/yona-run-and-restart.md)
  72. - 안정적인 운영을 위한 [실행 옵션들](docs/ko/yona-run-options.md)
  73. - [업그레이드](docs/ko/yona-upgrade.md)
  74. - [백업 및 복구](docs/ko/yona-backup-restore.md)
  75. - [알림메일 발송 기능 설정](docs/ko/yona-mail-settings.md)
  76. - [발생 가능한 문제상황들과 해결방법](docs/ko/trouble-shootings.md)
  77. 소스코드를 직접 내려 받아서 빌드하거나 자신만의 배포판을 만들기
  78. ---
  79. 자신의 입맛에 맛게 코드를 직접 수정해서 작업하거나 코드를 기여하고 싶을 경우에는 코드 저장소로부터 코드를 직접 내려받아서 빌드/실행하는 것도 가능합니다.
  80. [소스코드를 직접 내려 받아서 실행하기](https://repo.yona.io/yona-projects/yona/post/5)를 참고해 주세요
  81. 서버 관련 설정들
  82. ---
  83. - [application.conf 설명](docs/ko/application-conf-desc.md)
  84. - [소셜 로그인 설정](docs/ko/yona-social-login-settings.md)
  85. Google Analytics
  86. ---
  87. - 기본적으로는 Google Analytics 가 활성화 되어 함께 배포됩니다.
  88. - 설치형으로 제공되는 Yona의 특성상 제품이 지속적으로 개발/유지되기 위해서는 사용자들이 현재 어느정도 내려받아서 사용하고 있는지에 대한 정보가 필요합니다.
  89. - 만약 이부분에 대해 도움을 주기 곤란한 경우 application.conf 에서 아래 항목을 false로 수정합니다.
  90. ```
  91. application.send.yona.usage = true
  92. ```
  93. 마이그레이션
  94. ---
  95. - 기본적으로 Yona 에서 Github/Github Enterprise 로 이전하는 기능을 제공합니다.
  96. - [Yona에서 Github으로 이사가는 방법](https://repo.yona.io/yona-projects/yona-help/post/4)
  97. - [설정](https://github.com/yona-projects/yona/blob/master/conf/application.conf.default#L297)
  98. - [Yona Export](https://github.com/yona-projects/yona-export)
  99. - 프로젝트 로컬 백업
  100. - Yona 에서 다른 Yona 인스턴스로 이전 지원
  101. - 일명 '출장용 Yona 기능'이라고도 할 수 있는 하는 기능입니다.
  102. - DB내장형 경량 Yona인, [Yona H2 Embedded 버전]을 사용해서 출장/파견 나가서 작업하다가 작업 완료후에 Export 받아서 본점 Yona에 Import 하는 것이 v1.6.0부터 가능합니다.
  103. - Export 파일 포맷만 일치시킨다면 어떤 소스로부터도 마이그레이션이나 이동이 가능합니다
  104. Contribution
  105. ---
  106. - 코드 기여의 기준이 되는 브랜치는 `master`입니다.
  107. - 저장소를 fork 한 다음 `master` 브랜치를 기준으로 작업하신다음 `master` 브랜치로 pull request를 보내주세요.
  108. - `next`브랜치는 내부 개발용입니다. 어떠한 기능들이 추가되고 있는지 현장을 보고 싶으시면 `next`브랜치를 참고해주세요.
  109. - 코드리뷰 후 merge 되면 Yona Author로 파일에 기록되며 작은 기념품을 보내드립니다.
  110. <br/>
  111. <a name="english"></a>[[한국어]](#korean)
  112. Yona
  113. =======
  114. Yona is a web-based project hosting software.
  115. What you can do with Yona:
  116. --
  117. Yona is designed to increase the speed and efficiency of team work and team development.
  118. - Issue tracker
  119. - Issues can be transferred to other projects
  120. - Issues' change histories can be viewed
  121. - Bulletin board
  122. - Embedded Git/SVN respository features
  123. - Pull requests & Block-based code review
  124. - Online Commits
  125. - LDAP support
  126. - Social login
  127. - Migration to/from other services or Yona instances
  128. - Github/Github Enterprise, Redmine, Yona
  129. Requirements
  130. ---
  131. - Java 8+
  132. - System Memory 2Gb+ (Recommendation: 4Gb+)
  133. Distribution
  134. ---
  135. Currently, There are two distribution types.
  136. #### MariaDB version
  137. - Recommended version
  138. - It takes a little effort to install DB, but it guarantees stable operation
  139. #### Embedded H2 DB version
  140. - Portable version that can be downloaded and run immediately.
  141. - Setting a DB is not required.
  142. - Also, can run the software directly from a USB device
  143. - Suitable for small teams (under 500 users).
  144. How to install
  145. ---
  146. Basically, Yona installation is in two steps:
  147. - [MariaDB install](docs/install-mariadb.md)
  148. - [Yona install](docs/install-yona-server.md)
  149. If you want to use [Docker](https://www.docker.com/), See https://github.com/pokev25/docker-yona by [pokev25](https://github.com/pokev25)
  150. Start/Upgrade/Backup/Trouble Shootings
  151. ---
  152. - [Start and Restart](docs/yona-run-and-restart.md)
  153. - [Start Options](docs/yona-run-options.md) for stable operation
  154. - [Upgrade](docs/yona-upgrade.md)
  155. - [Backup/Restore](docs/yona-backup-restore.md)
  156. - [Mail settings for Notification](docs/yona-mail-settings.md)
  157. - [Trouble Shootings](docs/trouble-shootings.md)
  158. Server Settings
  159. ---
  160. - [application.conf Settings](docs/application-conf-desc.md)
  161. - [Social Login Settings](docs/yona-social-login-settings.md)
  162. Migration
  163. ---
  164. - [Yona Export](https://github.com/yona-projects/yona-export)
  165. - Local backup
  166. - Move projects to another Yona instance
  167. - If you can match the format, anything can be imported into Yona
  168. - Github/Github Enterprise migration
  169. - [See here](https://github.com/yona-projects/yona/blob/master/conf/application.conf.default#L297)
  170. Google Analytics
  171. ---
  172. - Distributed Yona includes Google Analytics
  173. - This data is used for making us to improve Yona
  174. - If you want to disable this for any reason, set the following option to false in conf/application.conf file.
  175. ```
  176. application.send.yona.usage = true
  177. ```
  178. Contribution
  179. ---
  180. - The branch for contributions is `master`.
  181. - At first, fork the repository, then work on the `master` branch. And send a pull request to the`master` branch.
  182. - The `next` branch is for internal development. If you want to see what features are being added, please refer to the `next` branch.
  183. License
  184. --
  185. Copyright Yona Authors, NAVER Corp. and NAVER LABS under the Apache License, Version 2.0