> 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/developer/getting-started/quickstart.md).

# Quickstart

Get your own MyIP instance running with a single Docker command.

The fastest way to run MyIP is the prebuilt Docker image. You need Docker and a free MaxMind GeoLite2 account.

{% stepper %}
{% step %}

#### Get MaxMind credentials

MyIP uses the free **GeoLite2** databases for IP geolocation and ASN lookups. Sign up at [maxmind.com/en/geolite2/signup](https://www.maxmind.com/en/geolite2/signup), then generate a license key from the **Manage License Keys** page.

Full walkthrough: [MaxMind Setup](/developer/getting-started/maxmind-setup.md).
{% endstep %}

{% step %}

#### Run the container

{% code title="docker run" %}

```bash
docker run -d \
  -p 18966:18966 \
  -e MAXMIND_ACCOUNT_ID="your-account-id" \
  -e MAXMIND_LICENSE_KEY="your-license-key" \
  -e DATASET_AUTO_UPDATE="true" \
  --name myip \
  --restart always \
  jason5ng32/myip:latest
```

{% endcode %}
{% endstep %}

{% step %}

#### Open the app

Go to <http://localhost:18966>.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
**The first boot downloads the GeoLite2 databases.** The app is reachable right away; the download runs in the background and gives up after 5 minutes, so a bad credential never blocks startup. Until it finishes, MaxMind lookups answer `503` and country badges stay empty. Follow along with `docker logs -f myip` — you are looking for the line `📦 MaxMind databases loaded`.
{% endhint %}

{% hint style="warning" %}
**`localhost` works out of the box. A real domain does not.** The backend rejects every `/api/*` request whose `Referer` hostname is not `localhost` and not listed in `ALLOWED_DOMAINS`. Before you put MyIP on a domain, read [Reverse Proxy & Domains](/developer/getting-started/reverse-proxy-and-domains.md).
{% endhint %}

{% hint style="info" %}
**Modifying MyIP?** MyIP is licensed under [AGPL-3.0](https://github.com/jason5ng32/MyIP/blob/main/LICENSE). Running it unmodified needs nothing extra. If you modify it and let other people use it, you must offer them your modified source code under the same licence.
{% endhint %}

## Next steps

* [Deploy with Docker](/developer/getting-started/deploy-with-docker.md) — Compose, upgrades, port mapping, where data lives
* [Deploy with Node.js](/developer/getting-started/deploy-with-nodejs.md) — build from source, run under pm2
* [Optional API Keys](/developer/configuration/optional-api-keys.md) — extra IP data sources, maps, ASN tools
* [Environment Variables](/developer/reference/environment-variables.md) — the full list


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ipcheck.ing/developer/getting-started/quickstart.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.