Mibew/geo-ip-plugin
1
0
Fork 0
mirror of https://github.com/Mibew/geo-ip-plugin.git synced 2024-11-15 00:44:13 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity
Provides an API for GeoIP info for other plugins
9 Commits 1 Branch 3 Tags 18 KiB
PHP 69.8%
JavaScript 30.2%
972abbb4b9
Go to file
Fedor A. Fetisov 972abbb4b9 Improve build process
2018-09-24 17:05:17 +03:00
db Initial commit 2014-12-05 13:44:40 +00:00
.gitignore Initial commit 2014-12-05 13:44:40 +00:00
composer.json Initial commit 2014-12-05 13:44:40 +00:00
gulpfile.js Improve build process 2018-09-24 17:05:17 +03:00
LICENSE Initial commit 2014-12-05 13:44:40 +00:00
package.json Bump version 2018-09-24 17:04:45 +03:00
Plugin.php Bump version 2018-09-24 17:04:45 +03:00
README.md Define system requirements (bcmath or gmp PHP extention) 2018-09-24 17:02:12 +03:00

README.md

Mibew Geo IP plugin

Provides Geo IP information for other plugins.

Requires either GMP (GNU Multiple Precision) or BC Math (BCMath Arbitrary Precision Mathematics) PHP extension.

Installation

  1. Get the archive with the plugin sources. You can download it from the official site or build the plugin from sources.

  2. Untar/unzip the plugin's archive.

  3. Put files of the plugins to the <Mibew root>/plugins folder.

  4. Obtain a copy of MaxMind's GeoIP2 City datatbase. You can use a free one from here http://dev.maxmind.com/geoip/geoip2/geolite2/.

  5. Rename the database file to GeoIP.mmdb and put it into <Mibew root>/plugins/Mibew/Mibew/Plugin/GeoIp/db directory.

  6. (optional) Add plugins configs to "plugins" structure in "<Mibew root>/configs/config.yml". If the "plugins" stucture looks like plugins: [] it will become:

    plugins:
    "Mibew:GeoIp": # Plugin's configurations are described below
        database_path: "/usr/local/share/GeoIP/GeoIP2-City.mmdb"

  7. Navigate to "<Mibew Base URL>/operator/plugin" page and enable the plugin.

Plugin's configurations

The plugin can be configured with values in "<Mibew root>/configs/config.yml" file.

config.database_path

Type: String

Default: <Plugin dir>/db/GeoIP.mmdb

Specify location of the GeoIP database. This value is optional and can be skipped.

Build from sources

There are several actions one should do before use the latest version of the plugin from the repository:

  1. Obtain a copy of the repository using git clone, download button, or another way.
  2. Install node.js and npm.
  3. Install Gulp.
  4. Install npm dependencies using npm install.
  5. Run Gulp to build the sources using gulp default.

Finally .tar.gz and .zip archives of the ready-to-use Plugin will be available in release directory.

License

Apache License 2.0