1장. 설치방법

• Window 사용자의 경우
• Production DB 생성과 .env.dabory 의 이해
• 다보리 DB API 와 DB 연결 방법
• Docker에 설치하는 방법
• 웹서버/웹호스팅에 설치하는 방법
• 더미테마(Dummy-Theme)설치 방법
• 운영테마(Production-Theme)설치방법
• Dabory Linux 서버 SSH를 통한 로그인 방법
• xampp를 통한 설치방법
• [window] WSL 사용시 주의사항

Window 사용자의 경우

설치 방법에 앞서 윈도우 환경에서 작업하는 경우 주의사항에 대해 말씀드립니다.

1. 공통사항

1. 현재 설정 확인하기

Windows 환경에서 Git의 기본 설정인 core.autocrlf는 true로 설정되어 있습니다.

이 설정이 true일 경우, Git 서버에서 소스를 받아올 때 CRLF 형식으로 자동 변환됩니다.

아래 명령어를 입력하여 core.autocrlf 설정을 확인하세요:

git config --get core.autocrlf

2. 설정 변경하기

만약 core.autocrlf가 true로 설정되어 있다면, 다음 명령어를 통해 설정을 변경합니다:

git config --global core.autocrlf input

이 설정은 Git 서버에 Push할 때 LF를 CRLF로 자동 변환하지 않도록 합니다.

3. Push 전 설정 확인

Push하기 전에 반드시 위 설정을 확인하고 진행해야 합니다.

dabory git repository에 push할 때 window 환경에서는 git 설정에 core.autocrlf의 기본값이 true로 설정되어 있습니다.

만약 true로 되어 있다면 git server에서 소스를 받아왔을 때 CRLF로 자동 변환됐을 겁니다.

git config --get core.autocrlf

위 명령어를 통해 설정을 확인하고 core.autocrlf가 true로 설정되어 있다면 다음 명령어를 통해 설정을 변경해줍니다.

git config --global core.autocrlf input

위 설정은 git server에 push할때 LF -> CRLF로 자동변환하지 않도록 해줍니다.

push 하기 전 반드시 위 설정을 확인하고 push 해야 합니다.

Production DB 생성과 .env.dabory 의 이해

.env.dabory 파일의 이해

다보리 프론트엔드에서는 Laravel의 환경설정 파일인 .env 파일을 확장하여, 백엔드 API 서버와의 연동을 위해 추가적인 설정 파일인 .env.dabory를 사용합니다. 이 파일은 메인 API 서버와 여러 서브 API 서버 간의 연동을 관리하는 데 필요한 변수를 포함하고 있습니다.

 1. 백엔드 API와 연동

.env.dabory 파일은 백엔드 API 서버와의 연동을 위한 설정 파일입니다.

API 서버와 DB 서버에 따라 이 파일의 설정이 달라집니다.

 2. 프론트엔드와 백엔드 연동 과정

프론트엔드에서 .env.dabory 파일에 있는 변수들을 Sodium 라이브러리를 통해 암호화된 형태로 참조합니다.

이 정보들을 사용하여 API 서버에 요청을 보내면, 서버는 게이트 토큰을 반환하게 됩니다.

 3. env.dabory의 주요 변수 설명

• *_API_URL: 연동할 API 서버의 URL과 포트 번호.
• *_API_CLIENT_ID: API 클라이언트 ID.
• *_API_CLIENT_SECRET: API 클라이언트 비밀키.
• *_API_BEFORE_BASE64: API 키 쌍을 Base64로 인코딩한 값.

 .env.dabory 파일 생성 방법

1. Dabory SSO (링크)에 접속합니다.

2. 우측 상단 회원등록 버튼을 통해 회원가입합니다.

3. 로그인합니다.

4. My App을 클릭합니다.

5. 좌측 메뉴에서 App Manager를 클릭합니다.

6. 우측 상단의 List 옆 화살표 버튼을 클릭 -> 레코드 추가 버튼을 클릭

7. 붉은색 박스와 노란색박스를 차례대로 작성합니다.

1. generate new keys 클릭
2. db 정보 모두 입력후에 저장버튼 반드시
3. 생성된 env.dabory 파일을 서버에서 변경

API Host:Port : 개발서버

13.124.2.254:3306 개발db

 

 

Api Keys

App Type : 앱의 타입을 선택합니다.

App Name: 앱의 이름을 입력합니다. 예제에서는 테마의 이름대로 eyemsg라고 지정하였습니다.

Redirect URI or App Domain URL(without SSO function)* :

dabory sso 로그인시 연결될 callback url을 입력합니다. 예시 이미지에 입력된URI에서 도메인만 변경하여 입력해줍니다.

