The Umami Analytics Plugin is an extension for Grav CMS for adding Umami Analytics to your site
Installing the Umami Analytics plugin can be done in one of three ways: The GPM (Grav Package Manager) installation method lets you quickly install the plugin with a simple terminal command, the manual method lets you do so via a zip file, and the admin method lets you do so via the Admin Plugin.
To install the plugin via the GPM, through your system's terminal (also called the command line), navigate to the root of your Grav-installation, and enter:
bin/gpm install umami-analytics
This will install the Umami Analytics plugin into your /user/plugins-directory within Grav. Its files can be found under /your/site/grav/user/plugins/umami-analytics.
To install the plugin manually, download the zip-version of this repository and unzip it under /your/site/grav/user/plugins. Then rename the folder to umami-analytics. You can find these files on GitHub or via GetGrav.org.
You should now have all the plugin files under
/your/site/grav/user/plugins/umami-analytics
If you use the Admin Plugin, you can install the plugin directly by browsing the Plugins-menu and clicking on the Add button.
Before configuring this plugin, you should copy the user/plugins/umami-analytics/umami-analytics.yaml to user/config/plugins/umami-analytics.yaml and only edit that copy.
Here is the default configuration and an explanation of available options:
enabled: true # Enable or disable the plugin
script_src: 'https://us.umami.is' # Source URL of the Umami script
website_id: null # ID of the website
host_url: null # Override the host URL for data to be sent to
disable_auto_track: false # Disable auto tracking
domains: null # Domains to track
enable_localhost: false # Enable tracking on localhostThe fields script_src and website_id are required.
Note that if you use the Admin Plugin, a file with your configuration named umami-analytics.yaml will be saved in the user/config/plugins/-folder once the configuration is saved in the Admin.
The plugin will inject the Umami Analytics script into your site's <head> tag. You can verify this by inspecting the source code of your site.
After you've added your website to Umami, you have to set the server_url and the website_id fields in the plugin configuration. You can find these values in the Umami dashboard.
server_urlis the URL of your Umami server, e.g.https://us.umami.is.website_idis the ID of your website, e.g.76e4f3db-8fec-47ad-82ba-f5O21cOac915.
- add to the official plugins list
- disable tracking in development mode (overrideable)
- add more configuration options