Installation - standalone user level installing (w/ python bundle)¶
The collector can be run manually or as a scheduled task using the CRON hosting system. A single bash installation script was developed for implementing a straightforward setup process. This bash script executes the following installation/configuration steps:
- download and install a free minimal Python environment (https://docs.conda.io/en/latest/miniconda.html) in the user home directory
- install required Python packages
- create the default configuration file
- download the latest COUNTER Robots file
- instruct the user to fill minimal information in the configuration file: the DSpace installation directory, the DSpace major version and the required credentials for sending events to a remote Matomo instance
After this simple installation process, the collector is ready to start working by collecting and sending usage data into the pre-configured remote Matomo instance. Also a command to install the collector script in the user CRONTAB is provided.
IMPORTANT: The instalation script and the dspace-stats-collector does not require superuser privileges and don´t install any software outside the CURRENT_USER_HOME/dspace-stats-collector. The collector script execute read only queries over dspace relational db and solr core. This tool doesn´t write or modify any dspace file, dspace db or solr core. It´s recommended, but not mandatory, execute the instalation script from de dspace user.
Check if wget and cron are installed in the system.
Execute installation script from a plain user (ie: dspace) directly from github:
wget -O - https://git.io/JvzBR | bash
Configure matomo site parameters provided in CURRENT_USER_HOME/dspace-stats-collector/config/default.properties
Execute CURRENT_USER_HOME/dspace-stasts-collector/bin/dspace-stats-collector -v -f YYYY-MM-DD (will collect and send events for the first time from YYYY-MM-DD)
Check if the collector is sending data to matomo instance by asking to your national node manager ( do not execute the next step without this check )
Execute CURRENT_USER_HOME/dspace-stasts-collector/bin/dspace-stats-cronify (will install collector in user cron)
Check/ajust the user crontab (the instalation script adds an entry automatically in the user crontab, the collector runs every 60 min by default)