Client ID: 자동생성됩니다.

Client Secret : 자동생성됩니다.

Public Key : Generate New Keys 버튼 클릭시 생성됩니다.

Keypair : Generate New Keys 버튼 클릭시 생성됩니다.

Information to create .env.dabory (You should TEST DB Conn with srdbm2 before this procedure)

API HOST:Port : select 박스를 클릭하여 개발서버로 지정합니다.

DB Host:Port : 실제 db host를 입력합니다.

DB User : db user 계정을 입력합니다.

DB Name : db의 name을 입력합니다.

DB Password : db의 password를 입력합니다.

모두 입력하셨다면 Create and Download .env.dabory file => Make sure Save after Creation 버튼을 클릭합니다.

* db 접속정보는 개발자님께 제공됩니다.

8. .env.dabory 파일이 생성되었습니다.

9. 편집기를 통해 생성된 파일이 열어 내용을 확인합니다.

10. 파일명을 .env.dabory로 변경합니다.

11. 이제 .env.dabory 파일생성이 완료되었습니다.

.env.dabory 파일은 다보리 컴포저블을 설치할 때 사용할 수 있습니다.

참고 및 주의사항

• App Mannager에 등록된 app을 등록한 뒤 사용하시다가 내용을 임의로 수정해서는 안됩니다.
• 수정을 원하시는 경우 담당자에게 문의해주세요.

다보리 DB API 와 DB 연결 방법

해당사항은 먼저 2장 Restfull api의 구성 1번 메뉴얼을 숙지하시고 확인해주시기 바랍니다.

2장 1번 메뉴얼에서 언급한바와 같이 clientId와 beforebase64가 담긴 json type의 데이터를 통해 API 서버를 호출하게되면 api 서버에서 response로 gate token을 생성하여 반환합니다.

이 gate token은 .env.dabory 파일 생성시 입력된 db 접속정보가 암호화되어 있기 때문에 .env.dabory 파일에 설정이 되어 있고 App Manger에 등록되어 있다면 반환받은 gate-token을 통해 연동된 db api에 연결이 가능합니다.

Docker에 설치하는 방법

설치전 준비사항

1. dabory git server에 사용자를 등록합니다. (다보리 git server 바로가기)

2. .env와 .env.dabory 파일에 대해서 숙지하고 세팅해주세요.

참고자료

• .env.dabory 설정하기
• .env 설정하기

3. docker 설치를 위해 다보리 깃서버에서 php-docker 레포지토리로 이동합니다. (해당 레포지토리에 접근권한이 없을 경우 요청해야 합니다.)

php-docker란?

다보리 컴포저블의 php 버전별 설정파일, 설치매뉴얼, 및 dockerfile, yml 파일 등이 포함되어 있습니다.

php-docker 레포지토리 바로가기

3-1. HTTP url을 복사해줍니다.

3-2. git clone을 통해 php-docker 소스를 가져옵니다.

git clone http://git.daboryhost.com:10880/dabory/php-docker.git

3-3. php-docker 파일 안에 있는 레퍼런스 문서를 숙지한뒤 설치를 진행합니다.

---

Docker를 통한 설치방법

예제는 윈도우 환경에서 설치를 진행하였습니다.

1. 다보리 컴포저블을 설치할 경로로 이동합니다.

cd d:/test

D 드라이브의 "test" 폴더를 생성하여 설치를 진행하겠습니다.

2. 설치전 준비사항에서 clone해놨던 php-docker 파일 안에 php-docker 파일을 복사하여 가져옵니다.

3. 레퍼런스 파일을 참고하여 자신의 php 버전에 맞춰 docker파일과 ini 파일을 세팅합니다. (버전에 맞지 않는 설정 파일들은 삭제해도 무방합니다.)

4. docker-compose.yml 파일은 프로젝트의 루트 경로에 위치하도록 붙여넣어줍니다.

5. 다보리 깃서버에서 dbrerp 레포지토리로 이동합니다. (해당 레포지토리에 접근권한이 없을 경우 요청해야 합니다.)

dbrerp 레포지토리 바로가기

6. HTTP url을 복사해줍니다.

7. 다보리 컴포저블을 설치할 d:/test 디렉토리에서 git clone 명령어를 통해 dbrerp 소스를 가져옵니다.

git clone http://git.daboryhost.com:10880/dabory/dbrerp.git

8. ls 명령어를 통해 clone이 잘되었는지 확인합니다.

d:/test 경로에 아래와 같이 세개의 파일 및 디렉토리가 존재해야 합니다.

7.  dbrerp/dabory 경로로 이동합니다.

