Skip to content

Commit 77c51bf

Browse files
committed
Update Readme
1 parent 9c9e574 commit 77c51bf

File tree

3 files changed

+45
-25
lines changed

3 files changed

+45
-25
lines changed

README.md

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ Feel free to bookmark the demo or deploy your own.
3030

3131
## 👀 Main Features
3232

33-
* 🖥️ **View Your IPs**: Detects and displays your local IPs, sourcing from multiple IPv4 and IPv6 providers.
33+
* 🛜 **View Your IPs**: Detects and displays your local IPs, sourcing from multiple IPv4 and IPv6 providers.
34+
* 🔍 **Search IP Information**: Provides a tool for querying information about any IP address.
3435
* 🕵️ **IP Information**: Presents detailed information for all IP addresses, including country, region, ASN, geographic location, and more.
3536
* 🚦 **Availability Check**: Tests the accessibility of various websites, such as Google, GitHub, YouTube, ChatGPT, and others.
3637
* 🚥 **WebRTC Detection**: Identifies the IP address used during WebRTC connections.
@@ -43,9 +44,13 @@ Feel free to bookmark the demo or deploy your own.
4344
* 🚧 **Censorship Check**: Check if a website is blocked in some countries.
4445
* 📓 **Whois Search**: Perform whois information search for domain names or IP addresses
4546
* 📀 **MAC Lookup**: Query information of a physical address
47+
* 🖥️ **Browser fingerprints**:Multiple ways to caculate your browser fingerprint
48+
* 📋 **Cybersecurity checklist**:A comprehensive cybersecurity checklist with a total of 258 items
49+
50+
## 💪 Also
51+
4652
* 🌗 **Dark Mode**: Automatically toggles between dark and daylight modes based on system settings, with an option for manual switching.
4753
* 📱 **Minimalist Mode**: A mobile-optimized mode that shortens page length for quick access to essential information..
48-
* 🔍 **Search IP Information**: Provides a tool for querying information about any IP address.
4954
* 📲 **PWA Supported**:Can be added as a desktop app on your phone as well as a Chrome app on your computer.
5055
* ⌨️ **Keyboard Shortcuts**: Supports keyboard shortcuts for all functions, press `?` to view the shortcut list.
5156
* 🌍 Based on availability test results, it indicates whether global internet access is currently feasible.
@@ -89,25 +94,30 @@ docker run -d -p 18966:18966 --name myip --restart always jason5ng32/myip:latest
8994

9095
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:
9196

