From c2a5d4b0ee08cdb3e82adf82677ea7532350ff56 Mon Sep 17 00:00:00 2001 From: samlm Date: Thu, 20 Oct 2022 23:34:48 +0800 Subject: [PATCH] add: add SPONSOR_MESSAGE explain --- README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index d2ff800..b5ddefe 100644 --- a/README.md +++ b/README.md @@ -13,19 +13,20 @@ docker run -d --name looking-glass --restart always --network host wikihostinc/l - Can run docker (yes, only docker is required) ## Image Environment Variables -| Key | Example | Default | Description | -| ---- | ---- | ---- | ---- | -| HTTP_PORT | 80 | 80 | which HTTP port should use | -| SPEEDTEST_FILE_LIST | 100MB 1GB | 1MB 10MB 100MB 1GB | size of static test files, separate with space | -| PUBLIC_IPV4 | 1.1.1.1 | (fetch from http://ifconfig.co) | The IPv4 address of the server | -| PUBLIC_IPV6 | fe80::1 | (fetch from http://ifconfig.co) | The IPv6 address of the server| -| DISPLAY_TRAFFIC | true | true | Toggle the streaming traffic graph | -| ENABLE_SPEEDTEST | true | true | Toggle the speedtest feature | -| UTILITIES_PING | true | true | Toggle the ping feature | -| UTILITIES_TRACEROUTE | true | true | Toggle the traceroute feature | -| UTILITIES_IPERF3 | true | true | Toggle the iperf3 feature | -| UTILITIES_IPERF3_PORT_MIN | 30000 | 30000 | iperf3 listen port range - from | -| UTILITIES_IPERF3_PORT_MAX | 31000 | 31000 | iperf3 listen port range - to | +| Key | Example | Default | Description | +| ------------------------- | -------------------------------------- | ------------------------------- | --------------------------------------------------------------------------------------- | +| HTTP_PORT | 80 | 80 | which HTTP port should use | +| SPEEDTEST_FILE_LIST | 100MB 1GB | 1MB 10MB 100MB 1GB | size of static test files, separate with space | +| PUBLIC_IPV4 | 1.1.1.1 | (fetch from http://ifconfig.co) | The IPv4 address of the server | +| PUBLIC_IPV6 | fe80::1 | (fetch from http://ifconfig.co) | The IPv6 address of the server | +| DISPLAY_TRAFFIC | true | true | Toggle the streaming traffic graph | +| ENABLE_SPEEDTEST | true | true | Toggle the speedtest feature | +| UTILITIES_PING | true | true | Toggle the ping feature | +| UTILITIES_TRACEROUTE | true | true | Toggle the traceroute feature | +| UTILITIES_IPERF3 | true | true | Toggle the iperf3 feature | +| UTILITIES_IPERF3_PORT_MIN | 30000 | 30000 | iperf3 listen port range - from | +| UTILITIES_IPERF3_PORT_MAX | 31000 | 31000 | iperf3 listen port range - to | +| SPONSOR_MESSAGE | "Test message" or "/tmp/als_readme.md" | '' | Show server sponsor message (support markdown file, required mapping file to container) | ## Features