Skip to content

Self-hosted, Node.js based analytics tool for those who care about privacy.

License

Notifications You must be signed in to change notification settings

amejiarosario/Ackee

 
 

Repository files navigation

Ackee

Travis Build Status Coverage Status Dependencies Donate via PayPal

Ackee helps you to track your sites, know more about your visitors and to analyze your traffic.

Ackee in a browser

Contents

Get started

Get Ackee up and running…

And configure Ackee and your server correctly…

Introduction

What is Ackee?

Ackee is a lightweight, self-hosted alternative to Google Analytics. It features an API and web interface and tracks only what's really necessary.

Why Ackee?

Because nobody should share information about their visitors with others. The big players already know enough about us.

  • Self-hosted
  • Written in Node.js
  • Lightweight and minimal user interface
  • No unique user tracking and no cookies

How does it work?

You run the Ackee server which than waits for requests through its API.

The API of Ackee accepts information about your visitors sent to it using ackee-tracker. It's a small script you add to your sites, similar to the JavaScript tracking snippet provided by Google Analytics.

The interface of Ackee lets you view and analyse your tracked information.

Documentation

Requirements

Ackee depends on...

Make sure to install and update all dependencies before you setup Ackee.

API

Options

The following environment variables are used by Ackee. You can also create a .env file in the root of the project to store all variables in one file.

Database

MongoDB connection URI. See the MongoDB connection string spec for more detail.

MONGODB=mongodb://localhost:27017/ackee

Port

The port Ackee should listen on. Defaults to 3000.

PORT=3000

Username and password

Username and password. Both are required to generate a new token.

USERNAME=username
PASSWORD=password

TTL

Specifies how long a generated token is valid. Defaults to 3600000 (1 day).

TTL=3600000

Environment

Set the environment to development to see additional details in the console and to disable caching.

NODE_ENV=development

About

Self-hosted, Node.js based analytics tool for those who care about privacy.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 63.5%
  • CSS 36.1%
  • Dockerfile 0.4%