Service: Fathom Lite - EyevinnOSC/community GitHub Wiki

Fathom Lite

Fathom Lite (serviceId usefathom-fathom) is an open-source (MIT) website analytics tool that collects page views and presents them on a dashboard, without cookies. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 10 GiB of storage per instance.

What it can do

  • Collect page views from one or more websites by adding a tracking code to the pages.
  • Present the collected data on a dashboard.
  • Manage several sites from one instance, each with its own tracking code.

Creating an instance

Find the id with list-available-services, read the options with get-service-schema, then call create-service-instance with serviceId: "usefathom-fathom". The instance name must be alphanumeric and at most 20 characters. Fathom Lite has no dependencies on other OSC services.

{
  "name": "mystats",
  "AdminEmail": "[email protected]",
  "AdminPassword": "{{secrets.fathompwd}}"
}

Create the secret first with create-service-secret (serviceId usefathom-fathom, name fathompwd, value your password). Confirm the instance is running with wait-for-service-ready or get-instance-status; describe-service-instance returns its URL.

Options

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric, at most 20 characters.
AdminEmail Yes string Email address of the admin user. You sign in to the Fathom dashboard with it.
AdminPassword Yes string, sensitive Password of the admin user. Store it as a service secret and pass it as {{secrets.NAME}}, which only works as the entire field value.

Overwriting a secret does not restart a running instance.

Using the instance

  1. Open the instance URL and sign in with AdminEmail and AdminPassword.
  2. Enter the name of your site and create it.
  3. Copy the tracking code shown and add it to your website's pages.

Page views then appear on the dashboard.

Limitations

  • Storage is limited to 10 GiB per instance.

Resources