From 989941dd0be1b7329684f45c378d0e9b2fa5e26c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dar=C3=ADo=20Here=C3=B1=C3=BA?= Date: Mon, 9 Mar 2020 09:34:57 -0300 Subject: [PATCH] Deleting README at request of @asmecher * vide https://github.com/pkp/usageStats/pull/23#issuecomment-595811080 --- README | 74 ---------------------------------------------------------- 1 file changed, 74 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index fbc9b11..0000000 --- a/README +++ /dev/null @@ -1,74 +0,0 @@ -============================================================= -=== Usage Statistics Plugin -=== Version: 1.0 -============================================================= - - -About ------ -This plugin implements usage statistics logging and processing, and also -default reports to retrieve statistics related to the journal i.e. press, -articles i.e. monographs and article i.e. monograph files. - -Usually an usage statistic event is a page view (journal i.e. press catalog index page, -abstract article i.e. monograph page, etc) or a file download (article i.e. monograph file downloads). - -This plugin can also log statistics aggregated by the geo location of the -user. To activate this option, take a look at the INSTALLATION section of -this document. - -License -------- -This plugin is licensed under the GNU General Public License v2. See the file -LICENSE for the complete terms of this license. - -System Requirements -------------------- -The default usage of this plugin is automatic and doesn't require any other -extra requirement other than OJS i.e. OMP already does. - -If you want to learn on how to process external log files, like apache access -files, please refer to https://pkp.sfu.ca/wiki/index.php?title=PKP_Statistics_Framework#External_access_log_files_alternative - - -Installation ------------- -The plugin is integrated as a submodule in the OJS i.e. OMP. - -To enable the plugin go as admin user either to -- Administration > Site Settings > Plugins > Generic Plugins - or to -- Settings > Website > Plugins > Generic Plugins -...and select the Enable checkbox beside "Usage Statistics Plugin" - -The only needed additional step depends on whether you want to have geo -location data in your statistics or not. If that's the case, follow these -steps: - -Linux: -1 - open a shell prompt -2 - go into OJS i.e. OMP installation’s base directory -2 - wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz -3 - gunzip GeoLiteCity.dat.gz -4 - mv GeoLiteCity.dat plugins/generic/usageStats - -Windows -1 - download the file http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz -2 - decompress it using any decompression tool into plugins/generic/usageStats directory - -In both cases the complete path to the installed database file should be -plugins/generic/usageStats/GeoLiteCity.dat - -Note, that a separate license agreement is required for this use of this database. -For details, see: - https://dev.maxmind.com/geoip/legacy/geolite/ - - -Management ------------- - - -Contact/Support ---------------- -Documentation, bug listings, and updates can be found on this plugin's homepage -at .