rightana

command module
v0.0.0-...-ca83848 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 4, 2019 License: GPL-3.0 Imports: 20 Imported by: 0

README

RightAna

Build Status Go Report Card

Carefree web analytics on your server

What is RightAna?

It's a self-hosted web analytics software.

How does it work?

From the user's perspective it is very similar to GA

  • register
  • add your site
  • get a tracking code
  • include it to your webpage
  • View the reports

Goals

  • Easy to install
  • Easy to use
  • Easy to upgrade (guaranteed after version 1.0)
  • One binary distribution
  • Space efficient, fast, embedded database
  • Visitor friendly (no popups, no cookie consent bar, no nonsense)
  • You don't have to sell your visitor's data to a company
  • Tracks sessions, not users
  • GDPR compliant without any annoying popup
Demo server

https://rightana.com (user: demo pass: demo1234)

Screenshots
Multiple collections

collections

Simple overview

chart

Multiple resolution and interval

resolution

Basic informations

basic-info

Multiple summaries

pages sums

GeoIP support

geoip

You can add filters

filter

You can use the bars for selecting the intervals too

bar-navigation

Watch sessions

sessions

Adding teammates

teammates

Deleting old data is easy

storage

Installation

From binary
  1. Download the latest version from the Releases section (currently only x64 linux versions)
  2. Start it and/or add to your service starter
From source
  1. Get a working Go environment
  2. Get a working Node.js environment (for building the Angular frontend)
  3. git clone https://github.com/soyersoyer/rightana.git $GOPATH/src/github.com/soyersoyer/rightana
  4. cd $GOPATH/src/github.com/soyersoyer/rightana
  5. ./build.sh
  6. Start it and/or add to your service starter

Configuration

The configuration filename is rightana.yaml (or an another format what the viper library support)

Options
Option Default Description
Listening :3000 Where should the server listen
GeoIPCityFile /var/lib/GeoIP/GeoLite2-City.mmdb GeoIP2/GeoLite2 City file
GeoIPASNFile /var/lib/GeoIP/GeoLite2-ASN.mmdb GeoIP2/GeoLite2 ASN file
DataDir data Where is the base data dir
EnableRegistration true Whether registration enabled or not
UseBundledWebApp true Whether the program should use the bundled webapp or use the frontend/dist folder
TrackingID The server's tracking ID, if you want to track it
ServerAnnounce An announce which will show on the home page
Backup The backup configuration in a map[id]dir format
AppName RightAna The application name in the mails
AppURL The application url in the mails
EmailExpiryMinutes 15 When should the keys in the emails expire
SMTPHostname localhost The SMTP server's hostname
SMTPPort 25 The SMTP server's port
SMTPUser The SMTP user
SMTPPassword The SMTP password
SMTPSender The SMTP sender

Limitations

This software is under initial development (0.x) and the database format may change in the future. In other words, it is not guaranteed that the next version of the software will be able to read the the data stored by the current version.

Coming features to 0.5

  • Compressed logs

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
api
db
Package db is a generated protocol buffer package.
Package db is a generated protocol buffer package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL