Skip to content
Permalink
Browse files

Removed documentation references to analytics settings. Added new Ana…

…lytics Tracking Code section to Installation Guide. [ref #4660]
  • Loading branch information...
mheppler committed Dec 18, 2018
1 parent 0df98cb commit 846b6a03bc40d712889b9ddb2955b228827ed54f
Showing with 10 additions and 36 deletions.
  1. +1 −1 doc/sphinx-guides/source/admin/monitoring.rst
  2. +9 −35 doc/sphinx-guides/source/installation/config.rst
@@ -58,7 +58,7 @@ HTTP traffic can be monitored from the client side, the server side, or both.
Monitoring HTTP Traffic from the Client Side
++++++++++++++++++++++++++++++++++++++++++++

HTTP traffic for web clients that have cookies enabled (most browsers) can be tracked by Google Analytics and Piwik (renamed to "Matomo") as explained in the :doc:`/installation/config` section of the Installation Guide under ``:GoogleAnalyticsCode`` and ``:PiwikAnalyticsId``, respectively. You could also embed additional client side monitoring solutions by using a custom footer (``:FooterCustomizationFile``), which is described on the same page.
HTTP traffic for web clients that have cookies enabled (most browsers) can be tracked by Google Analytics (https://www.google.com/analytics/) and Matomo (formerly to "Piwik"; https://matomo.org/) as explained in the :ref:`Analytics-Tracking-Code` section of the Installation Guide.

Monitoring HTTP Traffic from the Server Side
+++++++++++++++++++++++++++++++++++++++++++++
@@ -523,6 +523,15 @@ Once you have the location of your custom CSS file, run this curl command to add

``curl -X PUT -d '/var/www/dataverse/branding/custom-stylesheet.css' http://localhost:8080/api/admin/settings/:StyleCustomizationFile``

.. _Analytics-Tracking-Code:

Analytics Tracking Code
-----------------------

Your analytics tracking code can be added to your Dataverse installation in a similar fashion to how you brand it, by adding custom files and adding them to your settings.

Popular analytics providers Google Analytics (https://www.google.com/analytics/) and Matomo (formerly to "Piwik"; https://matomo.org/) have been set up with Dataverse. Use the documentation they provide to add to your custom HTML files. This allows for more control of what you prefer to track.

Going Live: Launching Your Production Deployment
------------------------------------------------

@@ -1117,13 +1126,6 @@ For example, if you want your installation of Dataverse to not attempt to ingest

Limit the number of files in a zip that Dataverse will accept.

:GoogleAnalyticsCode
++++++++++++++++++++

Set your Google Analytics Tracking ID thusly:

``curl -X PUT -d 'trackingID' http://localhost:8080/api/admin/settings/:GoogleAnalyticsCode``

:SolrHostColonPort
++++++++++++++++++

@@ -1231,34 +1233,6 @@ Here is an example of setting the default auth provider back to ``builtin``:

Set to false to disallow local accounts to be created. See also the sections on :doc:`shibboleth` and :doc:`oauth2`.

:PiwikAnalyticsId
++++++++++++++++++++

Site identifier created in your Piwik instance. Example:

``curl -X PUT -d 42 http://localhost:8080/api/admin/settings/:PiwikAnalyticsId``

:PiwikAnalyticsHost
++++++++++++++++++++

Host FQDN or URL of your Piwik instance before the ``/piwik.php``. Examples:

``curl -X PUT -d stats.domain.tld http://localhost:8080/api/admin/settings/:PiwikAnalyticsHost``

or

``curl -X PUT -d hostname.domain.tld/stats http://localhost:8080/api/admin/settings/:PiwikAnalyticsHost``

:PiwikAnalyticsTrackerFileName
++++++++++++++++++++++++++++++

Filename for the 'php' and 'js' tracker files used in the Piwik code (piwik.php and piwik.js).
Sometimes these files are renamed in order to prevent ad-blockers (in the browser) to block the Piwik tracking code.
This sets the base name (without dot and extension), if not set it defaults to 'piwik'.

``curl -X PUT -d domainstats http://localhost:8080/api/admin/settings/:PiwikAnalyticsTrackerFileName``


:FileFixityChecksumAlgorithm
++++++++++++++++++++++++++++

0 comments on commit 846b6a0

Please sign in to comment.
You can’t perform that action at this time.