|
||
---|---|---|
assets/src | ||
cmd/fathom | ||
pkg | ||
vendor | ||
.env.example | ||
.gitignore | ||
CODE_OF_CONDUCT.md | ||
Dockerfile | ||
LICENSE | ||
Makefile | ||
README.md | ||
docker-compose.yml | ||
gulpfile.js | ||
package-lock.json | ||
package.json |
README.md
Fathom - simple website analytics
Fathom Analytics is a simpler and more privacy-focused alternative to Google Analytics.
Collecting information on the internet is important, but it’s broken. We’ve become complacent in trading information for free access to web services, and then complaining when those web services do crappy things with that data.
The problem is this: if we aren’t paying for the product, we are the product.
Google Analytics may give you free access to their services but in turn, they’re assembling data profiles on your website visitors, which they can then use for better targeting of advertisements across their network.
We need to stop giving away our data and our users' privacy for free access to a tool.
Fathom respects the privacy of your users and does not collect any personally identifiable information. All while giving you the information you need about your site, so you can make smarter decisions about your design and content.
Installation
For getting a development version of Fathom up & running, go through the following steps.
- Ensure you have Golang installed properly
- Get code:
git clone https://github.com/usefathom/fathom.git $GOPATH/src/github.com/usefathom/fathom
- Compile into binary & prepare assets:
make build
- (Optional) Set your custom configuration values.
- Register your user account:
fathom register --email=<email> --password=<password>
- 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.
Docker
Building
Ensure you have Docker installed and run docker build -t fathom .
.
Run the container with docker run -d -p 8080:8080 fathom
.
Running
To run our pre-built Docker image, run docker run -d -p 8080:8080 usefathom/fathom:latest
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 -->
Content Security Policy
If you use a Content Security Policy (CSP) to specify security policies for your website, Fathom requires the following CSP directives (replace yourfathom.com
with the URL to your Fathom instance):
script-src: yourfathom.com;
img-src: yourfathom.com;
Roadmap
Find our public roadmap here.
If you have an idea or suggestion for Fathom, submit it as an issue here on GitHub.
Copyright and license
MIT licensed. Fathom and Fathom logo are trademarks of Fathom Analytics.