From 4960e12ee60bb7f387938681e68e7923aead4bf4 Mon Sep 17 00:00:00 2001 From: hide_d Date: Sun, 15 Sep 2019 15:28:51 +0000 Subject: [PATCH] =?UTF-8?q?README=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/README.md b/README.md index 643a50e..f45d4b1 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,62 @@ 삼국지 모의전투 HiDCHe를 Docker, Docker-compose를 이용한 환경에서 설치할 수 있도록 지원하는 공간입니다. +## 지원환경 + +Docker-compose를 지원하는 모든 환경 (Windows 10 Pro 포함) + +Docker가 설치되지 않았다면 다음을 통해 설치합니다. + +* POSIX - https://docs.docker.com/install/ 을 통해 Docker를, https://docs.docker.com/compose/install/ 를 통해 Docker-compose를 설치합니다. + +* Windows 10 Pro 이상 - 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와 잘 호환되지 않는 것으로 알려져 있습니다. +만약 Virtual Box나 Virtual Box를 이용하는 안드로이드 가상 머신을 이용할 경우 Docker Toolbox를 설치하십시오. + +* Windows 7, Windows 10 Home - https://github.com/docker/toolbox/releases 를 통해 Docker Toolbox를 설치합니다. https://docs.docker.com/toolbox/toolbox_install_windows/ 에 설치 안내가 있습니다. + +세가지 모두 docker run hello-world 와 docker-compose --version 명령이 동작하면 설치가 완료된 것입니다. + +## 설치 + +docker, docker-compose를 사용 가능한 상황임을 가정합니다. + +https://storage.hided.net/gogs/devsam/docker/archive/master.zip 링크를 통해 zip 파일을 다운받아 압축을 풉니다. + +### 기본 설정 + +기본적으로 수정이 필요한 항목은 다음과 같습니다. + + - hidche/account.env : 계정정보 설정, 공란으로 남겨진 공간을 적절하게 채웁니다. + - Password에 해당하는 항목들은 가급적 어렵게 지어주십시오. + - HIDCHE_KAKAO_REST_KEY, HIDCHE_KAKAO_ADMIN_KEY는 [KakaoTalk REST API](https://developers.kakao.com/docs/restapi/kakaotalk-api)를 통해 발급 받을 수 있습니다. 동의 항목으로는 카카오계정(이메일), 카카오톡 메시지 전송이 필요합니다. + - hidche/game.env : 게임 설치 정보 설정 공간입니다. 값 하나를 변경해야 합니다. + - HIDCHE_GAME_PATH : 외부 유저가 접속할 수 있는 경로입니다. 공인 IP 주소나 도메인 주소를 사용한 주소로 꼭 변경해야합니다. 변경하지 않을 경우 설치는 되지만, 외부 유저가 이용할 수 없습니다. 명확한 이유가 있는게 아니라면 /sam 까지 붙여주십시오. + - 이 주소를 이용하여 카카오 API의 [로그인 Redirect URI](https://developers.kakao.com/apps/192309/settings/user#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/download/v7.7.1.html)를 설치하여 수정하는 방법도 가능합니다. + +### 고급 설정 + +고급 설정이 필요하다면 다음을 수정합니다. + + - hidche/docker-compose.yml : 설치 옵션입니다. + - web/ports: 8080 포트 대신 다른 포트를 선택하고자 할 경우 수정합니다. hidche/game.env의 내용도 변경해야합니다. + - hidche/game.env + - gameGitPath, imgGitPath: 개발을 위해 다른 git repository를 사용해야한다면 수정합니다. ssh 주소인 경우 hidche/app/id_ecdsa와 hidche/app/known_hosts 또한 수정해야 합니다. + - HIDCHE_IMAGE_USE_INTERNAL, HIDCHE_IMAGE_PATH는 CDN 등 외부 이미지 경로를 사용할 경우 수정합니다. + - 기타 적절한 용도에 맞게 수정하여 사용합니다. + +### Docker-compose 실행 + +파일 설정이 모두 끝났다면, 콘솔에서 hidche 폴더로 이동하여 다음을 실행합니다. + +``` +docker-compose up -d +``` + +총 5개의 컨테이너 hidche_app_1, hidche_db_1, hidche_web_1, hidche_cron_1, hidche_install_1가 실행되며, hidche_install_1는 설치후 종료됩니다. + +설치 후, 게임을 이용할 수 있습니다. \ No newline at end of file