naver / yobi

Project hosting software - Deprecated
Apache License 2.0
379 stars 136 forks source link

[Deprecated]

이 프로젝트는 더 이상 유지보수 되거나 지원이 제공되지 않습니다.
새로운 이슈나 pull request를 받지 않습니다.

This project will no longer be maintained or supported.
Please do not file issues or pull-requests against this repo.

Yobi fork version인 Yona가 개인 프로젝트로 이어서 운영되고 있으니 참고 부탁드립니다.

=== [한국어] Yobi

Build Status

Yobi is a web-based project hosting software.

What is Yobi?

Yobi is a web-based project hosting software. To increase productivity and quality of your software Yobi offers many features including

License

Copyright 2015 NAVER Corp. under the Apache License, Version 2.0

How to install

Install from binary

Install

Download the latest version of Yobi from http://yobi.io/yobi.zip and unzip it. If you have wget and unzip:

wget http://yobi.io/yobi.zip
unzip yobi.zip

Start

Go the directory and start Yobi. If the directory is yobi-1.0.0:

cd yobi-1.0.0
bin/yobi

Note: If you are using Windows, run "bin/yobi.bat" instead of "bin/yobi".

Open http://127.0.0.1:9000 with your web browser then you can see the welcome page.

Upgrade

Download the latest version of Yobi and unzip it.

Note: Don't overwrite or delete yobi.h2.db file, repo & uploads directory!

Build from source

Check JDK version

java -version
javac -version

JDK version 7(1.7) or 8(1.8) is required.

Download Play Activator

curl -O http://downloads.typesafe.com/typesafe-activator/1.2.10/typesafe-activator-1.2.10-minimal.zip

or

wget http://downloads.typesafe.com/typesafe-activator/1.2.10/typesafe-activator-1.2.10-minimal.zip

or using web browser (for windows)

http://downloads.typesafe.com/typesafe-activator/1.2.10/typesafe-activator-1.2.10-minimal.zip

Unzip

unzip typesafe-activator-1.2.10-minimal.zip

Change directory to unzipped directory

cd activator-1.2.10-minimal

Download Yobi

Case1. using git client (recommended)

git clone https://github.com/naver/yobi.git

or

Case2. Just download latest stable release If you want to download one of the stable releases, you can download a compressed file by clicking the URL below. And then name it a yobi and unzip it.

https://github.com/naver/yobi/archive/master.zip

Caution! in case2, You might come across troubles when you try to upgrade Yobi.

You can locate your own Yobi directory in any other place. Please note that you must add Play Activator home path to $PATH environment in that case.

Change directory to cloned Yobi directory (or cd to your unzipped file directory)

cd yobi

Run Play Activator

../activator

or (for windows)

..\activator

Required files will be download automatically. In the first time, it may take about 10 min or more.

Type start command in console

start

It will downloaded addtional files and compile sources.

If you want to run Yobi in development mode, use run. You can see more detailed errors and can use dynamic compilation.

Connect with browser

http://127.0.0.1:9000

If you want to change port, check your permission to use 80 port. See 'Options' section for more information.

Upgrade Yobi

Case1. using git client (recommended) In installed directory, just type git update command.

git pull https://github.com/naver/yobi.git master

Case2. download zip file

In installed directory, download latest release file and unzip it.

https://github.com/naver/yobi/archive/master.zip

Be careful! Don't overwrite or delete yobi.h2.db file, repo & uploads directory!

If you are installing Yobi in Windows system, you may need set applyEvolutions.default Java property to true. See 'Options' section for more information

Options

When start yobi, You can specify the home directory to contain data for Yobi. If you want to use /home/user/.yobi as the home directory, set 'yobi.home' property as follows:

bin/yobi -Dyobi.home=/home/user/.yobi

Note: Yobi doesn't load the configuration files from the home directory. If you want to do that, specify the path to the config files as follows:

bin/yobi -Dyobi.home=/home/user/.yobi -Dconfig.file=/home/user/.yobi/conf/application.conf -Dlogger.file=/home/user/.yobi/conf/application-logger.xml

You can also specify Java options with _JAVA_OPTIONS environment variable. If the memory of your system equals to or greater than 4GB, we recommend to start Yobi as follows:

_JAVA_OPTIONS="-Xmx2048m -Xms2048m" activator "start -DapplyEvolutions.default=true -Dhttp.port=9000"

Linux and OSX

When start yobi, you can specify the home directory to contain data, the database file and configiuration files for Yobi. For example, if you want to use /home/user/.yobi as the home directory, set YOBI_HOME as follows:

YOBI_HOME=/home/user/.yobi bin/yobi

You can also specify Java options with _JAVA_OPTIONS environment variable. If the memory of your system equals to or greater than 4GB, we recommend to start Yobi as follows:

_JAVA_OPTIONS="-Xmx2048m -Xms2048m" bin/yobi

