yona-projects / yona

Project Hosting SW

[English]

21세기 협업 개발 플랫폼

• DEMO: http://repo.yona.io (데모 서버는 2023년 6월 30일 종료합니다. 관련 안내)
• Official Site: http://yona.io

Yona?

• Git 저장소 기능이 내장된 설치형 이슈트래커
• Naver, Naver Labs 를 비롯하여 게임회사, 통신회사 고객센터, 공공기관, 투자사, 학교, 기업등에서 수년 간 실제로 사용되어 왔고 개선되어 온(Real world battled) 애플리케이션입니다

주요기능

• 서비스 종료나 데이터 종속 걱정없는 설치형
• 프로젝트 기반의 유연한 이슈트래커와 게시판
  • 편리한 프로젝트간 이슈 이동
  • 서브 태스크 이슈
  • 본문 변경이력 보기
  • 이슈 템플릿 기능
• 자체 내장된 코드 저장소
  • Git/SVN 선택 가능
  • 온라인 수정 및 커밋 지원
  • 프로젝트 멤버만 코드에 접근 가능 기능 등
• 블럭기반 코드리뷰
  • 코드 블럭 및 리뷰 스레드 지원
  • 리뷰 점수 지원
• 그룹 기능
  • 그룹 이슈 및 게시글 통합관리
  • 그룹 프로젝트, 그룹 멤버
• 한글 기반
  • 프로젝트 이름 및 그룹 이름에 한글을 사용가능
• LDAP 지원
  • LDAP 장애시에도 사용가능한 기능 제공
• 다른 제품이나 서비스로의 마이그레이션 기능 제공
  • Github/Github Enterprise, 또 다른 Yona 인스턴스, Redmine 등
• 로그인 관련 보안을 높일 수 있는 소셜로그인 지원

등을 비롯하여 일상적인 업무에서 SW 개발 전반에 필요한 다양한 기능을 포함하고 있습니다.

추가 읽을거리

• 왜 Yona를 써야 하나요? (Why Yona?)
• 기본 워크플로우

라이선스

Yona는 Apache 2.0 라이선스로 제공됩니다.

이어지는 설치 및 실행, 백업 등등에 대한 자세한 설명은 Wiki에 따로 세분화되어 정리되어 있습니다.

Yona 설치 및 실행

Yona 배포판

현재 Yona는 버전별로 두 개의 배포판을 릴리즈 메뉴를 통해 제공하고 있습니다.

• MariaDB 버전
  • 기본 권장 버전
  • yona-v1.11.0-bin.zip 같은 형식으로 파일로 배포
  • DB 설치에 약간의 시간이 필요하지만 안정적으로 운영이 가능
• H2 DB 내장형
  • DB 설정없이 내려받아서 바로 실행해서 쓸 수 있는 버전
  • yona-h2-v1.11.0-bin.zip 같은 형식으로 파일로 배포
  • USB 등에 담아서 이동해가면서 사용하거나 작업후 통째로 zip으로 묶어서 들고 다니는 것이 가능함
  • 대규모 사이트에서 사용하기에는 적합하지 않음. 참고: Yona가 MariaDB를 기본 DB로 사용하게 된 이유

Yona 설치

Yona는 크게 다음과 같은 2단계로 설치합니다.

• MariaDB 설치
• Yona 설치

Docker를 이용한 설치

Docker를 이용해 설치하실분은 pokev25 님의 https://github.com/pokev25/docker-yona 를 이용해주세요.

Amazon AWS 에 설치

https://okdevtv.com/mib/yona 에서 가이드를 볼 수 있습니다. by Kenu님

Yona 실행 및 업그레이드/백업 및 복구/문제 해결

• 실행 및 재시작 방법
• 안정적인 운영을 위한 실행 옵션들
• 업그레이드
• 백업 및 복구
• 알림메일 발송 기능 설정
• 발생 가능한 문제상황들과 해결방법

소스코드를 직접 내려 받아서 빌드하거나 자신만의 배포판을 만들기

