Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 2.59 KB

README.md

File metadata and controls

73 lines (53 loc) · 2.59 KB
Raw

docker-WARProxy

wgcf + wireproxy + python-proxy and some useful scripts

Usage

version: "3"
services:
  warproxy:
    container_name: docker-warproxy
    image: ghcr.io/105pm/docker-warproxy:latest
    network_mode: bridge
    restart: always
    volumes:
      - <path for config files>:/config
    ports:
      - ${PORT_TO_EXPOSE}:${PROXY_PORT:-8008}
    environment:
      - PGID=${PGID}
      - PUID=${PUID}
      - PROXY_USER=${PROXY_USER}
      - PROXY_PASS=${PROXY_PASS}

To change license key

Simply set env WGCF_LICENSE_KEY and re-create the existing container or the service using docker-compose up -d warproxy. See more details here

Please also note that there is a maximum limit of 5 active devices linked to the same account at a given time.

Direct connection to wireproxy

As wireproxy is binding to socks5://0.0.0.0:8080, you can directly access it independently to the proxy running at front by publishing your container port 8080. It is highly recommended exposing the port for internal use only.

Environment variables

Basic

ENV Description Default
PUID / PGID uid and gid for running apps 911 / 911
TZ timezone Asia/Seoul

wgcf

ENV Description Default
WGCF_LICENSE_KEY native support by wgcf for changing license key
WGCF_DEVICE_NAME directly passed to wgcf binary to update device name, i.e. wgcf update ${WGCF_DEVICE_NAME}

python-proxy

ENV Description Default
PROXY_ENABLED set false to disable proxy true
PROXY_USER / PROXY_PASS required both to activate proxy authentication
PROXY_PORT to run proxy in a different port 8008
PROXY_VERBOSE simple access logging
PROXY_AUTHTIME re-auth time interval for same ip (second in string format) 0

warp+

ENV Description Default
WARP_PLUS set true to enable auto WARP+ quota script false
WARP_PLUS_VERBOSE set true to run auto WARP+ quota script in verbose mode false

warp+ is unlikely to work with a license key generated by wgcf. To use warp+, you should get a valid license key from the 1.1.1.1 app and set it to the environment variable WGCF_LICENSE_KEY. If you don't, the service won't be able to start.

Thanks