Self-hosted website analytics tool written in Node.js.
Switch branches/tags
Nothing to show
Clone or download
electerious Merge pull request #34 from DanielRuf/ci/install-windows-build-tools
ci: install windows-build-tools for building node-sass from source
Latest commit 86d0af5 Nov 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs /domains/:domainId/views Sep 1, 2018
src Fixed typos Nov 4, 2018
test Fix test Oct 7, 2018
.gitignore Remove .DS_Store from .gitignore Aug 25, 2018
.travis.yml ci: install windows-build-tools for building node-sass from source Oct 29, 2018
CHANGELOG.md Update changelog headline naming Oct 3, 2018
README.md Update badges Nov 4, 2018
package.json Added engines to package.json Oct 29, 2018

README.md

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.

Contents

Get started

Get started with Ackee »

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
  • Respects the privacy settings of your users
  • No unique user tracker 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/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