92-
| Variable Name | Required | Default Value | Description |
93-
| --- | --- | --- | --- |
94-
| `BACKEND_PORT` | No | `"11966"` | The running port of the backend part of the program |
95-
| `FRONTEND_PORT` | No | `"18966"` | The running port of the frontend part of the program |
96-
| `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) |
97-
| `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 |
98-
| `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 |
99-
| `GOOGLE_MAP_API_KEY=` | No | `""` | API Key for Google Maps, used to display the location of the IP on a map |
100-
| `ALLOWED_DOMAINS` | No | `""` | Allowed domains for access, separated by commas, used to prevent misuse of the backend API |
101-
| `IPCHECKING_API_KEY` | No | `""` | API Key for IPCheck.ing, used to obtain accurate IP geolocation information |
102-
| `IPINFO_API_TOKEN` | No | `""` | API Token for IPInfo.io, used to obtain IP geolocation information through IPInfo.io |
103-
| `IPAPIIS_API_KEY` | No | `""` | API Key for IPAPI.is, used to obtain IP geolocation information through IPAPI.is |
104-
| `KEYCDN_USER_AGENT` | No | `""` | The domain name when using KeyCDN, must contain https prefix. Used to obtain IP address information through KeyCDN |
105-
| `CLOUDFLARE_API` | No | `""` | API Key for Cloudflare, used to obtain AS system information through Cloudflare |
106-
| `MAC_LOOKUP_API_KEY` | No | `""` | API Key for MAC Lookup, used to obtain MAC address information |
107-
| `VITE_GOOGLE_ANALYTICS_ID` | **Yes** | `""` | Google Analytics ID, used to track user behavior |
108-
| `VITE_CURL_IPV4_DOMAIN` | No | `""` | Provides the IPv4 domain for the CURL API to users |
109-
| `VITE_CURL_IPV6_DOMAIN` | No | `""` | Provides the IPv6 domain for the CURL API to users |
110-
| `VITE_CURL_IPV64_DOMAIN` | No | `""` | Provides the dual-stack domain for the CURL API to users |
97+
<table>
98+
<thead>
99+
<tr>
100+
<th>Variable Name</th>
101+
<th>Required</th>
102+
<th>Default Value</th>
103+
<th>Description</th>
104+
</tr>
105+
</thead>
106+
<tbody>
107+
<tr>
108+
<td style="white-space: nowrap;"><code>BACKEND_PORT</code></td>
109+
<td style="white-space: nowrap;">No</td>
110+
<td style="white-space: nowrap;"><code>"11966"</code></td>
111+
<td style="white-space: nowrap;">The running port of the backend part of the program</td>
112+
</tr>
113+
<tr>
114+
<td style="white-space: nowrap;"><code>FRONTEND_PORT</code></td>
115+
<td style="white-space: nowrap;">No</td>
116+
<td style="white-space: nowrap;"><code>"18966"</code></td>
117+
<td style="white-space: nowrap;">The running port of the frontend part of the program</td>
118+
</tr>
119+
</tbody>
120+
</table>
111121

112122
Note that if any of the CURL series environment variables are missing, the CURL API will not be enabled.
113123

README_FR.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ Notes: Vous pouvez utiliser ma démo gratuitement et vous pouvez également la d
3030

3131
## 👀 Principales fonctionnalités
3232

33-
* 🖥️ **Afficher vos adresses IP** : Détecte et affiche votre adresse IP locale, provenant de plusieurs fournisseurs IPv4 et IPv6.
33+
* 🛜 **Afficher vos adresses IP** : Détecte et affiche votre adresse IP locale, provenant de plusieurs fournisseurs IPv4 et IPv6.
34+
* 🔍 **Recherche d'informations sur l'adresse IP** : Fournit un outil pour interroger des informations sur n'importe quelle adresse IP.
3435
* 🕵️ **Informations sur l'adresse IP** : Présente des informations détaillées pour toutes les adresses IP, y compris le pays, la région, l'ASN, la localisation géographique, et plus encore.
3536
* 🚦 **Vérification de disponibilité** : Teste l'accessibilité de différents sites web, tels que Google, GitHub, YouTube, ChatGPT, et d'autres.
3637
* 🚥 **Détection WebRTC** : Identifie l'adresse IP utilisée lors des connexions WebRTC.
@@ -43,9 +44,13 @@ Notes: Vous pouvez utiliser ma démo gratuitement et vous pouvez également la d
4344
* 🚧 **Test de Censorship**: Vérifier si un site est bloqué dans certains pays.
4445
* 📓 **Recherche Whois** : Effectuer une recherche d'informations Whois pour les noms de domaine ou les adresses IP
4546
* 📀 **Recherche MAC** : Requête d'informations d'une adresse physique
47+
* 🖥️ **Empreinte digitale du navigateur**: Plusieurs façons de visualiser l'empreinte digitale de votre navigateur
48+
* 📋 **Liste de contrôle de cybersécurité**:: Une liste de contrôle complète de la cybersécurité avec un total de 258 éléments
49+
50+
## 💪Également
51+
4652
* 🌗 **Mode sombre** : Bascule automatiquement entre les modes sombre et clair en fonction des paramètres du système, avec une option de basculement manuel.
4753
* 📱 **Mode minimaliste** : Un mode optimisé pour les mobiles qui réduit la longueur de la page pour un accès rapide aux informations essentielles.
48-
* 🔍 **Recherche d'informations sur l'adresse IP** : Fournit un outil pour interroger des informations sur n'importe quelle adresse IP.
4954
* 📲 **Prise en charge de PWA** : Peut être ajouté en tant qu'application de bureau sur votre téléphone ainsi qu'en tant qu'application Chrome sur votre ordinateur.
5055
* ⌨️ **Raccourcis clavier** : Prend en charge les raccourcis clavier pour toutes les fonctions, appuyez sur `?` pour afficher la liste des raccourcis.
5156
* 🌍 Basé sur les résultats des tests de disponibilité, il indique si l'accès Internet mondial est actuellement réalisable.

README_ZH.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030

3131
## 👀 主要功能
3232

33-
* 🖥️ **看自己的 IP**:从多个 IPv4 和 IPv6 来源检测显示本机的 IP
33+
* 🛜 **看自己的 IP**:从多个 IPv4 和 IPv6 来源检测显示本机的 IP
34+
* 🔍 **查任意 IP 信息**:可以通过小工具查询任意 IP 的信息
3435
* 🕵️ **看 IP 信息**:显示所有 IP 的相关信息,包括国家、地区、ASN、地理位置等
3536
* 🚦 **可用性检测**:检测一些网站的可用性:Google, Github, Youtube, 网易, 百度等
3637
* 🚥 **WebRTC 检测**:查看使用 WebRTC 连接时使用的 IP
@@ -43,9 +44,13 @@
4344
* 🚧 **封锁测试**:检查特定的网站在部分国家是否被封锁
4445
* 📓 **Whois 查询**:对域名或 IP 进行 whois 信息查询
4546
* 📀 **MAC 地址查询**:查询物理地址的归属信息
47+
* 🖥️ **浏览器指纹**:多种方式查看浏览器指纹
48+
* 📋 **网络安全检查清单**:一共有 258 项的,全面的网络安全检查清单
49+
50+
## 💪 同时还支持
51+
4652
* 🌗 **暗黑模式**:根据系统设置自动切换暗黑/白天模式,也可以手动切换
4753
* 📱 **简约模式**:为移动版提供的专门模式,缩短页面长度,快速查看最重要的信息
48-
* 🔍 **查任意 IP 信息**:可以通过小工具查询任意 IP 的信息
4954
* 📲 **支持 PWA**:可以添加为手机应用以及电脑里的桌面应用,方便使用
5055
* ⌨️ **支持快捷键**:可以随时输入 `?` 查看快捷键菜单
5156
* 🌍 根据可用性检测结果,返回目前是否可以访问全世界网络的提示

0 commit comments

Comments
 (0)