cd dbrerp/dabory

ls 명령어를 통해 확인해보면 para 파일만 존재합니다.

8. 이제 테마폴더를 설치해야 합니다. 아래 링크를 클릭하여 테마폴더를 설치해주시기 바랍니다.

테마폴더 설치하기

9. 테마폴더까지 설치가 완료됐다면 dbrerp의 하위경로에 vendor 파일과 storage 파일이 필요합니다.

9-1. dbrerp 경로로 이동하여 아래 명령어를 입력합니다.

composer install

10. dbrerp/vendor와 dbrerp/storage 파일이 생성된 것을 확인하고 설치한 도메인에 접근하여 확인합니다.

웹서버/웹호스팅에 설치하는 방법

설치전 준비사항

0. dabory git server에 사용자를 등록합니다. (다보리 git server 바로가기)

1. .env  파일

2. .env.dabory 파일

3. php와 mariadb의 설치 

참고자료

• 리눅스 서버접근 방법
• .env.dabory 설정하기
• .env 설정하기

웹서버/웹호스팅을 통한 설치방법

1. ssh을 통해 웹서버에 접근합니다.

2. 설치할 디렉토리를 생성하고 해당 디렉토리로 이동합니다.

3. 예제에서는 eyemsg 라는 테마폴더를 설치할 것이기 때문에 설치 경로에 아래와 같이 디렉토리를 구성하겠습니다.

• eyemsg.daboryhostcom
• kloxoscript
• public_html

각 디렉토리에 대한 설명은 아래에서 진행하겠습니다

4. 다보리 git 서버에서 mybin 레포지토리로 접속합니다. (mybin 바로가기)

5. HTTP url을 복사합니다.

6. 설치경로에서 git clone을 통해 mybin을 받아옵니다.

git clone http://git.daboryhost.com:10880/dabory/mybin

이제 다음과 같이 디렉토리들이 구성되었습니다.

5. eyemsg.daboryhost.com 디렉토리로 이동합니다.

cd eyemsg.daboryhost.com

6. 다보리 깃서버에 dbrerp 레포지토리로 접속합니다.

7. HTTP url을 복사해줍니다.

8. git clone 명령어를 통해 dbrerp 소스를 가져옵니다.

git clone http://git.daboryhost.com:10880/dabory/dbrerp.git

9. 아래 명령어를 통해 dbrerp의 하위 경로에 있는 모든 파일들을 eyemsg.daboryhost.com의 하위 경로로 이동시킵니다