Yobi use 9000 port for HTTP connection by default. If you want to use another port, set http.port Java property.

_JAVA_OPTIONS="-Dhttp.port=80" bin/yobi

Windows

When start yobi, you can specify the data directory, the config file, the config file for logger with yobi.home, config.file and logger.file as follows:

SET JAVA_OPTS=-Dyobi.home=/home/user/.yobi -Dconfig.file=/home/user/.yobi/conf/application.conf -Dlogger.file=/home/user/.yobi/conf/application-logger.xml
bin\yobi.bat

You can specify the database file in application.conf as follows:

db.default.url="jdbc:h2:file:/home/nori/.yobi/yobi"

You can also specify Java options with _JAVA_OPTIONS environment variable. If the memory of your system equals to or greater than 4GB, we recommend to start Yobi as follows:

SET JAVA_OPTS=-Xmx2048m -Xms2048m
bin\yobi.bat

Yobi use 9000 port for HTTP connection by default. If you want to use another port, set http.port Java property.

_JAVA_OPTIONS=-Dhttp.port=80
bin\yobi.bat

If you are upgrading Yobi from the previous version, the upgrade may fail with a warning message that says you need migration as follows:

[warn] play - Your production database [default] needs evolutions!

In such case, set applyEvolutions.default Java property to true and restart Yobi.

SET JAVA_OPTS=-DapplyEvolutions.default=true
bin\yobi.bat

For more information about options

See http://www.playframework.com/documentation/2.3.6/Production.

Backup

Copy the below file and directories to another place.

file: yobi.h2.db
directory: repo, uploads




for korean

[English]

Yobi

협업 개발 플랫폼

Official Site: http://yobi.io

Yobi 소개

Yobi (구 nFORGE)는 협업 개발을 위한 프로젝트 호스팅 SW입니다.

등을 비롯하여 팀 개발을 위한 다양한 기능을 포함하고 있습니다.

라이선스

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

설치하기

다운받아 설치하기

설치

Yobi 최신 버전을 http://yobi.io/yobi.zip 에서 다운받아 압축을 풉니다. 예를 들어 wget으로 받아서 unzip으로 압축을 푼다면:

wget http://yobi.io/yobi.zip
unzip yobi.zip

실행

압축이 풀린 디렉토리로 이동해서 yobi를 실행합니다. 디렉토리가 yobi-1.0.0 이라면:

cd yobi-1.0.0
bin/yobi

주의: 윈도우 사용자는 bin/yobi 대신 bin/yobi.bat을 실행해야합니다.

이제 웹 브라우저로 http://127.0.0.1:9000 에 접속하면 환영 페이지를 보실 수 있습니다.

업그레이드

설치할 때와 똑같이, 최신 버전을 내려받아 Yobi가 설치된 디렉터리에 압축파일을 풉니다. 주의사항! yobi.h2.db 파일, repouploads 디렉터리를 삭제하거나 덮어쓰지 않도록 주의하세요!

소스 코드에서 빌드하기

JDK version 확인

java -version
javac -version

JDK 7(1.7) 혹은 8(1.8) 이어야 합니다.

Play Activator 내려 받기

curl -O http://downloads.typesafe.com/typesafe-activator/1.2.10/typesafe-activator-1.2.10-minimal.zip

혹은

wget http://downloads.typesafe.com/typesafe-activator/1.2.10/typesafe-activator-1.2.10-minimal.zip

웹 브라우저에서 (이를테면, MS윈도우즈 사용자일 경우)

http://downloads.typesafe.com/typesafe-activator/1.2.10/typesafe-activator-1.2.10-minimal.zip

압축풀기

unzip typesafe-activator-1.2.10-minimal.zip

압축을 푼 다음 하위 디렉터리로 이동

cd activator-1.2.10-minimal

Yobi 소스 내려 받기

case1. git 클라이언트를 이용한 다운로드 (추천)

git clone https://github.com/naver/yobi.git

case2. 단순히 최신 안정버전을 내려받고자 할 때는 아래 링크를 이용해서 압축파일을 내려받은 다음 yobi를 폴더이름으로해서 해제합니다.

git pull https://github.com/naver/yobi.git master

주의! case2의 경우, 업그레이드를 할 때 문제가 생길 수 있습니다.

임의의 장소에 Yobi 디렉터리를 위치시킬 경우에는 activator 실행파일이 있는 Play Activator 디렉터리를 $PATH 환경변수에 추가해 주세요.

clone 받은 Yobi 디렉터리로 이동

(혹은 압축을 해제한 디렉터리로 이동)

cd yobi

상단에 있는 activator 실행파일 실행

../activator

혹은 (윈도우 사용자일 경우)

..\activator

실행하면 필요한 파일들을 web에서 내려받습니다. 첫 실행시 네트워크 상황에 따라 10여분 가까이 소요될 수 있습니다.

