vince

command module
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Oct 3, 2024 License: AGPL-3.0 Imports: 4 Imported by: 0

README

Vince Logo
Website | Install

vince

Vince is a privacy friendly web analytics server focused on painless self hosting.

Vince Analytics

Installation

Vince ships a single executable without any dependencies.

Installing

MacOS and Linux

curl -fsSL https://vinceanalytics.com/install.sh | bash

Docker

docker pull ghcr.io/vinceanalytics/vince

From source

go install github.com/vinceanalytics/vince@latest

Download

see release page

Checking installation

vince --version

Start vince

vince serve --adminName=acme \
  --adminPassword=1234\
  --adminEmail=trial@vinceanalytics.com \
  --domains=vinceanalytics.com \
  --license=path/to/license_key

This command will start vince on localhost:8080.

FAQ

How do I bypass license key?

use vince crack command to patch license key, you can choose how long you want the cracked key to be valid with --expires flag.

NAME:
   vince crack - Cracks vince license key

USAGE:
   vince crack [command [command options]] 

DESCRIPTION:
   Allows users to use vince without a valid license key.
       # vince crack /path/to/vince/data

OPTIONS:
   --expires value  Duration of the patched license (default: 24h0m0s)
   --help, -h       show help (default: false)

example: Assuming your data directory is vince-data

❯ vince crack vince-data
VINCE_ADMIN_EMAIL        Expires                              
crack@vinceanalytics.com 2024-10-04 06:52:01.123432 +0000 UTC 

After running the command, start vince with f --adminEmail=crack@vinceanalytics.com. You can omit the --license flag.

This only works when running vince with persistence storage

Credit

Plausible Analytics : vince started as a Go port of plausible with a focus on self hosting.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
gen
internal
cmd
features
Package features exposes features allowed on the vince instance.
Package features exposes features allowed on the vince instance.
geo
ref
ro2
ua
ua2
DO NOT EDIT Code generated by ua/bot/make_bot.go
DO NOT EDIT Code generated by ua/bot/make_bot.go
web
tools

Jump to

Keyboard shortcuts

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