mv dbrerp/* .

10. 사전에 준비해두었던 .env 파일과 .env.dabory 파일을 생성한뒤 내용을 붙여넣어줍니다.

이 부분이 숙지가 안되었다면 위 참고자료를 통해 env와 env.dabory 파일을 세팅해주세요.

vi .env
vi .env.dabory

11. dabory 디렉토리로 이동합니다.

cd dabory

12. 아래 링크를 클릭하여 theme 폴더를 설치한뒤 13번부터 진행해주시기 바랍니다.

테마폴더 설치하기

13. 다보리 git 서버의 vendor 레포지토리로 접속합니다.

14. git clone을 통해 vendor 소스를 가져옵니다.

git cloen http://git.daboryhost.com:10880/dabory/vendor.git

15. storage 관련 Update 예정

16. eyemsg.daboryhost.com으로 접근하면 다음과 같이 설치가 완료되었습니다.

 참고자료

• 홈페이지 위젯 설정하기
• 홈페이지 

더미테마(Dummy-Theme)설치 방법

.env 항목에서 DBR_THEME 변수에 erponly를 넣어줍니다. erponly는 테마는 /pro로 들어오는 경로로 들어오는 모든 트래픽을 user page로 redirection시켜주는 테마입니다.

/dabory/themes 디렉토리로 이동한뒤 git clone erponly url 명령어를 통해 theme 소스코드를 가져옵니다. 반드시 변수의 이름과 테마 폴더 이름을 변수 값으로 동기화해야 합니다. 디렉토리 관련해서는composer 디렉토리에 autoload_psr4 파일에 각 디렉토리들을 namespace로 구성하여 관리되고 있으니 참고하시기 바랍니다.

운영테마(Production-Theme)설치방법

• 운영테마(Production-Theme)설치방법

.env파일에서 ERP_THEME, PRO_THEME 변수를 찾아 확인합니다. 변수의 이름과 테마 폴더 이름을 변수 값으로 동기화해야 합니다. /themes/pro 폴더 임폴트 (수정 예정)

Dabory Linux 서버 SSH를 통한 로그인 방법

준비물

1. .ussh 파일 (ssh를 통해 편리하게 접근하기 위한 셸 스크립트 파일입니다.) 

2. dbr_list.txt 파일 (개발자가 직접 생성합니다.)

2-1. 아래 내용을 입력합니다. 

#서버코드                           #IP                            #설치지역
dbr02=13.124.2.254           #erics-and-kloxo

* dbr02서버는 예시입니다. 서버가 다를 수 있기 때문에 미리 확인하시고 진행하시기 바랍니다.

2-2. ussh 파일이 있는 디렉토리에서 dbr_list.txt 라는 이름으로 텍스트 파일을 생성하고 2-1의 내용을 붙여넣어줍니다.

---

ussh를 통한 서버 접근방법

1. ussh 파일이 준비되었다면 해당위치로 이동합니다.

2. 아래 명령어를 통해 서버에 접근합니다.

./ussh dbr02 eyemsg
# ./ussh 서버이름 계정명

xampp를 통한 설치방법

설치전 준비사항

1. xampp 링크를 통해 xampp를 다운로드합니다.

2. More Downloads 클릭

3. 자신의 OS에 맞는 버전을 선택합니다. 예제는 window 버전으로 설치하겠습니다.

4. 7.3 ~8.0 까지의 php 버전을 호환하는 버전을 설치합니다. 예제는 7.3.33버전을 설치하겠습니다.

5. 포터블 버전이 아닌 일반 버전의 installer.exe를 클릭하여 설치합니다.

6. 다운로드된 설치파일을 클릭하여 설치를 진행합니다.

7. env/env.dabory 파일 세팅

• env.dabory 설정하기
• .env 설정하기

---

xampp를 통한 설치방법

window 기준으로 설치를 진행한 예제입니다.

1. XAMPP Control Pannel을 관리자권한으로 실행합니다.

2. xampp는 기본 80포트 / 443 포트로 실행됩니다. 포트 충돌이 일어난다면 httpd.conf / httpd-ssl.conf / Config에서 포트를 변경해줍니다.

3. Apache 서버를 실행합니다. 만약 실행이 안된다면 아래와 같이 화살표버튼을 클릭하여 Apache를 재설치합니다.

4. 서버가 실행되었다면 터미널을 열어줍니다.

5. 

5. 아래 명령어를 통해  다보리 컴포터블의 dbrerp를 받아옵니다.

cd htdocs
git clone http://git.daboryhost.com:10880/dabory/dbrerp.git

6. 아래 명령어를 통해 필요한 파일들을 받아옵니다.

# vendor
cd dbrerp
git clone http://git.daboryhost.com:10880/dabory/vendor.git

# erponly
cd dabory
mkdir themes
git clone http://git.daboryhost.com:10880/dbrerp-themes/erponly.git

7. 이제 localhost:port번호로 접근합니다.

8. 만약 특정 에러가 발생한다면 

- env 혹은 env.dabory 파일 확인

- vendor 혹은 storage 파일 확인

- xampp apache 서버의 설정파일 확인 (public 경로설정)

- 테마폴더의 존재 및 위치 확인

위 사항들을 체크해보시기 바랍니다.

[window] WSL 사용시 주의사항

준비사항

• wsl 배포판에 git이 설치되어 있어야합니다.

git clone시 주의사항

• WSL의 파일 시스템은 Windows와 분리되어 있으므로, Windows와 Linux 파일 시스템 간의 경로 차이를 유의해야 합니다.
• 만약 git clone 중 오류가 발생하면, 오류 메시지를 확인하고 해결 방법을 찾습니다. 특히 파일 이름이나 경로와 관련된 오류는 Linux에서의 파일 이름 규칙을 고려해야 합니다.
  

 

wsl에서 git clone 혹은 git push 명령어를 실행했을 경우 파일권한 issue가 있습니다.

이경우 다음과 같은 방법으로 설정을 추가해주시기 바랍니다.

 

1. wsl 배포판의 루트경로에서 아래 명령어로 wsl.conf 파일로 진입합니다.

sudo nano /etc/wsl.conf

2. 아래 설정을 추가합니다.

[automount]

options = "metadata"

3. 아래 명령어로 wsl을 종료후 restart 합니다.

wsl --shoutdown 

4. git clone을 통해 원격저장소의 소스를 가져옵니다.

5. 파일권한을 확인합니다.

ls -l

일반적으로 wsl을 이용하여 git clone 혹은 git push시 모든 디렉토리 및 파일 premission이 777로 변경됩니다.

git clone후 파일권한이 변경되는지 확실히 체크후 변경되지 않을 경우 git clone / push 명령어를 사용해주시기 바랍니다.