Docker를 사용하는 경우

만약 Docker가 설치되어있지 않은 경우, Docker 설치하기 문서를 참고하여 Docker 설치 후 아래 부분을 진행해 주세요.

1. Docker 단독 실행

1.1 Docker Image 다운로드

아래의 명령어를 사용하여, Hackle Proxy 이미지를 다운 받습니다.

docker pull hackle/proxy

1.2 Hackle Proxy 실행

아래의 명령어를 통해 Hackle Proxy를 실행 할 수 있습니다.

docker run -d \
			-e SDK_KEYS=YOUR_SDK_KEY \
			-p 8888:8888 \
			--name hackle-proxy \
			hackle/proxy

SDK 키를 지정하여 Hackle Proxy 를 실행합니다. SDK 키는 SDK에서 사용되는 키 문서를 통해 확인하실 수 있습니다.

SDK Key는 , 구분자를 활용하여 최대 4개까지 입력할 수 있습니다.

1.3 설치 확인

curl http://localhost:8888/hello

2 Docker-Compose 사용

2.1 Script 작성

Docker compose를 사용하는 경우 아래와 같이 docker-compose.yml 를 작성하여 실행할 수 있습니다.

version: '3.1'

services:

  hackle-proxy:
    image: hackle/proxy
    ports:
      - 8888:8888
    environment:
      SDK_KEYS: YOUR_SDK_KEY

SDK Key를 지정하여 Hackle Proxy 를 실행합니다. SDK 키는 SDK에서 사용되는 키 문서를 통해 확인하실 수 있습니다.

SDK Key는 , 구분자를 활용하여 최대 4개까지 입력할 수 있습니다.

2.2 실행

docker-compose up -d

3. 기타

3.1 최소 요구사항

Proxy는 낮은 사양에서 구동할 수 있도록 구현되어 있습니다. 하지만 성능을 위해 최소 아래와 같은 사양을 추천드립니다.

• Cpu : 1 core
• Memory : 1GB

4. Troubleshooting

library initialization failed - unable to allocate file descriptor table - out of memory

Docker 구동 시 위와 같은 문제가 발생하면 아래 옵션을 추가해주세요.

--ulimit nofile=1024:1024

Docker를 사용하지 않는 경우

Docker 미 설치 시, 사용가능 한 Proxy는 현재 준비 중 입니다. Docker 설치하기 문서를 참고하여 Docker를 설치 후 Proxy를 사용할 수 있습니다.