Giter Site home page Giter Site logo
Offen Fair Web Analytics logo

Offen Fair Web Analytics

CircleCI License Docs Awesome Humane Tech REUSE status

Let your users access their data.
Gain valuable insights at the same time.
Open, lightweight, self hosted and free.

Contents

Software

Community

Core features

Secure & free
Our code is open source. All usage data is encrypted end-to-end. Offen Fair Web Analytics will always be available for free.

Self hosted
Comply with GDPR guidelines. No ads, no third parties involved. Offen Fair Web Analytics uses first-party cookies only.

Fair & by choice
Opt-in only. Users must actively give their consent to data collection. They have full access to their data.

How it works

Your job

  • Self host Offen Fair Web Analytics while protecting your users' data.
  • Integrate the code snippet into pages you want to track.
  • Make your users aware of the access to their data.
  • Improve your services with fair and transparent insights.

Benefits for your users

  • Opt in to data collection or decide to not participate at all.
  • Review own data with detailed explanations of metrics and terms.
  • Only delete usage data or opt out completely at any time.

What you see
Data of all pages where your installation is active. For example:

Example A

What your users see
Data of all pages a user has visited where your installation is active. For example:

Example B

More features

  • Easily analyze multiple websites within one installation.
  • All website accounts can be shared within teams.
  • User data is only stored for 6 months and then deleted.
  • A detailed documentation on how to run Offen Fair Web Analytics is available.

Essential metrics

All important statistics that help you to improve your service.
Filter collected data by URL, Location, Referrer, UTM parameters, as well as Landing Pages and Exit Pages. Essential metrics

Objectives

Privacy friendly
Collection of usage data is opt in, users that do not actively opt in will never leave a trace. After opt in, Offen Fair Web Analytics collects the minimal amount of data needed to generate meaningful statistics for operators. No IPs, User-Agent strings or similar are being collected or even looked at.

Secure
Data in Offen Fair Web Analytics is encrypted End-To-End. Clients encrypt usage data before it leaves the browser and there is no way for the server storing this data to decrypt it. Attackers have no means to compromise an instance, accidental data leaks cannot expose user data.

Self hosted and lightweight
You can run Offen Fair Web Analytics on-premises, or in any other deployment scenario that fits your need. All you need to do is download a single binary file or pull a Docker image, and run it on your server. Offen Fair Web Analytics will automatically install and renew SSL certificates for you if you want it to. If you do not want to deploy a dedicated database, you can use SQLite to store data directly on the server.

Transparent and fair
Offen Fair Web Analytics treats the user as a party of equal importance in the collection of usage data. Users have access to the same set of tools for analyzing their own data and they can delete their data at any time.

Localize

Offen Fair Web Analytics is currently available in English, French, German, Portuguese, Spanish and Vietnamese. Our consent banner and the Auditorium for operators as well as users can be displayed in the respective locale.

If you want to support fair web analytics by contributing Italian, Dutch, Polish or other language versions, don't hesitate to request an invite.

Customize

Our consent banner is customizable in color, shape and basic font specifications to match your design. Learn more.

Test drive

Give Offen Fair Web Analytics a test drive right now. Open your terminal and type:

curl https://demo.offen.dev | bash

This creates an ephemeral one-off installation that is populated with random data and is running on http://localhost:9876. There, you can log in using the account [email protected] and password demo.

License

Work in this repository is licensed under multiple licences.

  • All original source code is licensed under Apache-2.0.
  • All documentation is licensed under Apache-2.0.
  • The Offen Fair Web Analytics icon and logo are licensed as CC-BY-NC-ND-4.0.

See the NOTICE file for license information on works that get bundled by Offen Fair Web Analytics.

Project status

Offen Fair Web Analytics is in active development.
Check our roadmap and blog for detailed updates on what we are working on right now and what's up next.

Feedback and contributions welcome

Found an issue or want to add something? Please do not hesitate to file an issue or open a pull request (or send an email in case you don't want to use GitHub). For details on how to get started head over to our contributing guidelines.


This repository contains all source code needed to work on Offen Fair Web Analytics, both on the server as well as on the client. The development setup requires docker and the compose plugin to be installed.

After cloning the repository

$ git clone [email protected]:offen/offen.git

you can build the containers and install dependencies using:

$ make setup

Next seed the database for the server application:

$ make bootstrap

You can test your setup by starting the application:

$ make up

which should enable you to access http://localhost:8080/auditorium/ and use the Auditorium

Run the tests for all subapplications using

$ make test

Detailed instructions on how to get started with development can be found at our dedicated docs site.


The documentation site at https://docs.offen.dev is also part of this repository. To run this site locally, you can:

make setup-docs
make docs

This will serve the documentation site on https://localhost:4000.

Kind support

NLnet Foundation

We are happy to work with NLnet Foundation, which actively supports our efforts as part of its Next Generation Internet initiative.

Cross-Browser testing provided by BrowserStack.

Who's using Offen Fair Web Analytics?

We're happy to feature you in this README. Send a PR adding your site or app to this section.

Links

Website
Docs
Mastodon

offen.software's Projects

analyticstxt-parser icon analyticstxt-parser

JSON schema based Node.js library and CLI tool to parse and validate analytics.txt files

deb icon deb

Offen Fair Web Analytics as a Debian package

demo icon demo

Script to download and start an Offen Fair Web Analytics demo

deployment icon deployment

Deployment template for an Offen Fair Web Analytics instance using docker-compose

digitalocean icon digitalocean

DigitalOcean droplet image for Offen Fair Web Analytics

docker-volume-backup icon docker-volume-backup

Backup Docker volumes locally or to any S3, WebDAV, Azure Blob Storage, Dropbox or SSH compatible storage

docs icon docs

Docs are now found in the offen/offen repository

envconfig icon envconfig

Golang library for managing configuration data from environment variables

get icon get

Server for get.offen.dev

heroku icon heroku

Preset for deploying an Offen Fair Web Analytics instance to Heroku

l10nify icon l10nify

gettext based localization workflow for Javascript / Browserify

press-kit icon press-kit

Assets for the public to use when referring to Offen

protocol icon protocol

A specification for the discoverable exchange of data over a single HTTP endpoint

schemaify icon schemaify

Browserify transform for compiling JSON schemas at build time using AJV

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.