mod-voyeur
Voyeur
Fathom Analytics module for After Dark.
About
Adds support for Fathom Analytics.
Requirements
- Domain. Pick one up on Namecheap.
- Virtual Private Server. Get one with Vultr or DigitalOcean.
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
-
Copy the contents of this repository into a directory called
themes/voyeur
under the root your After Dark site. -
Add
voyeur
as a theme component to your After Dark siteconfig.toml
, e.g.theme = ["voyeur","after-dark"] -
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 moduleurl = "https://stats.example.org" # Optional, base analytics URLport = "8080" # Optional, port setting -
Build and deploy your After Dark site.
For additional information please see the Fathom project. To request a feature or report an issue please do so in the After Dark repository.
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 (C) 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.