https://github.com/nicell/trmnl-umami

📈 Umami Analytics plugin for TRMNL
https://github.com/nicell/trmnl-umami

analytics trmnl trmnl-plugin umami umami-analytics

Last synced: 2 months ago
JSON representation

📈 Umami Analytics plugin for TRMNL

• Host: GitHub
• URL: https://github.com/nicell/trmnl-umami
• Owner: Nicell
• License: mit
• Created: 2025-06-19T19:10:36.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-06-19T22:00:53.000Z (4 months ago)
• Last Synced: 2025-07-24T15:22:22.091Z (3 months ago)
• Topics: analytics, trmnl, trmnl-plugin, umami, umami-analytics
• Language: Liquid
• Homepage: https://usetrmnl.com/recipes/25370/install
• Size: 33.2 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Umami TRMNL

![Graph with web pageview data and total pageviews and visitors at the top](screen.png)

A TRMNL plugin for [Umami Analytics](https://umami.is).

## Installation

### Via Recipe Fork

1. Go to the [Umami TRMNL Recipe](https://usetrmnl.com/recipes/25370/install)

2. Fork the recipe to your account (top right)

### Import

1. Download the [latest release](https://github.com/nicell/trmnl-umami/releases)'s plugin.zip file

2. Go to your [TRMNL plugin page](https://usetrmnl.com/plugins)

3. Connect Private Plugin if you haven't already

4. Go to [Private Plugin](https://usetrmnl.com/plugin_settings?keyname=private_plugin) from Connected list

5. Click Import new (top right)

6. Select the downloaded ZIP file

## Configuration

1. Set your preferred lookback period and time zone

2. Set your Umami instance hostname and website UUID

   1. Given the website analytics URL of `https://umami.example.com/websites/ff7223cd-b92c-4895-a7ba-2088adca6d7e`

   2. Your hostname is `umami.example.com`

   3. Your website UUID is `ff7223cd-b92c-4895-a7ba-2088adca6d7e`

3. Set your API key

   1.  Create a new user with only read access to the website you want to monitor

   2.  Create an API key for that user

       1.  [Self-hosted guide](https://umami.is/docs/api/authentication)

       2.  [Umami Cloud guide](https://umami.is/docs/cloud/api-key)

   3.  Copy the API key and paste it into the plugin configuration