Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[DOC] add commercial database name and CC database name #209

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[DOC] add commercial database name and CC database name #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ac68c2
add supported commercial database name
kaisecheng Jul 22, 2022
b31da73
bump version
kaisecheng Jul 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## 7.2.13
- [DOC] Add supported commercial database name and CC database name [#209](https://github.com/logstash-plugins/logstash-filter-geoip/pull/209)

## 7.2.12
- [DOC] Add `http_proxy` environment variable for GeoIP service endpoint. The feature is included in 8.1.0, and was back-ported to 7.17.2 [#207](https://github.com/logstash-plugins/logstash-filter-geoip/pull/207)

Expand Down
10 changes: 4 additions & 6 deletions docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,16 @@ based on data from the MaxMind GeoLite2 databases.

==== Supported Databases

This plugin is bundled with https://dev.maxmind.com/geoip/geoip2/geolite2[GeoLite2] City database out of the box. From MaxMind's description --
This plugin is bundled with https://dev.maxmind.com/geoip/geoip2/geolite2[GeoLite2] ASN and City databases out of the box. From MaxMind's description --
"GeoLite2 databases are free IP geolocation databases comparable to, but less accurate than, MaxMind’s
GeoIP2 databases". Please see GeoIP Lite2 license for more details.

https://www.maxmind.com/en/geoip2-databases[Commercial databases] from MaxMind are also supported in this plugin.
https://www.maxmind.com/en/geoip2-databases[Commercial databases] Country, City, City Database by continent, ISP and Domain from MaxMind are also supported in this plugin.
Copy link
Contributor Author

@kaisecheng kaisecheng Jul 22, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@karenzone We don't have commercial databases to test locally. All are community contribution. The contributors claim the databases work and we accept their pull request. So, I am unsure what the appropriate word to say here is.

Maybe "Country, City, City Database by continent, ISP and Domain from MaxMind are supported by the community in this plugin" ?


If you need to use databases other than the bundled GeoLite2 City, you can download them directly
If you need to use databases other than the bundled GeoLite2, you can download them directly
from MaxMind's website and use the `database` option to specify their location. The GeoLite2 databases
can be https://dev.maxmind.com/geoip/geoip2/geolite2[downloaded from here].

If you would like to get Autonomous System Number(ASN) information, you can use the GeoLite2-ASN database.

[id="plugins-{type}s-{plugin}-database_license"]
==== Database License

Expand All @@ -58,7 +56,7 @@ database by default.
[id="plugins-{type}s-{plugin}-database_auto"]
==== Database Auto-update

This plugin bundles Creative Commons (CC) license databases.
This plugin bundles Creative Commons (CC) license databases `GeoLite2-ASN.mmdb` and `GeoLite2-City.mmdb`.
Logstash checks for database updates every day. It downloads the latest and can replace the old database
while the plugin is running.
After Logstash downloads EULA license databases, it will not fallback to CC license databases.
Expand Down
2 changes: 1 addition & 1 deletion logstash-filter-geoip.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Gem::Specification.new do |s|

s.name = 'logstash-filter-geoip'
s.version = '7.2.12'
s.version = '7.2.13'
s.licenses = ['Apache License (2.0)']
s.summary = "Adds geographical information about an IP address"
s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
Expand Down