Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ThaDafinser committed Sep 19, 2014
2 parents 8812351 + c940775 commit dabbd64
Showing 1 changed file with 35 additions and 5 deletions.
40 changes: 35 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,41 @@ Piwik plugin to locate all locale data of a user based on the IP address/subnetw

## FAQ

__What does this plugin do?__

It adds visitor information based on the matched IP address from your configuration. Not more and not less.
The database schema and UI stays untouched, so all Piwik statistics can be used like you would use a internet GeoIP database.


__How to configure/install this plugin / the networks?__

After installation and activation of the plugin, open the file `piwik/config/IntranetGeoIP.data.php`

You can their add your location information and their subnetworks.

See the file `piwik/config/IntranetGeoIP.data.php` or see the readme on github https://github.com/ThaDafinser/IntranetGeoIp


__What statistics are available?__

If you create a full configuration data file, you'll see
* Visitor -> Realtime visitor map
* Visitor -> Location and provider
* and many more...
* and many more...(in generall all statistics are available like using a internet GeoIP database)


__How to configure/install this plugin / the networks?__
__Why there stands provider "unknown" in my visitor log?__

After installation and activation of the plugin, open the file `piwik/plugins/IntranetGeoIp/data.php`
If your installation is stock, all visitors will get this "flag" to show you, what IPs are not matched.
You can adjust or remove this, by changing the "noMatch" block in your `IntranetGeoIP.data.php` file.
If you remove the complete block, none matched visitors will be skipped by this plugin.
But you can also fill all possible visitorInfos like you are used for matched IP addresses.

You can their add your location information and their subnetworks.

See the file `piwik/plugins/IntranetGeoIp/data.php` or see the readme on github https://github.com/ThaDafinser/IntranetGeoIp
__Can i use this plugin with a internet GeoIP database side by side?__

Yes you can.
Just remove or comment out the `noMatch` block in your configuration file.

__Note about the configuration?__

Expand All @@ -34,6 +54,16 @@ Inside they key `networks` add all subnetworks which apply to this location.

```php
return [
/*
* If the IP was not matched, apply these data to visitorInfo
* You can also apply here all possible visitorInformation data if you want
*/
'noMatch' => [
'visitorInfo' => [
'location_provider' => 'unknown'
]
],

[
'visitorInfo' => [
//ISO-3166 alpha-2 code http://en.wikipedia.org/wiki/ISO_3166-1
Expand Down

0 comments on commit dabbd64

Please sign in to comment.