> For the complete documentation index, see [llms.txt](https://docs.ipcheck.ing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ipcheck.ing/readme.md).

# Home

<h2 align="center">🧰 The MyIP documentation hub</h2>

<p align="center"><strong>MyIP</strong> is an open-source all-in-one IP toolbox: IP lookup from multiple sources, connectivity tests, WebRTC &#x26; DNS-leak detection, speed test, MTR, Whois, censorship checks, and more.</p>

<p align="center"><a href="https://ipcheck.ing" class="button primary" data-icon="globe">Open MyIP on IPCheck.ing</a> <a href="https://github.com/jason5ng32/MyIP" class="button secondary" data-icon="github">Check the code on GitHub</a> <button type="button" class="button secondary" data-action="ask" data-icon="gitbook-assistant">Ask the docs…</button></p>

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><h3><i class="fa-life-ring" style="color:$primary;">:life-ring:</i></h3></td><td><h4><strong>Knowledge Base</strong></h4></td><td>For everyone using MyIP: what every tool does, step-by-step network diagnosis, and networking concepts in plain language.</td><td><a href="https://docs.ipcheck.ing/knowledge-base" class="button secondary">Browse the Knowledge Base</a></td><td><a href="https://docs.ipcheck.ing/knowledge-base">https://docs.ipcheck.ing/knowledge-base</a></td><td><a href="/files/LHIOZGoI6dPF36TuRaxH">/files/LHIOZGoI6dPF36TuRaxH</a></td></tr><tr><td><h3><i class="fa-code" style="color:$success;">:code:</i></h3></td><td><h4><strong>Developer</strong></h4></td><td>For self-hosters and contributors: deploy your own instance with Docker or Node.js, understand the architecture, and send your first PR.</td><td><a href="https://docs.ipcheck.ing/developer" class="button secondary">Read the Developer docs</a></td><td><a href="https://docs.ipcheck.ing/developer">https://docs.ipcheck.ing/developer</a></td><td><a href="/files/ebMoLMpZFyLqpzByuzrk">/files/ebMoLMpZFyLqpzByuzrk</a></td></tr></tbody></table>

## Popular with users

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-shield-check" style="color:$success;">:shield-check:</i></h3></td><td><h4><strong>Is my VPN working?</strong></h4></td><td>Check your IP, WebRTC, and DNS in one pass</td><td><a href="https://docs.ipcheck.ing/knowledge-base/diagnose/is-my-vpn-working">https://docs.ipcheck.ing/knowledge-base/diagnose/is-my-vpn-working</a></td></tr><tr><td><h3><i class="fa-droplet" style="color:$danger;">:droplet:</i></h3></td><td><h4><strong>Am I leaking my real IP?</strong></h4></td><td>The three leak paths, tested step by step</td><td><a href="https://docs.ipcheck.ing/knowledge-base/diagnose/am-i-leaking-my-real-ip">https://docs.ipcheck.ing/knowledge-base/diagnose/am-i-leaking-my-real-ip</a></td></tr><tr><td><h3><i class="fa-map-pin" style="color:$warning;">:map-pin:</i></h3></td><td><h4><strong>Why is my location wrong?</strong></h4></td><td>How GeoIP works and what to expect from it</td><td><a href="https://docs.ipcheck.ing/knowledge-base/diagnose/why-is-my-ip-location-wrong">https://docs.ipcheck.ing/knowledge-base/diagnose/why-is-my-ip-location-wrong</a></td></tr><tr><td><h3><i class="fa-terminal" style="color:$info;">:terminal:</i></h3></td><td><h4><strong>Get your IP with curl</strong></h4></td><td>One command in your terminal, IPv4 or IPv6</td><td><a href="https://docs.ipcheck.ing/knowledge-base/getting-started/curl-api">https://docs.ipcheck.ing/knowledge-base/getting-started/curl-api</a></td></tr></tbody></table>

## Popular with self-hosters

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-rocket-launch" style="color:$primary;">:rocket-launch:</i></h3></td><td><h4><strong>Quickstart</strong></h4></td><td>Your own MyIP with one Docker command</td><td><a href="https://docs.ipcheck.ing/developer/getting-started/quickstart">https://docs.ipcheck.ing/developer/getting-started/quickstart</a></td></tr><tr><td><h3><i class="fa-database" style="color:$success;">:database:</i></h3></td><td><h4><strong>MaxMind setup</strong></h4></td><td>The one required credential, set up in minutes</td><td><a href="https://docs.ipcheck.ing/developer/getting-started/maxmind-setup">https://docs.ipcheck.ing/developer/getting-started/maxmind-setup</a></td></tr><tr><td><h3><i class="fa-gear" style="color:$warning;">:gear:</i></h3></td><td><h4><strong>Environment variables</strong></h4></td><td>Every variable, grouped and explained</td><td><a href="https://docs.ipcheck.ing/developer/reference/environment-variables">https://docs.ipcheck.ing/developer/reference/environment-variables</a></td></tr><tr><td><h3><i class="fa-circle-question" style="color:$info;">:circle-question:</i></h3></td><td><h4><strong>FAQ &#x26; troubleshooting</strong></h4></td><td>The most common deployment problems, solved</td><td><a href="https://docs.ipcheck.ing/developer/reference/faq">https://docs.ipcheck.ing/developer/reference/faq</a></td></tr></tbody></table>

{% hint style="info" icon="language" %}
**Docs in your language** — use the language switcher in the top-right corner. Translations are generated automatically from the English source.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ipcheck.ing/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.