Install Hackle Proxy

Using Docker

If Docker is not installed, refer to the Install Docker document to install Docker first, then continue below.

1. Run Docker Standalone

1.1 Download Docker Image

Use the following command to download the Hackle Proxy image.

docker pull hackle/proxy

1.2 Run Hackle Proxy

You can run Hackle Proxy using the following command.

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

Run Hackle Proxy by specifying the SDK Key. You can find the SDK Key in the SDK Keys document.

You can enter up to 4 SDK Keys using , as a separator.

1.3 Verify Installation

curl http://localhost:8888/hello

2. Using Docker Compose

2.1 Write the Script

If you are using Docker Compose, you can run it by writing docker-compose.yml as follows.

version: '3.1'

services:

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

Run Hackle Proxy by specifying the SDK Key. You can find the SDK Key in the SDK Keys document.

You can enter up to 4 SDK Keys using , as a separator.

2.2 Run

docker-compose up -d

3. Other

3.1 Minimum Requirements

The Proxy is implemented to run on low-spec hardware. However, for performance reasons, the following minimum specs are recommended:

• CPU: 1 core

• Memory: 1GB

4. Troubleshooting

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

If you encounter the above issue when starting Docker, add the following option:

--ulimit nofile=1024:1024

If you are not using Docker

If Docker is not installed, a Proxy available without Docker is currently being prepared. Refer to the Install Docker document to install Docker and then use the Proxy.