Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.84 KB

README.md

File metadata and controls

41 lines (25 loc) · 1.84 KB

VisitLog

A very simple analytics service with no dependencies, written in golang. This is what I run on my blog/homepage to keep track of visits. I could use a third-party analytics service but I abhore sending data about my users to random companies.

I am not really expected that this will meet anyone elses needs. If you are looking for a full featured analytics package then better options exist.

You can see the data that visitlog collects: sheep.horse Visitor Statistics

Goals

  • Completely stand alone service - a single executable with no compile time or run time dependencies. Requires no database or thirdparty libraries.
  • Very light data gathering. Does not collect information about the user apart from the fact that they visited the page. Does not collect IPs or browser data. No attempt is made to track recurring visits.
  • Self-hosted
  • Very simple data structures
  • Easily modifiable
  • Safe and secure
  • Reasonably scalable, where "reasonably" means able to handle say 10000 hits per day. This is pathetic for big sites but more than enough for my needs.

See this blog post for my initial rationale.

Installation

Compile the project. The linuxbuild.sh file provides a simple way to compile using a docker container but compiling natively should be as simple as go build.

Copy the executable to wherever you want to run it from.

Create a file named visitlogdb in the same directory. Edit it so that it contains a simple empty json object.

{}

This is somewhat of a misfeature. Visitlog should create this file itself on first startup.

A systemd .service file is provided in the systemd directory.

Undocumented Features

This functionality exists but is so far undocumented.

  • Quizzes