-
Notifications
You must be signed in to change notification settings - Fork 3
Create basic dev docs for little-used premium databases #1483
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| --- | ||
| draft: false | ||
| title: GeoIP IP Risk Databases | ||
| --- | ||
|
|
||
| Maxmind's GeoIP IP Risk database contains all IP networks associated with | ||
| non-corporate proxies, VPNs, and other anonymous IP addresses, and other IP | ||
| addresses associated with risky activity. | ||
|
|
||
| To learn more about the GeoIP IP Risk database, please see the | ||
| [GeoIP IP Risk database overview](https://get.maxmind.com/hubfs/Marketing/GeoIP%20IP%20Risk%20database/GeoIP%20IP%20Risk%20database%20product%20overview.pdf). | ||
| If you are interested in purchasing the database, please | ||
| [contact our Enterprise Business team](https://www.maxmind.com/en/solutions/connect-with-a-geoip-expert) | ||
| for assistance. | ||
|
|
||
| {{< snippet "snippets/data-privacy-warning.md" >}} | ||
|
|
||
| ## Binary Database | ||
|
|
||
| {{< snippet "snippets/binary-databases.md" >}} | ||
|
|
||
| ## CSV Database | ||
|
|
||
| {{< snippet "snippets/csv-databases-intro.md" >}} | ||
|
|
||
| {{< zip-file-content product-name="GeoIP2-IP-Risk" >}} | ||
|
|
||
| {{< snippet "snippets/file-format.md" >}} | ||
|
|
||
| ### Blocks Files | ||
|
|
||
| There are two CSV files for network blocks, one each for IPv4 and IPv6 blocks. | ||
| These are named `GeoIP2-IP-Risk-Blocks-IPv4.csv` and | ||
| `GeoIP2-IP-Risk-Blocks-IPv6.csv` respectively. | ||
|
|
||
| {{< rawhtml >}} | ||
|
|
||
| <div class="table"> | ||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <th>Name</th> | ||
| <th>Type</th> | ||
| <th>Description</th> | ||
| </tr> | ||
|
|
||
| <tr> | ||
| <td>network</td> | ||
| <td>IP network as a string</td> | ||
| <td> | ||
| This is the IPv4 or IPv6 network in CIDR format such as | ||
| "2.125.160.216/29" or "2001:c50::/32". We offer a utility to convert | ||
| this column to start/end IPs or start/end integers. See | ||
| <a href="#conversion-utility">the conversion utility section</a> for | ||
| details. | ||
| <br /> | ||
| <a | ||
| href="https://support.maxmind.com/hc/en-us/articles/4408200231067-IP-Network-Data#h_01FN989KWHZG902R63XSJ786RK" | ||
dhogan8 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| > | ||
| Learn more about the network column on our Knowledge Base. | ||
| </a> | ||
| </td> | ||
| </tr> | ||
|
|
||
| <tr> | ||
| <td>ip_risk</td> | ||
| <td>decimal</td> | ||
| <td> | ||
| This field contains the risk associated with the IP address. The value | ||
| ranges from 0.01 to 99. A higher score indicates a higher risk. | ||
| <br /> | ||
| <a | ||
| href="https://support.maxmind.com/hc/en-us/articles/4408200231067-IP-Network-Data#h_01FRRHZZP6TB1P6C99JFT16HCR" | ||
| > | ||
| Learn more about the IP risk score on our Knowledge Base. | ||
| </a> | ||
| <br /> | ||
| min: 0.01, max: 99 | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
|
|
||
| </table> | ||
| </div> | ||
| {{</ rawhtml >}} | ||
|
|
||
| ### Conversion Utility | ||
|
|
||
| {{< snippet "snippets/conversion-utility.md" >}} | ||
|
|
||
| ## Example Files | ||
|
|
||
| {{< snippet "snippets/example-files.md" >}} | ||
|
|
||
| ### CSV Example Files | ||
|
|
||
| {{< csv-example-files >}} | ||
|
|
||
| - [GeoIP2-IP-Risk-CSV_Example.zip](/static/GeoIP2-IP-Risk-CSV_Example.zip) | ||
| {{</ csv-example-files >}} | ||
|
|
||
| ### MMDB Example Files | ||
|
|
||
| {{< mmdb-example-files >}} | ||
|
|
||
| - [GeoIP2-IP-Risk-Test.mmdb](https://github.com/maxmind/MaxMind-DB/blob/main/test-data/GeoIP2-IP-Risk-Test.mmdb) | ||
| {{</ mmdb-example-files >}} | ||
|
|
||
| <!-- ## Database Sizes --> | ||
|
|
||
| <!-- prettier-ignore-start --> | ||
|
|
||
| <!-- {{< db-sizes-table dateRange="August to October 2024" >}} | ||
| - databaseName: "GeoIP IP Risk" | ||
| csvSizeRange: "TBD" | ||
| mmdbSizeRange: "TBD" | ||
| ipv4Range: "TBD" | ||
| ipv6Range: "TBD" | ||
| {{< /db-sizes-table >}} --> | ||
|
|
||
| <!-- prettier-ignore-end --> | ||
dhogan8 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Database Changes | ||
|
|
||
| {{< database-changes product="IP Risk" >}} | ||
|
|
||
| ## APIs and Third-Party Integrations | ||
|
|
||
| {{< snippet "snippets/geoip-db-apis.md" >}} | ||
dhogan8 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| --- | ||
| draft: false | ||
| title: GeoIP Static IP Score Databases | ||
| --- | ||
|
|
||
| This database indicates how static or dynamic an IP address is, which can be | ||
| useful for deciding whether an IP address represents the same user over time. | ||
|
|
||
| To learn more about the GeoIP Static IP Score database, including terms and | ||
| pricing, please | ||
| [contact our Enterprise Business team](https://www.maxmind.com/en/solutions/connect-with-a-geoip-expert) | ||
| for assistance. | ||
|
|
||
| {{< snippet "snippets/data-privacy-warning.md" >}} | ||
|
|
||
| ## Binary Database | ||
|
|
||
| {{< snippet "snippets/binary-databases.md" >}} | ||
|
|
||
| ## CSV Database | ||
|
|
||
| {{< snippet "snippets/csv-databases-intro.md" >}} | ||
|
|
||
| {{< zip-file-content product-name="GeoIP2-Static-IP-Score" >}} | ||
|
|
||
| {{< snippet "snippets/file-format.md" >}} | ||
|
|
||
| ### Blocks Files | ||
|
|
||
| There are two CSV files for network blocks, one each for IPv4 and IPv6 blocks. | ||
| These are named `GeoIP2-Static-IP-Score-Blocks-IPv4.csv` and | ||
| `GeoIP2-Static-IP-Score-Blocks-IPv6.csv` respectively. | ||
|
|
||
| {{< rawhtml >}} | ||
|
|
||
| <div class="table"> | ||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <th>Name</th> | ||
| <th>Type</th> | ||
| <th>Description</th> | ||
| </tr> | ||
|
|
||
| <tr> | ||
| <td>network</td> | ||
| <td>IP network as a string</td> | ||
| <td> | ||
| This is the IPv4 or IPv6 network in CIDR format such as | ||
| "2.125.160.216/29" or "2001:c50::/32". We offer a utility to convert | ||
| this column to start/end IPs or start/end integers. See | ||
| <a href="#conversion-utility">the conversion utility section</a> for | ||
| details. | ||
| <br /> | ||
| <a | ||
| href="https://support.maxmind.com/hc/en-us/articles/4408200231067-IP-Network-Data#h_01FN989KWHZG902R63XSJ786RK" | ||
| > | ||
| Learn more about the network column on our Knowledge Base. | ||
| </a> | ||
| </td> | ||
| </tr> | ||
|
|
||
| <tr> | ||
| <td>static_ip_score</td> | ||
| <td>decimal</td> | ||
| <td> | ||
| An indicator of how static or dynamic an IP address is. The value | ||
| ranges from 0 to 99.99 with higher values meaning a greater static | ||
| association. For example, many IP addresses with a user_type of | ||
| cellular have a score under one. Broadband IPs that don't change very | ||
| often typically have a score above thirty. | ||
| <br /> | ||
| This indicator can be useful for deciding whether an IP address | ||
| represents the same user over time. | ||
| <br /> | ||
| <a | ||
| href="https://support.maxmind.com/hc/en-us/articles/4408200231067-IP-Network-Data#h_01FRRHZZP6XQC228W34VCJV88P" | ||
| > | ||
| Learn more about the static IP score on our Knowledge Base. | ||
| </a> | ||
| <br /> | ||
| min: 0, max: 99.99 | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
|
|
||
| </table> | ||
| </div> | ||
| {{</ rawhtml >}} | ||
|
|
||
| ### Conversion Utility | ||
|
|
||
| {{< snippet "snippets/conversion-utility.md" >}} | ||
|
|
||
| ## Example Files | ||
|
|
||
| {{< snippet "snippets/example-files.md" >}} | ||
|
|
||
| ### CSV Example Files | ||
|
|
||
| {{< csv-example-files >}} | ||
|
|
||
| - [GeoIP2-Static-IP-Score-CSV_Example.zip](/static/GeoIP2-Static-IP-Score-CSV_Example.zip) | ||
| {{</ csv-example-files >}} | ||
|
|
||
| ### MMDB Example Files | ||
|
|
||
| {{< mmdb-example-files >}} | ||
|
|
||
| - [GeoIP2-Static-IP-Score-Test.mmdb](https://github.com/maxmind/MaxMind-DB/blob/main/test-data/GeoIP2-Static-IP-Score-Test.mmdb) | ||
| {{</ mmdb-example-files >}} | ||
|
|
||
| <!-- ## Database Sizes --> | ||
|
|
||
| <!-- prettier-ignore-start --> | ||
|
|
||
| <!-- {{< db-sizes-table dateRange="August to October 2024" >}} | ||
| - databaseName: "GeoIP Static IP Score" | ||
| csvSizeRange: "TBD" | ||
| mmdbSizeRange: "TBD" | ||
| ipv4Range: "TBD" | ||
| ipv6Range: "TBD" | ||
| {{< /db-sizes-table >}} --> | ||
|
|
||
| <!-- prettier-ignore-end --> | ||
|
|
||
| ## Database Changes | ||
|
|
||
| {{< database-changes product="Static IP Score" >}} | ||
|
|
||
| ## APIs and Third-Party Integrations | ||
|
|
||
| {{< snippet "snippets/geoip-db-apis.md" >}} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Our client APIs do not support IP Risk, Static IP score, or User Count databases. The underlying readers should work with them, but how to use them could be an article in themselves.
mmdbinspect does work for these DBs, but that's more of a tool than an integration library. It's still worth mentioning in these docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AndraMeer We need to update this section. Currently the snippet says:
But this isn't accurate so we need to use something like the following, but would like your input on specifically what we should say.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So if I'm understanding correctly, we don't want to mention the client APIs for the IP Risk, Static IP score, or User Count databases. Does this work as the copy then? I kept the first sentence of the initial paragraph as it seemed helpful and then removed "also" from "you can also use" in the second.