콘솔이 뜨면 start 명령어로 기동

start

추가로 필요한 파일들을 web에서 내려받은 다음 소스 파일들을 컴파일 후 운영 모드(production mode)로 실행합니다. 개발 모드(development mode)로 실행하고자 할 경우에는 start 명령어 대신에 run 명령어로 실행합니다.

주의사항: 설정 파일 및 데이터가 기본적으로 target/universal/stage 디렉토리에 저장됩니다. 이 디렉토리는 activator clean 실행시 모두 삭제되므로, 아래의 옵션 설정방법을 보고 데이터가 저장될 디렉토리를 설정하시는 것이 좋습니다

브라우저로 접속

http://127.0.0.1:9000

80 포트 등으로 포트를 변경하고 싶을 경우에는 해당 포트가 사용가능한지 확인 한 다음 80 포트를 사용할 수 있는 계정으로 실행합니다. 포트 변경 방법에 대해서는 '옵션' 문단을 읽어주세요.

업그레이드 하기

case1. git 클라이언트를 이용 (추천) 설치된 디렉터리에서, 아래와 같은 git 명령어를 이용합니다

git pull https://github.com/naver/yobi.git master

case2. 압축파일을 내려받을 경우

설치된 디렉터리에서, 최신 릴리즈의 압축파일을 내려받아 Yobi가 설치된 디렉터리에 압축파일을 풉니다.

https://github.com/naver/yobi/archive/master.zip

주의사항! yobi.h2.db 파일, repouploads 디렉터리를 삭제하거나 덮어쓰지 않도록 주의하세요!

윈도에서 업그레이드하는 경우, -DapplyEvolutions.default=true 설정이 필요할 수 있습니다. 자세한 것은 아래 옵션 설정 설명을 보세요

옵션

Linux, OSX의 경우

YOBI_HOME 속성을 통해 Yobi가 데이터, 데이터베이스, 설정파일을 불러오고 저장할 홈 디렉토리를 지정할 수 있습니다. 예를 들어, /home/user/.yobi를 홈 디렉토리로 사용하려면 Yobi를 시작할 때 다음과 같이 지정합니다.

YOBI_HOME=/home/user/.yobi bin/yobi

_JAVA_OPTIONS 환경변수를 이용해 자바 환경 변수를 지정할 수도 있습니다. 시스템 메모리가 4기가 이상이라면, 다음과 같은 옵션으로 실행하는걸 권장합니다.

_JAVA_OPTIONS="-Xmx2048m -Xms2048m" bin/yobi

기본적으로 9000번 포트를 사용하지만, 다른 포트를 사용하고 싶다면 http.port 자바 환경변수를 수정합니다.

_JAVA_OPTIONS="-Dhttp.port=80" bin/yobi

Windows의 경우

Yobi를 시작할 때, 데이터 디렉토리, 설정파일, 로그 설정파일의 위치를 각각 yobi.home, config.file, logger.file 자바 프로퍼티로 지정할 수 있습니다.

SET JAVA_OPTS=-Dyobi.home=/home/user/.yobi -Dconfig.file=/home/user/.yobi/conf/application.conf -Dlogger.file=/home/user/.yobi/conf/application-logger.xml
bin\yobi.bat

데이터베이스가 저장될 파일은 다음과 같이 application.conf 설정 파일에서 지정할 수 있습니다.

db.default.url="jdbc:h2:file:/home/nori/.yobi/yobi"

_JAVA_OPTIONS 환경변수를 이용해 자바 환경 변수를 지정할 수도 있습니다. 시스템 메모리가 4기가 이상이라면, 다음과 같은 옵션으로 실행하는걸 권장합니다.

SET JAVA_OPTS=-Xmx2048m -Xms2048m
bin\yobi.bat

기본적으로 9000번 포트를 사용하지만, 다른 포트를 사용하고 싶다면 http.port 자바 환경변수를 수정합니다.

_JAVA_OPTIONS=-Dhttp.port=80
bin\yobi.bat

업그레이드를 하는 경우 다음과 같이 데이터베이스 스키마 마이그레이션이 필요하다는 경고 메시지와 함께 실행이 되지 않는 상황을 겪을 수 있습니다.

[warn] play - Your production database [default] needs evolutions!

그런 경우에는 자동으로 마이그레이션이 되도록 다음과 같이 applyEvolutions.default 자바 프로퍼티를 true로 설정합니다.

SET JAVA_OPTS=-DapplyEvolutions.default=true
bin\yobi.bat

옵션에 대한 더 자세한 설명

http://www.playframework.com/documentation/2.3.6/Production 부분을 확인해 주세요.

백업하기

특별히 외부 DB를 사용하지 않는다면 아래 내용을 잘 백업해서 보관해 주시면 됩니다.

file: yobi.h2.db
directory: repo, uploads