doc: README.md 내용 수정
- gogs -> gitea - 문법 경고 수정
This commit is contained in:
@@ -8,9 +8,9 @@ Docker-compose를 지원하는 모든 환경 (Windows 10 Pro 포함)
|
|||||||
|
|
||||||
Docker가 설치되지 않았다면 다음을 통해 설치합니다.
|
Docker가 설치되지 않았다면 다음을 통해 설치합니다.
|
||||||
|
|
||||||
* POSIX - https://docs.docker.com/install/ 을 통해 Docker를, https://docs.docker.com/compose/install/ 를 통해 Docker-compose를 설치합니다.
|
* POSIX - <https://docs.docker.com/install/> 을 통해 Docker를, <https://docs.docker.com/compose/install/> 를 통해 Docker-compose를 설치합니다.
|
||||||
|
|
||||||
* Windows 10 - https://docs.docker.com/docker-for-windows/install/ 를 통해 Docker Desktop on Windows 를 설치합니다. 회원 가입을 원하지 않는다면, https://download.docker.com/win/stable/Docker%20for%20Windows%20Installer.exe 를 통해 설치합니다.
|
* Windows 10 - <https://docs.docker.com/docker-for-windows/install/> 를 통해 Docker Desktop on Windows 를 설치합니다. 회원 가입을 원하지 않는다면, <https://download.docker.com/win/stable/Docker%20for%20Windows%20Installer.exe> 를 통해 설치합니다.
|
||||||
|
|
||||||
> ⚠️**주의**: Docker Desktop on Windows는 Virtual Box, VMWare와 잘 호환되지 않는 것으로 알려져 있습니다.
|
> ⚠️**주의**: Docker Desktop on Windows는 Virtual Box, VMWare와 잘 호환되지 않는 것으로 알려져 있습니다.
|
||||||
만약 Virtual Box나 Virtual Box를 이용하는 안드로이드 가상 머신을 이용할 경우 Docker Toolbox를 설치하십시오.
|
만약 Virtual Box나 Virtual Box를 이용하는 안드로이드 가상 머신을 이용할 경우 Docker Toolbox를 설치하십시오.
|
||||||
@@ -21,41 +21,42 @@ Docker가 설치되지 않았다면 다음을 통해 설치합니다.
|
|||||||
|
|
||||||
docker, docker-compose를 사용 가능한 상황임을 가정합니다.
|
docker, docker-compose를 사용 가능한 상황임을 가정합니다.
|
||||||
|
|
||||||
https://storage.hided.net/gogs/devsam/docker/archive/master.zip 링크를 통해 zip 파일을 다운받아 압축을 풉니다.
|
<https://storage.hided.net/gitea/devsam/docker/archive/master.zip> 링크를 통해 zip 파일을 다운받아 압축을 풉니다.
|
||||||
|
|
||||||
### 기본 설정
|
### 기본 설정
|
||||||
|
|
||||||
기본적으로 수정이 필요한 항목은 다음과 같습니다.
|
기본적으로 수정이 필요한 항목은 다음과 같습니다.
|
||||||
|
|
||||||
- `hidche/account.env` : 계정정보 설정, 공란으로 남겨진 공간을 적절하게 채웁니다.
|
* `hidche/account.env` : 계정정보 설정, 공란으로 남겨진 공간을 적절하게 채웁니다.
|
||||||
- Password에 해당하는 항목들은 가급적 어렵게 지어주십시오.
|
* Password에 해당하는 항목들은 가급적 어렵게 지어주십시오.
|
||||||
- 특히 `HIDCHE_PW_SALT`는 자동 설치 시 1회만 사용되므로 최대한 길고 어렵게 지어주십시오.
|
* 특히 `HIDCHE_PW_SALT`는 자동 설치 시 1회만 사용되므로 최대한 길고 어렵게 지어주십시오.
|
||||||
- `HIDCHE_KAKAO_REST_KEY`, `HIDCHE_KAKAO_ADMIN_KEY`는 [KakaoTalk REST API](https://developers.kakao.com/docs/restapi/kakaotalk-api)를 통해 발급 받을 수 있습니다. 동의 항목으로는 카카오계정(이메일), 카카오톡 메시지 전송이 필요합니다.
|
* `HIDCHE_KAKAO_REST_KEY`, `HIDCHE_KAKAO_ADMIN_KEY`는 [KakaoTalk REST API](https://developers.kakao.com/docs/restapi/kakaotalk-api)를 통해 발급 받을 수 있습니다. 동의 항목으로는 카카오계정(이메일), 카카오톡 메시지 전송이 필요합니다.
|
||||||
- `HIDCHE_IMAGE_REQUEST_KEY`는 이미지 서비스용 git과 게임 git repository를 연동하기위한 키입니다. 특히 이미지 서비스가 다른 서버에서 실행될 때 유용합니다. 이 값이 지정되지 않은 경우 `image/hook/git_pull.php`을 PHP CLI를 통해 직접 실행해야만 합니다.
|
* `HIDCHE_IMAGE_REQUEST_KEY`는 이미지 서비스용 git과 게임 git repository를 연동하기위한 키입니다. 특히 이미지 서비스가 다른 서버에서 실행될 때 유용합니다. 이 값이 지정되지 않은 경우 `image/hook/git_pull.php`을 PHP CLI를 통해 직접 실행해야만 합니다.
|
||||||
- `hidche/game.env` : 게임 설치 정보 설정 공간입니다. 값 하나를 변경해야 합니다.
|
|
||||||
- `HIDCHE_GAME_PATH` : 외부 유저가 접속할 수 있는 경로입니다. 공인 IP 주소나 도메인 주소를 사용한 주소로 꼭 변경해야합니다. 변경하지 않을 경우 설치는 되지만, 외부 유저가 이용할 수 없습니다. 명확한 이유가 있는게 아니라면 `/sam` 까지 붙여주십시오.
|
* `hidche/game.env` : 게임 설치 정보 설정 공간입니다. 값 하나를 변경해야 합니다.
|
||||||
- 이 주소를 이용하여 카카오 API의 로그인 Redirect URI를 설정해야 합니다. 주소가 https://sam.hided.net/sam 인 경우 https://sam.hided.net/sam/oauth_kakao/oauth.php 으로 입력합니다.
|
* `HIDCHE_GAME_PATH` : 외부 유저가 접속할 수 있는 경로입니다. 공인 IP 주소나 도메인 주소를 사용한 주소로 꼭 변경해야합니다. 변경하지 않을 경우 설치는 되지만, 외부 유저가 이용할 수 없습니다. 명확한 이유가 있는게 아니라면 `/sam` 까지 붙여주십시오.
|
||||||
- 포트 주소는 8080으로 지정되어있으며, 다른 포트로 바꾸고자 한다면 `hidche/docker-compose.yml`와 동일하게 유지해야 합니다.
|
* 이 주소를 이용하여 카카오 API의 로그인 Redirect URI를 설정해야 합니다. 주소가 <https://sam.hided.net/sam> 인 경우 <https://sam.hided.net/sam/oauth_kakao/oauth.php> 으로 입력합니다.
|
||||||
|
* 포트 주소는 8080으로 지정되어있으며, 다른 포트로 바꾸고자 한다면 `hidche/docker-compose.yml`와 동일하게 유지해야 합니다.
|
||||||
|
|
||||||
>Windows 환경에서 적절한 텍스트 에디터를 찾지 못하였다면 메모장에 해당 파일들을 드래그하여 수정하거나, [Notepad++](https://notepad-plus-plus.org/downloads/ )를 설치하여 수정하는 방법도 가능합니다.
|
>Windows 환경에서 적절한 텍스트 에디터를 찾지 못하였다면 메모장에 해당 파일들을 드래그하여 수정하거나, [Notepad++](https://notepad-plus-plus.org/downloads/ )를 설치하여 수정하는 방법도 가능합니다.
|
||||||
|
|
||||||
### 고급 설정
|
### 고급 설정
|
||||||
|
|
||||||
고급 설정이 필요하다면 다음을 수정합니다.
|
고급 설정이 필요하다면 다음을 수정합니다.
|
||||||
|
|
||||||
- `hidche/docker-compose.yml` : 설치 옵션입니다.
|
* `hidche/docker-compose.yml` : 설치 옵션입니다.
|
||||||
- `web/ports`: 8080 포트 대신 다른 포트를 선택하고자 할 경우 수정합니다. `hidche/game.env`의 내용도 변경해야합니다.
|
* `web/ports`: 8080 포트 대신 다른 포트를 선택하고자 할 경우 수정합니다. `hidche/game.env`의 내용도 변경해야합니다.
|
||||||
- `build/args` : nginx/www-data의 UID와 GID를 변경할 수 있습니다. `web`, `app`, `board` 셋을 동시에 지정해야합니다.
|
* `build/args` : nginx/www-data의 UID와 GID를 변경할 수 있습니다. `web`, `app`, `board` 셋을 동시에 지정해야합니다.
|
||||||
- `hidche/game.env`
|
* `hidche/game.env`
|
||||||
- `gameGitPath`, `imgGitPath`: 개발을 위해 다른 git repository를 사용해야한다면 수정합니다. ssh 주소인 경우 `hidche/app/id_ecdsa`와 `hidche/app/known_hosts` 또한 수정해야 합니다.
|
* `gameGitPath`, `imgGitPath`: 개발을 위해 다른 git repository를 사용해야한다면 수정합니다. ssh 주소인 경우 `hidche/app/id_ecdsa`와 `hidche/app/known_hosts` 또한 수정해야 합니다.
|
||||||
- `HIDCHE_IMAGE_USE_INTERNAL`, `HIDCHE_IMAGE_PATH`는 CDN 등 외부 이미지 경로를 사용할 경우 수정합니다.
|
* `HIDCHE_IMAGE_USE_INTERNAL`, `HIDCHE_IMAGE_PATH`는 CDN 등 외부 이미지 경로를 사용할 경우 수정합니다.
|
||||||
- 기타 적절한 용도에 맞게 수정하여 사용합니다.
|
* 기타 적절한 용도에 맞게 수정하여 사용합니다.
|
||||||
|
|
||||||
### Docker-compose 실행
|
### Docker-compose 실행
|
||||||
|
|
||||||
파일 설정이 모두 끝났다면, 콘솔에서 hidche 폴더로 이동하여 다음을 실행합니다.
|
파일 설정이 모두 끝났다면, 콘솔에서 hidche 폴더로 이동하여 다음을 실행합니다.
|
||||||
|
|
||||||
```
|
```bash
|
||||||
docker-compose up -d
|
docker-compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -63,4 +64,4 @@ docker-compose up -d
|
|||||||
|
|
||||||
설치 후, 게임을 이용할 수 있습니다.
|
설치 후, 게임을 이용할 수 있습니다.
|
||||||
|
|
||||||
게시판으로 Rhymix를 설치할 수 있도록 다운로드하며 설치 완료 된 주소에 `/board`를 붙여 게시판 설정을 마무리합니다.
|
게시판으로 Rhymix를 설치할 수 있도록 다운로드하며 설치 완료 된 주소에 `/board`를 붙여 게시판 설정을 마무리합니다.
|
||||||
|
|||||||
Reference in New Issue
Block a user