https://github.com/geerlingguy/ansible-role-fathom

Ansible Role - Fathom
https://github.com/geerlingguy/ansible-role-fathom

analytics ansible ansible-galaxy ansible-role fathom linux role

Last synced: 19 days ago
JSON representation

Ansible Role - Fathom

• Host: GitHub
• URL: https://github.com/geerlingguy/ansible-role-fathom
• Owner: geerlingguy
• License: mit
• Created: 2019-02-01T17:07:02.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-16T19:21:30.000Z (4 months ago)
• Last Synced: 2024-10-10T04:06:44.849Z (about 1 month ago)
• Topics: analytics, ansible, ansible-galaxy, ansible-role, fathom, linux, role
• Language: Jinja
• Homepage: https://galaxy.ansible.com/geerlingguy/fathom
• Size: 23.4 KB
• Stars: 14
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ansible Role: Fathom

[![CI](https://github.com/geerlingguy/ansible-role-fathom/workflows/CI/badge.svg?event=push)](https://github.com/geerlingguy/ansible-role-fathom/actions?query=workflow%3ACI)

Installs [Fathom](https://github.com/usefathom/fathom), a Go-based website analytics system.

After the playbook is finished, visit the fathom interface (on port 9000 by default), and you can see instructions for configuring websites to send analytics to your Fathom server.

## Requirements

N/A, though you may wish to also install and configure Nginx as a proxy for security and stability reasons, and Certbot to acquire and use a valid TLS certificate for HTTPS (recommended roles: `geerlingguy.nginx` and `geerlingguy.certbot`).

## Role Variables

Available variables are listed below, along with default values (see `defaults/main.yml`):

    fathom_binary_url: https://github.com/usefathom/fathom/releases/download/v1.3.1/fathom_1.3.1_linux_amd64.tar.gz

The URL from which Fathom will be downloaded. Override for a newer or different version, or to lock in a specific version.

    fathom_force_update: false

If changing versions, use this flag to force Ansible to change Fathom versions on the server.

    fathom_manage_service: true

    fathom_service_state: started

    fathom_service_enabled: true

    fathom_service_user: root

Fathom service controls; useful if you want to stop the service, not have it enabled at boot, or are running Fathom inside a container where the service configuration is not helpful.

    fathom_directory: /opt/fathom

The directory inside which Fathom configuration and the default SQLite database are stored.

    fathom_http_port: "9000"

    fathom_database_name: fathom.db

    fathom_secret: secret-string-here

Fathom configuration options. Make sure you override `fathom_secret` in your playbook for better security!

## Dependencies

None.

## Example Playbook

    - hosts: analytics

    

      vars_files:

        - vars/main.yml

    

      roles:

        - geerlingguy.fathom

*Inside `vars/main.yml`*:

    fathom_secret: insert-a-secret-string-here

## Use with Nginx as a proxy

**See**: [Fathom playbook example using Nginx as a proxy](molecule/default/playbook-nginx.yml).

Note that you can also add the role `geerlingguy.certbot` if you want to install certbot and configure a default certificate to work with the Nginx server configuration for HTTPS on your Fathom installation.

## License

MIT / BSD

## Author Information

This role was created in 2019 by [Jeff Geerling](https://www.jeffgeerling.com/), author of [Ansible for DevOps](https://www.ansiblefordevops.com/).