tonyalaribe / ackee

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

Ackee

Self-hosted, Node.js based analytics tool for those who care about privacy. Ackee runs on your own server, analyses the traffic of your websites and provides useful statistics in a minimal interface.

Contents

• 🏃 Get started
• 📄 Introduction
• ⚙️ Documentation

Get started

Get Ackee up and running…

• …with Docker Compose
• …with Docker
• …without Docker

And configure Ackee and your server correctly…

• …with environment variables
• …with SSL and HTTPS enabled
• …with CORS headers

Take a look at the FAQ if you have any questions left.

Introduction

What is Ackee?

Ackee is a web app you install on your server to analyse the traffic of your sites.

Why Ackee?

Ackee is lightweight, easy to install and has a good balance between analytics and privacy. It features an API and web interface and tracks only what's necessary.

It's is the right tool for you if you care about privacy and don't need a full-features marketing analytics platform like Google Analytics or Matomo.

Benefits of Ackee?

• Self-hosted
• Lightweight and easy to install
• Modern and fast architecture
• Beautiful and focused interface
• No unique user tracking and no cookies
• Fully documented API

How does it work?

You run the Ackee server which then 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...

• Node.js (v10.16 or newer)
• yarn
• MongoDB (v4.0.6 or newer)

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

API

• /
• /tokens
• /domains
• /domains/:domainId/records
• /domains/:domainId/views
• /domains/:domainId/pages
• /domains/:domainId/referrers
• /domains/:domainId/languages

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.

ACKEE_MONGODB=mongodb://localhost:27017/ackee

Port

The port Ackee should listen on. Defaults to 3000.

ACKEE_PORT=3000

Username and password

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

ACKEE_USERNAME=username
ACKEE_PASSWORD=password

TTL

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

ACKEE_TTL=3600000

Environment

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

NODE_ENV=development

More

More documentation and guides are located in the /docs folder. Also take a look at the FAQ if you have any questions left.