Fathom Lite. Simple, privacy-focused website analytics. Built with Golang & Preact. https://usefathom.com/
Go to file
Danny van Kooten 5d99de5813 lower datepicker timeout 2018-06-23 17:43:44 +02:00
assets/src lower datepicker timeout 2018-06-23 17:43:44 +02:00
cmd/fathom only print version string if not explicitly asking for version 2018-06-04 12:36:56 +02:00
pkg use a single http request to fetch all data for left-sidebar 2018-06-04 12:53:17 +02:00
vendor use github.com/urfave/cli as cli framework 2018-05-14 13:42:03 +02:00
.env.example simple bc for old --port arg 2018-05-14 14:54:16 +02:00
.gitignore add make dist task && separate assets build from binary build 2018-05-29 14:52:34 +02:00
CODE_OF_CONDUCT.md add code of conduct 2018-06-06 10:18:53 +02:00
Dockerfile Add working Docker build and run 2018-06-06 15:57:34 +02:00
LICENSE MIT license it is. Add readme instructions for getting a dev version running 2016-12-11 10:05:29 +01:00
Makefile Add working Docker build and run 2018-06-06 15:57:34 +02:00
README.md Add working Docker build and run 2018-06-06 15:57:34 +02:00
docker-compose.yml update docker-compose file to version 3 & use new fathom image 2018-05-10 22:21:31 +02:00
gulpfile.js fix watch task 2018-05-31 13:13:57 +02:00
install.sh choose a random port between 9000 and 9100 to decrease chance of clashing with previous installer runs... 2018-05-25 14:48:37 +02:00
package-lock.json add make dist task && separate assets build from binary build 2018-05-29 14:52:34 +02:00
package.json add basic tooltips in chart 2018-05-23 09:56:33 +02:00

README.md

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.