You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
xit-ntri/REF/deploy/ntri/README.v0.2.html

205 lines
7.5 KiB
HTML

<!DOCTYPE html []>
<html>
<head>
<meta charset="UTF-8" />
<meta name="author" content="MarkdownViewer++" />
<title>README.md</title>
<style type="text/css">
/* Avoid page breaks inside the most common attributes, especially for exports (i.e. PDF) */
td, h1, h2, h3, h4, h5, p, ul, ol, li {
page-break-inside: avoid;
}
</style>
</head>
<body>
<h1 id="section">시작하기</h1>
<hr />
<p>세외수입개별시스템(Non-Tax Revenue Individual System) 은 <br />
과태료 부과에 대한 실시간 API 4종(부과결과/부과취소/수납정보/감액정보)을 지원 하며, <br />
API 4종의 데이터는 세외수입시스템측에서 제공 한다.</p>
<ul>
<li>출발지: 세외수입시스템</li>
<li>목적지: 개별시스템(ntri)</li>
</ul>
<h3 id="section-1">버전관리</h3>
<table>
<thead>
<tr>
<th>버전</th>
<th>작성일</th>
<th>작성자</th>
<th>내용</th>
</tr>
</thead>
<tbody>
<tr>
<td>v0.1</td>
<td>2022.12.20</td>
<td>박민규</td>
<td>최초작성</td>
</tr>
<tr>
<td>v0.2</td>
<td>2022.12.21</td>
<td>박민규</td>
<td>"2. SSL 인증서 발급" 내용 수정( 발급방식 변경: 스크립트 -&gt; 실행파일(.bat) )</td>
</tr>
<tr>
<td>v0.2</td>
<td>2022.12.21</td>
<td>박민규</td>
<td>%NTRI_APP_HOME%/bin/setenv.bat 파일의 <mark>"DB/SSL설정" 수정</mark><mark>VM옵션" 환경변수 추가</mark></td>
</tr>
</tbody>
</table>
<h2 id="section-2">1. 배포하기</h2>
<ol>
<li>
<strong>원하는 경로에 ntri.zip 압축파일을 unzip</strong> 한다.</li>
<li>
<em>%NTRI_APP_HOME%/bin/setenv.bat</em> 파일을 열어 <strong>배포환경에 맞게 환경변수를 수정</strong> 한다.
<ul><li>NTRI_JAVA_HOME 및 SSL/DB 설정 등..</li></ul></li>
<li>
<em>%NTRI_APP_HOME%/bin/service-regist.bat</em> 파일을 <strong>"관리자권한" 으로 실행</strong></li>
<li>
<em>%NTRI_APP_HOME%/webapp</em> 디렉토리에 <strong>"ntri-0.0.1-SNAPSHOT.jar" 파일 복사</strong></li>
<li>
<em>%NTRI_APP_HOME%/bin/service-start.bat</em> 파일을 실행하여 "서비스 시작"
<ul><li>서비스 실행 오류가 발생할 경우 <em>%NTRI_APP_HOME%/logs/stderr.log</em> 내용 확인</li></ul></li>
<li>
<em>%NTRI_APP_HOME%/bin/service-logprint.bat</em> 파일을 실행하여 "서비스 실시간 로그" 확인</li>
</ol>
<h2 id="ssl">2. SSL 인증서 발급</h2>
<ol>
<li>OpenSSL 다운로드(<a href="https://sourceforge.net/projects/openssl">https://sourceforge.net/projects/openssl</a>)
<ul><li>openssl-1.0.2j-fips-x86_64/openssl-1.0.2j-fips-x86_64.zip</li></ul></li>
<li>다운로드한 압축파일을 unzip 후 <strong>OpenSSL 디렉토리를 C드라이브(C:/) 밑으로 복사</strong></li>
<li>
<em>%NTRI_APP_HOME%/ssl/bin</em> 디렉토리의 <strong>"generate-ssl-cert-new.bat" 파일 실행</strong><br /><strong>[ 파일 설명 ]</strong><ul><li>신규 발급: <em>generate-ssl-cert-new.bat</em><ul><li>인증서파일 <code>모두</code> 발급(key, csr, crt)</li></ul></li><li>재발급: <em>generate-ssl-cert-refresh.bat</em><ul><li>인증서파일 <code>일부</code>만 발급(csr, crt)</li></ul></li></ul></li>
<li>
<em>%NTRI_APP_HOME%/ssl/cert</em> 디렉토리에 <strong>인증서파일(key,csr,crt) 이 생성</strong>되었는지 <strong>확인</strong></li>
</ol>
<h2 id="api">3. API 테스트</h2>
<ol>
<li>
<strong>"~/bin/test"</strong> 디렉토리로 이동</li>
<li>테스트 배치파일(.bat) 실행하여 API 호출
<ul><li>일괄: <em>curl-all.bat</em></li><li>부과취소: <em>curl-LevyCancel.bat</em></li><li>부과결과: <em>curl-LevyResult.bat</em></li><li>수납정보: <em>curl-RcivInfo.bat</em></li><li>감액정보: <em>curl-RdcamtInfo.bat</em></li></ul></li>
</ol>
<h1 id="section-3">부록</h1>
<hr />
<h3 id="section-4">디렉토리 구성</h3>
<table>
<thead>
<tr>
<th>Directory</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>%NTRI_APP_HOME%/webapp</td>
<td>어플리케이션 jar 파일이 위치한 디렉토리</td>
</tr>
<tr>
<td>%NTRI_APP_HOME%/bin</td>
<td>서버기동과 관련한 배치파일(.bat)이 위치한 디렉토리</td>
</tr>
<tr>
<td>%NTRI_APP_HOME%/bin/test</td>
<td>API 테스트 배치파일(.bat)이 위치한 디렉토리</td>
</tr>
<tr>
<td>%NTRI_APP_HOME%/bin/logs</td>
<td>어플리케이션 로그파일(.log)이 저장되는 디렉토리(startup.bat 직접 호출 시)</td>
</tr>
<tr>
<td>%NTRI_APP_HOME%/logs</td>
<td>어플리케이션 로그파일(.log)이 저장되는 디렉토리(윈도우 서비스 사용 시)</td>
</tr>
<tr>
<td>%NTRI_APP_HOME%/ssl/bin</td>
<td>SSL 인증서 신규/재발급을 위한 배치파일(.bat)이 위치한 디렉토리</td>
</tr>
<tr>
<td>%NTRI_APP_HOME%/ssl/cert</td>
<td>발급된 SSL 인증서가 저장되는 디렉토리</td>
</tr>
<tr>
<td>%NTRI_APP_HOME%/ssl/cert/backup</td>
<td>SSL 인증서 신규/재발급 시마다 발급된 인증서가 백업되는 디렉토리</td>
</tr>
<tr>
<td>%NTRI_APP_HOME%/curl-7.86.0_2-win64-mingw</td>
<td>curl 커맨드를 사용하기 위한 실행프로그램</td>
</tr>
</tbody>
</table>
<h3 id="section-5">파일 설명</h3>
<table>
<thead>
<tr>
<th>File Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>setenv.bat</td>
<td>
<code>환경변수</code> 설정</td>
</tr>
<tr>
<td>service-regist.bat</td>
<td>서비스 <code>등록</code></td>
</tr>
<tr>
<td>service-edit.bat</td>
<td>등록한 서비스정보 <code>수정</code></td>
</tr>
<tr>
<td>service-delete.bat</td>
<td>등록한 서비스 <code>삭제</code></td>
</tr>
<tr>
<td>service-start.bat</td>
<td>등록한 서비스 <code>실행</code></td>
</tr>
<tr>
<td>service-stop.bat</td>
<td>등록한 서비스 <code>중지</code></td>
</tr>
<tr>
<td>service-status.bat</td>
<td>등록한 서비스 실행 <code>상태</code> 확인</td>
</tr>
<tr>
<td>service-logprint.bat</td>
<td>등록한 서비스 <code>실시간 로그</code> 출력</td>
</tr>
<tr>
<td>startup.bat</td>
<td>서버 <code>기동</code></td>
</tr>
<tr>
<td>shutdown.bat</td>
<td>서버 <code>종료</code></td>
</tr>
<tr>
<td>logprint.bat</td>
<td>
<code>실시간 로그</code> 출력</td>
</tr>
</tbody>
</table>
<h3 id="section-6">실행 환경</h3>
<ul>
<li>Java 버전: JDK11 이상</li>
<li>Tomcat 버전: Tomcat9 이상</li>
<li>JDBC: ojdbc8.jar</li>
</ul>
</body>
</html>