From 75752103ca9830631d5d03cd6c9434b74fa44ff5 Mon Sep 17 00:00:00 2001 From: jason5ng32 Date: Wed, 1 Jan 2025 09:54:57 +0800 Subject: [PATCH] Update Readme --- README.md | 47 +++++++++++++++++++++-------------------------- 1 file changed, 21 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 05f0c8bb..8afdb52e 100644 --- a/README.md +++ b/README.md @@ -44,8 +44,8 @@ Feel free to bookmark the demo or deploy your own. * 🚧 **Censorship Check**: Check if a website is blocked in some countries. * 📓 **Whois Search**: Perform whois information search for domain names or IP addresses * 📀 **MAC Lookup**: Query information of a physical address -* 🖥️ **Browser fingerprints**：Multiple ways to caculate your browser fingerprint -* 📋 **Cybersecurity checklist**：A comprehensive cybersecurity checklist with a total of 258 items +* 🖥️ **Browser Fingerprints**：Multiple ways to caculate your browser fingerprint +* 📋 **Cybersecurity Checklist**：A comprehensive cybersecurity checklist with a total of 258 items ## 💪 Also @@ -94,30 +94,25 @@ docker run -d -p 18966:18966 --name myip --restart always jason5ng32/myip:latest You can use the program without adding any environment variables, but if you want to use some advanced features, you can add the following environment variables: - - - - - - - - - - - - - - - - - - - - - - - -
Variable NameRequiredDefault ValueDescription
BACKEND_PORTNo"11966"The running port of the backend part of the program
FRONTEND_PORTNo"18966"The running port of the frontend part of the program
+| Variable Name | Required | Default Value | Description | +| --- | --- | --- | --- | +| `BACKEND_PORT` | No | `"11966"` | The running port of the backend part of the program | +| `FRONTEND_PORT` | No | `"18966"` | The running port of the frontend part of the program | +| `SECURITY_RATE_LIMIT` | No | `"0"` | Controls the number of requests an IP can make to the backend server every 60 minutes (set to 0 for no limit) | +| `SECURITY_DELAY_AFTER` | No | `"0"` | Controls the first X requests from an IP every 20 minutes that are not subject to speed limits, and after X requests, the delay will increase | +| `SECURITY_BLACKLIST_LOG_FILE_PATH` | No | `"logs/blacklist-ip.log"` | Path setting. Records the list of IPs that triggered the limit after SECURITY_RATE_LIMIT is enabled | +| `GOOGLE_MAP_API_KEY=` | No | `""` | API Key for Google Maps, used to display the location of the IP on a map | +| `ALLOWED_DOMAINS` | No | `""` | Allowed domains for access, separated by commas, used to prevent misuse of the backend API | +| `IPCHECKING_API_KEY` | No | `""` | API Key for IPCheck.ing, used to obtain accurate IP geolocation information | +| `IPINFO_API_TOKEN` | No | `""` | API Token for IPInfo.io, used to obtain IP geolocation information through IPInfo.io | +| `IPAPIIS_API_KEY` | No | `""` | API Key for IPAPI.is, used to obtain IP geolocation information through IPAPI.is | +| `KEYCDN_USER_AGENT` | No | `""` | The domain name when using KeyCDN, must contain https prefix. Used to obtain IP address information through KeyCDN | +| `CLOUDFLARE_API` | No | `""` | API Key for Cloudflare, used to obtain AS system information through Cloudflare | +| `MAC_LOOKUP_API_KEY` | No | `""` | API Key for MAC Lookup, used to obtain MAC address information | +| `VITE_GOOGLE_ANALYTICS_ID` | **Yes** | `""` | Google Analytics ID, used to track user behavior | +| `VITE_CURL_IPV4_DOMAIN` | No | `""` | Provides the IPv4 domain for the CURL API to users | +| `VITE_CURL_IPV6_DOMAIN` | No | `""` | Provides the IPv6 domain for the CURL API to users | +| `VITE_CURL_IPV64_DOMAIN` | No | `""` | Provides the dual-stack domain for the CURL API to users | Note that if any of the CURL series environment variables are missing, the CURL API will not be enabled.