ZeroProxy is a multi target http/websocket proxy.

• Support http/https proxy
• Support ws/wss proxy
• Response use json for multiple requests.

Configuration

app_config.yml

It's application configuration file.

# Server port
port:
  proxy_http: 55550
  proxy_ws: 55551
  api_http: 55552

proxy_http_config.yml

It's proxy http configuration file.

# Example-1
- location: /helios_pub
  connect_timeout: 3000
  idle_timeout: 3000
  targets:
    - http://127.0.0.1:55402

# Example-2
- location: /helios_api
  connect_timeout: 3000
  idle_timeout: 3000
  targets:
    - http://127.0.0.1:55403
    - http://127.0.0.1:55403

# Example-3
- location: /thumbly_api
  connect_timeout: 3000
  idle_timeout: 3000
  targets:
    - http://127.0.0.1:57911

proxy_ws_config.yml

It's proxy websocket configuration file.

# Example-1
- location: /helios_pub
  targets:
    - ws://127.0.0.1:55401

logback.xml

It's Logback configuration file that is famous logging library.

• You can send error log to Telegram.
  1. Uncomment Telegram configuration.
  2. Set value of <botToken> and <chatId>.

     <appender name="TELEGRAM" class="com.github.paolodenti.telegram.logback.TelegramAppender">
         <botToken></botToken>
         <chatId></chatId>
         ...
     </appender>

  3. Insert <appender-ref ref="TELEGRAM"/> into <root>

     <root level="WARN">
         <appender-ref ref="FILE"/>
         <appender-ref ref="TELEGRAM"/>
     </root>

• You can send error log to Slack.
  1. Uncomment Slack configuration.
  2. Set value of <webhookUri>.

     <appender name="SLACK_SYNC" class="com.github.maricn.logback.SlackAppender">
         <webhookUri></webhookUri>
         ...
     </appender>

  3. Insert <appender-ref ref="SLACK"/> into <root>

     <root level="WARN">
         <appender-ref ref="FILE"/>
         <appender-ref ref="SLACK"/>
     </root>

• You can reload configuration but need not to restart application.

Server

ZeroProxy has three servers. One is a http proxy server, another is a websocket proxy server, and the other is a restful API server. Restful API server provide application information and additional functions.

Main HTTP Server

Usage

http://example.com:{port}/{location}/{path}
ws://example.com:{port}/{location}/{path}

• port
  • Server port
  • It's proxy_http and proxy_ws in app_config.yml.
• location
  • Location
  • It's location in proxy_config.yml
• path
  • Target path

Example

http://example.com:55550/zeroproxy/example/test.png

API HTTP Server

Usage

http://example.com:{port}/{domain}/{method}

Example

http://example.com:57911/app/status
http://example.com:57911/app/hello
http://example.com:57911/app/ping

API

GET /app/env

• Get application environments

Response

{
  "data":{
    "applicationVersion": "1.4.0",
    "hostname": "hostname",
    "osVersion": "10.11.6",
    "jarFile": "code13k-zeroproxy-1.0.0-alpha.1.jar",
    "javaVersion": "1.8.0_25",
    "ip": "192.168.0.121",
    "javaVendor": "Oracle Corporation",
    "osName": "Mac OS X",
    "cpuProcessorCount": 4
  }
}

GET /app/status

• Get application status

Response

{
  "data":{
    "threadInfo":{...},
    "cpuUsage": 2.88,
    "threadCount": 25,
    "currentDate": "2018-10-02T01:15:21.290+09:00",
    "startedDate": "2018-10-02T01:14:40.995+09:00",
    "runningTimeHour": 0,
    "vmMemoryUsage":{...}
  }
}

GET /app/hello

• Hello, World

Response

{"data":"world"}

GET /app/ping

• Ping-Pong

Response

{"data":"pong"}