Installation Guide

본 장에서는 D-Works 설치를 위해 필요한 제반사항과 기동 방법에 대하여 설명합니다.

Required

Node

D-Works는 8 버전 이상의 Node를 요구합니다.

하단의 명령어를 통해 8 버전 이상의 node, npm이 설치되어 있는지 확인할 수 있습니다. 기본 방법으로 기동 시, 내부적으로 npm 명령어를 사용합니다. npm은 일반적으로 node와 함께 설치됩니다.

$ node -v
$ npm -v

참고

Node 버전별 호환성 테스트는 각 버전의 LTS(Long Term Support) 버전을 기준으로 테스트되었습니다.

(node 8 lts/carbon, node 10 lts/dubnium, node 12 lts/erbium, node 14 lts/fermium, node 16 lts/gallium, node 18 lts/hydrogen, node 20 lts/iron, node 22 lts/jod)

Java

D-Works는 8 버전 이상의 Java를 요구합니다.

하단의 명령어를 통해 해당 환경에 설치되어 있는 Java 버전을 확인할 수 있습니다.

$ java -version

주의

단, Java 17 이상에서 패키지명을 Java가 아닌 Jakarta로 제공하는 경우에는 정상 동작하지 않을 수 있습니다.

---

설치 방법

D-Works에서는 제한적인 데이터베이스 운용 환경을 고려하여 오직 D-Works 운용에 필요한 요소들만 포함하고 있는 웹 서버를 포함하고 있습니다. 이를 통해 사용자는 단 2개의 명령어 실행으로 간편하고 최소화된 설치를 진행할 수 있습니다.

D-Works는 zip 압축파일 형태로 배포됩니다. 해당 파일의 압축을 해제하면 다음과 같은 구조의 디렉토리를 확인하실 수 있습니다.

dworks
ㄴ INSTALL_GUIDE.md
ㄴ cli.sh
ㄴ node_modules
ㄴ server.js
ㄴ stop.sh
ㄴ cli-migration.properties.eg
ㄴ client
ㄴ package.json
ㄴ start.sh
ㄴ tup-server.jar

해당 디렉터리에서 start.sh 스크립트를 다음과 같이 실행하여 D-Works를 기동할 수 있습니다.

. ./start.sh

...
tup-server started (PID: 21220)
client server started (PID: 21221)
Metadata saved at /dist/dworks/.migration-service.meta
...

D-Works가 기동되면 http://{HOST_ADDRESS}:{CLIENT_PORT}에 브라우저를 통해 접속하여 정상 기동여부를 확인할 수 있습니다.

해당 디렉터리에서 stop.sh 스크립트를 다음과 같이 실행하여 D-Works를 종료할 수 있습니다.

. ./stop.sh

...
Stopping client server (PID: 21221)
...
Stopping tup-server (PID: 21220)
...

참고

D-Works는 사용자의 환경에 따라 기본 웹 서버를 사용하지 않고 별도의 방법으로 구성할 수도 있습니다. D-Works는 기본적으로 서버에 해당하는 jar 파일과 클라이언트(Web)을 제공하기 위한 정적 파일들로 구성되어 있습니다. 따라서, Jar 파일을 직접 실행하고 정적 리소스를 Apache, Nginx 등 별도의 웹 서버를 활용하여 구축할 수도 있으나 이에 대한 설치 방법을 공식적으로 지원하지는 않습니다.

또한, D-Works는 CLI 모드를 추가로 지원합니다. 이에 대한 설명은 CLI 모드 가이드에서 확인하실 수 있습니다.

---

클라이언트 포트 수정

만약, D-Works에서 설정한 기본 포트인 13227을 변경하고자 할 경우에는 server.js의 CLIENT_PORT를 원하는 port로 수정할 수 있습니다.

const BUILD_DIR = path.join(__dirname, "client"); // React 빌드 폴더
const CLIENT_PORT = 13227; // 해당 부분의 13227을 원하는 포트번호로 수정

신규 버전 패치

D-Works는 단일 클라이언트 어플리케이션이 아닌 Web, Server로 이루어진 제품으로서 별도의 자동 패치 툴을 제공하지는 않습니다. 따라서, 신규 버전을 사용하기 위해서는 다음 가이드를 따라야 합니다.

배포 디렉터리에서 D-Works를 최초 기동하면 repodb.mv.db라는 파일이 생성되고 관리됩니다. 새로운 배포판을 사용할 경우에는 최초 기동 전, 기존 배포 디렉터리에서 stop.sh를 실행하여 서비스를 종료하고 repodb.mv.db를 신규 배포판에 옮긴 후 기동하면 기존의 내용을 그대로 이관할 수 있습니다.