Danny van Kooten d3dfde315e
Merge pull request #48 from Sh4d1/docker
Add working Docker build and run example in README
2018-06-06 16:03:11 +02:00
2018-05-14 14:54:16 +02:00
2018-06-06 10:18:53 +02:00
2018-06-06 15:57:34 +02:00
2018-05-31 13:13:57 +02:00
2018-06-06 15:57:34 +02:00
2018-05-23 09:56:33 +02:00
2018-06-06 15:57:34 +02:00

Fathom - simple website analytics

Go Report Card MIT licensed

This is nowhere near being usable, let alone stable. Please treat as a proof of concept while we work on getting this to a stable state. Do not run Fathom in production yet unless you like spending time on it. Things will keep changing for the next few months.

Screenshot of the Fathom dashboard

Installation

For getting a development version of Fathom up & running, go through the following steps.

  1. Ensure you have Golang installed properly
  2. Get code: git clone git@github.com:usefathom/fathom.git $GOPATH/src/github.com/usefathom/fathom
  3. Compile into binary & prepare assets: make build
  4. (Optional) Set your custom configuration values.
  5. Register your user account: fathom register --email=<email> --password=<password>
  6. Start the webserver: fathom server and then visit http://localhost:8080 to access your analytics dashboard.

To install and run Fathom in production, have a look at the installation instructions.

Building with Docker

Ensure you have Docker installed and run docker build -t fathom .. Run the container with docker run -d -p 8080:8080 fathom.

Tracking snippet

To start tracking, include the following JavaScript on your site and replace yourfathom.com with the URL to your Fathom instance.

<!-- Fathom - simple website analytics - https://github.com/usefathom/fathom -->
<script>
(function(f, a, t, h, o, m){
	a[h]=a[h]||function(){
		(a[h].q=a[h].q||[]).push(arguments)
	};
	o=f.createElement('script'),
	m=f.getElementsByTagName('script')[0];
	o.async=1; o.src=t; o.id='fathom-script';
	m.parentNode.insertBefore(o,m)
})(document, window, '//yourfathom.com/tracker.js', 'fathom');
fathom('trackPageview');
</script>
<!-- / Fathom -->

MIT licensed. Fathom and Fathom logo are trademarks of Fathom Analytics.

Description
Fathom Lite. Simple, privacy-focused website analytics. Built with Golang & Preact.
https://usefathom.com/
Readme MIT
Languages
Go 51.8%
JavaScript 30.4%
CSS 15.2%
Makefile 1.3%
HTML 0.8%
Other 0.5%