jason5ng32/myip repository overview

⁠🧰 MyIP - A Better IP Toolbox

⁠👀 Main Features

• 🛜 View Your IPs: Detects and displays your local IPs, sourcing from multiple IPv4 and IPv6 providers.
• 🔍 Search IP Information: Provides a tool for querying information about any IP address.
• 🕵️ IP Information: Presents detailed information for all IP addresses, including country, region, ASN, geographic location, and more.
• 🚦 Availability Check: Tests the accessibility of various websites, such as Google, GitHub, YouTube, ChatGPT, and others.
• 🚥 WebRTC Detection: Identifies the IP address used during WebRTC connections.
• 🛑 DNS Leak Test: Shows DNS endpoint data to evaluate the risk of DNS leaks when using VPNs or proxies.
• 🚀 Speed Test：Test your network speed with edge networks.
• 🚏 Proxy Rule Testing: Test the rule settings of proxy software to ensure their correctness.
• ⏱️ Global Latency Test: Performe lantency tests on servers located in different regions around the world.
• 📡 MTR Test: Perform MTR tests on servers located in different regions around the world.
• 🔦 DNS Resolver: Performs DNS resolution of a domain name from multiple sources and obtains real-time resolution results that can be used for contamination determination.
• 🚧 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

⁠💪 Also

• 🌗 Dark Mode: Automatically toggles between dark and daylight modes based on system settings, with an option for manual switching.
• 📱 Minimalist Mode: A mobile-optimized mode that shortens page length for quick access to essential information..
• 📲 PWA Supported：Can be added as a desktop app on your phone as well as a Chrome app on your computer.
• ⌨️ Keyboard Shortcuts: Supports keyboard shortcuts for all functions, press ? to view the shortcut list.
• 🌍 Based on availability test results, it indicates whether global internet access is currently feasible.
• 🇺🇸 🇨🇳 🇫🇷 🇹🇷 English, Chinese, French, and Turkish support.

⁠📕 How to Use

⁠Deploying in a Node Environment

Make sure you have Node.js installed.

Clone the code:

git clone https://github.com/jason5ng32/MyIP.git

Install and build:

npm install && npm run build

Run:

npm start

The program will run on port 18966.

⁠Using Docker

Click the 'Deploy to Docker' button at the top to complete the deployment. Or, use the following shell:

docker run -d -p 18966:18966 --name myip --restart always jason5ng32/myip:latest

⁠📚 Environment Variable

Variables marked Yes below must be set for the backend to function correctly. The MaxMind credentials in particular are required — read the setup notes in the next subsection before filling in the table.

⁠MaxMind Databases (Required)

MyIP relies on the free GeoLite2 databases from MaxMind (City + ASN) for IP geolocation, ASN / organization lookup, and the country-code badges that appear throughout the app (IP cards, WebRTC ICE candidates, and more). A working MaxMind setup is required for the backend to serve a complete experience.

The .mmdb files are not checked into this repository because MaxMind's GeoLite2 license does not allow redistribution. You need to provide them yourself. There are two paths:

Option A — Automatic (recommended, required for Docker)

1. Create a free account at maxmind.com/en/geolite2/signup⁠.
2. Generate a license key from your account's "Manage License Keys" page.
3. Set these three environment variables:

   MAXMIND_ACCOUNT_ID="your-account-id"
   MAXMIND_LICENSE_KEY="your-license-key"
   MAXMIND_AUTO_UPDATE="true"
   

   Copy
4. Start the backend. Within about 60 seconds of the first startup, the updater will download both databases. They are then refreshed every 24 hours automatically.

Option B — Manual (for air-gapped or non-Docker setups)

Download GeoLite2-City.mmdb and GeoLite2-ASN.mmdb from your MaxMind account and drop them into common/maxmind-db/ before starting the backend. With this approach MAXMIND_AUTO_UPDATE can stay "false", but you'll need to refresh the files manually as MaxMind publishes new versions.

⁠Environment variables list

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

⁠Using Environment Variables in a Node Environment

Create environment variables:

cp .env.example .env

Modify .env, and for example, add the following:

BACKEND_PORT=11966
FRONTEND_PORT=18966
MAXMIND_ACCOUNT_ID="YOUR_ACCOUNT_ID"
MAXMIND_LICENSE_KEY="YOUR_LICENSE_KEY"
MAXMIND_AUTO_UPDATE="true"
GOOGLE_MAP_API_KEY="YOUR_KEY_HERE"
ALLOWED_DOMAINS="example.com"

Then restart the backend service.

⁠Using Environment Variables in Docker

You can add environment variables when running Docker, for example:

docker run -d -p 18966:18966 \
  -e MAXMIND_ACCOUNT_ID="YOUR_ACCOUNT_ID" \
  -e MAXMIND_LICENSE_KEY="YOUR_LICENSE_KEY" \
  -e MAXMIND_AUTO_UPDATE="true" \
  -e GOOGLE_MAP_API_KEY="YOUR_KEY_HERE" \
  -e ALLOWED_DOMAINS="example.com" \
  --name myip \
  jason5ng32/myip:latest

⁠👩🏻‍💻 Advanced Usage

If you're using a proxy for internet access, consider adding this rule to your proxy configuration (modify it according to your client). This setup lets you check both your real IP and the IP when using the proxy:

# IP Testing
IP-CIDR,1.0.0.2/32,Proxy,no-resolve
IP-CIDR6,2606:4700:4700::1111/128,Proxy,no-resolve
DOMAIN,4.ipcheck.ing,DIRECT
DOMAIN,6.ipcheck.ing,DIRECT
# Rule Testing
DOMAIN,ptest-1.ipcheck.ing,Proxy1
DOMAIN,ptest-2.ipcheck.ing,Proxy2
DOMAIN,ptest-3.ipcheck.ing,Proxy3
DOMAIN,ptest-4.ipcheck.ing,Proxy4
DOMAIN,ptest-5.ipcheck.ing,Proxy5
DOMAIN,ptest-6.ipcheck.ing,Proxy6
DOMAIN,ptest-7.ipcheck.ing,Proxy7
DOMAIN,ptest-8.ipcheck.ing,Proxy8

⁠😶‍🌫️ Additional Notes

When version 2.0 was released, I said that 70% of the code for this program was not written by me, but by AI. After about 90 interactions, plus some minor manual adjustments, the entire codebase was completed.

Of course, the architecture and UI still required my own design.

With the release of version 3.0 and subsequent versions, the proportion of code written with the help of AI has gradually decreased, now estimated to be between 40% and 50%. On the contrary, in this process, I went from having no knowledge of JavaScript and Vue to being able to understand most of the JS code, and I can now write some on my own.

Thanks to AI, it has given me, an unemployed product manager, a rapid opportunity to learn programming.

⁠🌟 Star History

⁠💖 Sponsors

As a open source project, I'm very grateful to the following sponsors for their support: