Fathom Analytics module for After Dark https://after-dark.habd.as/module/voyeur
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Josh Habdas cec23a4a02
docs(readme): add installation note
4 days ago
layouts/partials/modules/voyeur refactor(layouts): convert tabs to spaces 3 months ago
.gitignore chore: add gitignore file 2 months ago
CHANGELOG.md chore(release): 1.0.0 2 months ago
COPYING initial commit 3 months ago
README.md docs(readme): add installation note 4 days ago
docker-compose.dev.yml initial commit 3 months ago
docker-compose.yml initial commit 3 months ago
package-lock.json chore: prep for first release 2 months ago
package.json build(npm): add release script 2 months ago

README.md

Voyeur

Analytics module for After Dark. Voyeur adds support for Fathom Analytics.

Latest NPM version NPM downloads per month Minimum After Dark version

Requirements

Setup

For Voyeur to operate you must have Fathom up and running on a server somewhere on the interwebz. If your After Dark site uses TLS you must also enable TLS on your Fathom domain for reporting to function correctly. If you have a wildcard cert on your existing domain consider hosting Fathom on a subdomain such as stats.example.com and be done with it.

An example Docker Compose file to run Fathom using a Postgres database has been provided to you here as a convenience. Instructions on using it are beyond the scope of this module.

Installation

  1. Copy the contents of this repository into a directory called themes/voyeur under the root your After Dark site.
  2. Add voyeur as a theme component to your After Dark site config.toml, e.g.

    theme = [
      "voyeur", # sequence before "after-dark"
      "after-dark"
    ]
    
  3. Add and specify settings for the module in your After Dark site config, e.g.

    [params.modules.voyeur]
      enabled = true # Optional, set false to disable module
      url = "https://stats.example.org" # Optional, base analytics URL
      port = "8080" # Optional, port setting
    
  4. Build and deploy your After Dark site.

For additional information please see the Fathom project.

Development

For development, install Docker on your machine:

Configure your environment to use the dev config override:

export COMPOSE_FILE=docker-compose.yml:docker-compose.dev.yml

Run docker-compose up to start the app.

License

Copyright © 2018 Josh Habdas jhabdas@protonmail.com

This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See the COPYING file for more details.