Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/soyersoyer/rightana

Web analytics on your server
https://github.com/soyersoyer/rightana

analytics angular angular6 boltdb geoip golang self-hosted tracker tracking web web-analytics webanalytics

Last synced: 4 days ago
JSON representation

Web analytics on your server

Awesome Lists containing this project

README

        

# RightAna
[![Build Status](https://travis-ci.org/soyersoyer/rightana.svg?branch=master)](https://travis-ci.org/soyersoyer/rightana)
[![Go Report Card](https://goreportcard.com/badge/github.com/soyersoyer/rightana?)](https://goreportcard.com/report/github.com/soyersoyer/rightana)

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](https://rightana.com) (user: demo pass: demo1234)

### Screenshots

### Multiple collections
![collections](https://user-images.githubusercontent.com/5169997/42170576-3714edec-7e17-11e8-9ae9-f7909f112c43.png)

### Simple overview
![chart](https://user-images.githubusercontent.com/5169997/34117162-1f82043a-e41b-11e7-9ff5-72a0d82f1bfb.png)

### Multiple resolution and interval
![resolution](https://user-images.githubusercontent.com/5169997/34116446-f7ae1018-e418-11e7-9b12-159160aef5f6.png)

### Basic informations
![basic-info](https://user-images.githubusercontent.com/5169997/34116575-5484cf84-e419-11e7-8423-d9c9c769def5.png)

### Multiple summaries
![pages](https://user-images.githubusercontent.com/5169997/34116643-81d16ae2-e419-11e7-9547-1bf1d1c25879.png)
![sums](https://user-images.githubusercontent.com/5169997/34116646-83392fc8-e419-11e7-84b0-2331a7d84eb9.png)

### GeoIP support
![geoip](https://user-images.githubusercontent.com/5169997/34117762-f5268006-e41c-11e7-8ea3-34722e057fea.png)

### You can add filters
![filter](https://user-images.githubusercontent.com/5169997/34116771-d6d3328c-e419-11e7-8631-98910fda9dcb.png)

### You can use the bars for selecting the intervals too
![bar-navigation](https://user-images.githubusercontent.com/5169997/34116997-8ee17c44-e41a-11e7-874b-b83719136cad.png)

### Watch sessions
![sessions](https://user-images.githubusercontent.com/5169997/34117093-e0f252d8-e41a-11e7-8811-5c90d73560b5.png)

### Adding teammates
![teammates](https://user-images.githubusercontent.com/5169997/34117250-6577d690-e41b-11e7-9931-2c3ccca01b91.png)

### Deleting old data is easy
![storage](https://user-images.githubusercontent.com/5169997/34117249-6558a39c-e41b-11e7-9fb1-5c184e52fbb9.png)

## Installation

### From binary

1. Download the latest version from the [Releases](https://github.com/soyersoyer/rightana/releases) section (currently only x64 linux versions)
1. Start it and/or add to your service starter

### From source

1. Get a working Go environment
1. Get a working Node.js environment (for building the Angular frontend)
1. `git clone https://github.com/soyersoyer/rightana.git $GOPATH/src/github.com/soyersoyer/rightana`
1. `cd $GOPATH/src/github.com/soyersoyer/rightana`
1. `./build.sh`
1. 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