Help
This page contains information about how to use Updater User Data Collection.
Configuration
It is neccesary to customize the needs of User Data Collection to work correctly. Below are all settings available and an explanation how to configure the settings.
The settings are all located in config.inc.php. You can simply edit this file with your favorite text editor.
Company settings
| Setting | Explanation |
|---|---|
| COMPANY_NAME | This is the name of the company that will be displayed in the title bar of the browser. |
Site settings
| Setting | Explanation |
|---|---|
| SITE_ADDRESS | This is the site address of the website that is hosting the statistics, e.g. "http://www.catenalogic.com". |
| SITE_ROOT | This is the root path of the statistics part of the website, e.g. "http://catenalogic.com/statistics/". |
| SITE_INTERNALROOT | This is the internal root of the statistics part, e.g. "C:\\inetpub\\vhosts\\catenalogic.com\\httpdocs\\statistics\\". This is required to generate the cache files. |
| SITE_INTERNALSLASH | This is the interal slash that is used on the system that runs the statistics script. If on linux, this value should be "/", on Windows, this value should be "\\". |
Database settings
| Setting | Explanation |
|---|---|
| DATABASE_HOST | The host of the database, normally "localhost". |
| DATABASE_NAME | The database name that is used for the statistics. |
| DATABASE_USERNAME | The database username to authenticate. |
| DATABASE_PASSWORD | The database password to authenticate. |
Authentication settings
| Setting | Explanation |
|---|---|
| AUTHENTICATION_REQUIRED | If true, users must authenticate themselves before viewing the statistics. It is recommended to enable this feature. |
| AUTHENTICATION_USERNAME | The username that the user must enter when authenticating. |
| AUTHENTICATION_PASSWORD | The password that the user must enter when authenticating. |
Caching settings
| Setting | Explanation |
|---|---|
| CACHING_ENABLED | When this value is set to true, the statistics will be cached into the cache folder so there will not be too much communication with the database when viewing and exploring the statistics. |
| CACHING_RENEW | This is the cache renew rate in hours. When set to 1, the cache will be refreshed every hour. |
Back to top
Authentication
By default, you need to authenticate when viewing statistics. This is to protect the data to users that are not allowed to view the update statistics.
If you want to disable authentication, simply define AUTHENTICATION_REQUIRED as false in the configuration file. Back to top