자신의 입맛에 맛게 코드를 직접 수정해서 작업하거나 코드를 기여하고 싶을 경우에는 코드 저장소로부터 코드를 직접 내려받아서 빌드/실행하는 것도 가능합니다. 소스코드를 직접 내려 받아서 실행하기를 참고해 주세요

서버 관련 설정들

• application.conf 설명
• 소셜 로그인 설정

Google Analytics

• 기본적으로는 Google Analytics 가 활성화 되어 함께 배포됩니다.
• 설치형으로 제공되는 Yona의 특성상 제품이 지속적으로 개발/유지되기 위해서는 사용자들이 현재 어느정도 내려받아서 사용하고 있는지에 대한 정보가 필요합니다.
• 만약 이부분에 대해 도움을 주기 곤란한 경우 application.conf 에서 아래 항목을 false로 수정합니다.

application.send.yona.usage = true

마이그레이션

• 기본적으로 Yona 에서 Github/Github Enterprise 로 이전하는 기능을 제공합니다.
  • Yona에서 Github으로 이사가는 방법
  • 설정
• Yona Export
  • 프로젝트 로컬 백업
  • Yona 에서 다른 Yona 인스턴스로 이전 지원
    • 일명 '출장용 Yona 기능'이라고도 할 수 있는 하는 기능입니다.
      • DB내장형 경량 Yona인, [Yona H2 Embedded 버전]을 사용해서 출장/파견 나가서 작업하다가 작업 완료후에 Export 받아서 본점 Yona에 Import 하는 것이 v1.6.0부터 가능합니다.
  • Export 파일 포맷만 일치시킨다면 어떤 소스로부터도 마이그레이션이나 이동이 가능합니다

Contribution

• 코드 기여의 기준이 되는 브랜치는 master입니다.
• 저장소를 fork 한 다음 master 브랜치를 기준으로 작업하신다음 master 브랜치로 pull request를 보내주세요.
  • next브랜치는 내부 개발용입니다. 어떠한 기능들이 추가되고 있는지 현장을 보고 싶으시면 next브랜치를 참고해주세요.
• 코드리뷰 후 merge 되면 Yona Author로 파일에 기록되며 작은 기념품을 보내드립니다.

[한국어]

Yona

Yona is a web-based project hosting software.

What you can do with Yona:

Yona is designed to increase the speed and efficiency of team work and team development.

• Issue tracker
  • Issues can be transferred to other projects
  • Issues' change histories can be viewed
• Bulletin board
• Embedded Git/SVN respository features
• Pull requests & Block-based code review
• Online Commits
• LDAP support
• Social login
• Migration to/from other services or Yona instances
  • Github/Github Enterprise, Redmine, Yona

Requirements

• Java 8+
• System Memory 2Gb+ (Recommendation: 4Gb+)

Distribution

Currently, There are two distribution types.

MariaDB version

• Recommended version
• It takes a little effort to install DB, but it guarantees stable operation

Embedded H2 DB version

• Portable version that can be downloaded and run immediately.
  • Setting a DB is not required.
  • Also, can run the software directly from a USB device
• Suitable for small teams (under 500 users).

How to install

Basically, Yona installation is in two steps:

• MariaDB install
• Yona install

If you want to use Docker, See https://github.com/pokev25/docker-yona by pokev25

Start/Upgrade/Backup/Trouble Shootings

• Start and Restart
• Start Options for stable operation
• Upgrade
• Backup/Restore
• Mail settings for Notification
• Trouble Shootings

Server Settings

• application.conf Settings
• Social Login Settings

Migration

• Yona Export
  • Local backup
  • Move projects to another Yona instance
  • If you can match the format, anything can be imported into Yona
• Github/Github Enterprise migration
  • See here

Google Analytics

• Distributed Yona includes Google Analytics
• This data is used for making us to improve Yona
• If you want to disable this for any reason, set the following option to false in conf/application.conf file.

application.send.yona.usage = true

Contribution

• The branch for contributions is master.
• At first, fork the repository, then work on the master branch. And send a pull request to themaster branch.
  • The next branch is for internal development. If you want to see what features are being added, please refer to the next branch.

License

Copyright Yona Authors, NAVER Corp. and NAVER LABS under the Apache License, Version 2.0