109 lines
2.7 KiB
Groff
109 lines
2.7 KiB
Groff
.\" Automatically generated by Pandoc 2.19.2
|
|
.\"
|
|
.\" Define V font for inline verbatim, using C font in formats
|
|
.\" that render this, and otherwise B font.
|
|
.ie "\f[CB]x\f[]"x" \{\
|
|
. ftr V B
|
|
. ftr VI BI
|
|
. ftr VB B
|
|
. ftr VBI BI
|
|
.\}
|
|
.el \{\
|
|
. ftr V CR
|
|
. ftr VI CI
|
|
. ftr VB CB
|
|
. ftr VBI CBI
|
|
.\}
|
|
.TH "NICOLE" "1" "April 2022" "nicole 2.0" ""
|
|
.hy
|
|
.SH NAME
|
|
.PP
|
|
\f[B]R\f[R]uling \f[B]E\f[R]mpress \f[B]G\f[R]enerating
|
|
\f[B]I\f[R]n-depth \f[B]N\f[R]ginx \f[B]A\f[R]nalytics (obviously)
|
|
Regina is an analytics tool for nginx.
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\f[B]regina\f[R] \[em]-config CONFIG_FILE [OPTION\&...]
|
|
.SH DESCRIPTION
|
|
.PP
|
|
It collects information from the nginx access.log and stores it in a
|
|
sqlite3 database.
|
|
Regina supports several data visualization configurations and can
|
|
generate an admin-analytics page from an html template file.
|
|
.SS Command line options
|
|
.TP
|
|
\f[B]-h\f[R], \f[B]\[em]-help\f[R]
|
|
Show the the possible command line arguments
|
|
.TP
|
|
\f[B]-c\f[R], \f[B]\[em]-config\f[R] config-file
|
|
Retrieve settings from the config-file
|
|
.TP
|
|
\f[B]\[em]-access-log\f[R] log-file
|
|
Overrides the access_log from the configuration
|
|
.TP
|
|
\f[B]\[em]-collect\f[R]
|
|
Collect information from the access_log and store them in the databse
|
|
.TP
|
|
\f[B]\[em]-visualize\f[R]
|
|
Visualize the data from the database
|
|
.TP
|
|
\f[B]\[em]-update-geoip\f[R] geoip-db
|
|
Recreate the geoip part of the database from the geoip-db csv.
|
|
The csv must have this form: lower, upper, country-code, country-name,
|
|
region, city
|
|
.SH INSTALLATION AND UPDATING
|
|
.PP
|
|
To update regina, simply follow the installation instructions.
|
|
.SS pacman (Arch Linux)
|
|
.PP
|
|
Installing regina using the Arch Build System also installs the man-page
|
|
and a zsh completion script, if you have zsh installed.
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
git clone https://github.com/MatthiasQuintern/regina.git
|
|
cd regina
|
|
makepkg -si
|
|
\f[R]
|
|
.fi
|
|
.SS pip
|
|
.PP
|
|
You can also install regina with python-pip:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
git clone https://github.com/MatthiasQuintern/regina.git
|
|
cd regina
|
|
python3 -m pip install .
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
You can also install it system-wide using
|
|
\f[V]sudo python3 -m pip install .\f[R]
|
|
.PP
|
|
If you also want to install the man-page and the zsh completion script:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
sudo cp regina.1.man /usr/share/man/man1/regina.1
|
|
sudo gzip /usr/share/man/man1/regina.1
|
|
sudo cp _regina.compdef.zsh /usr/share/zsh/site-functions/_regina
|
|
sudo chmod +x /usr/share/zsh/site-functions/_regina
|
|
\f[R]
|
|
.fi
|
|
.SH CHANGELOG
|
|
.SS 1.0
|
|
.IP \[bu] 2
|
|
Initial release
|
|
.SH COPYRIGHT
|
|
.PP
|
|
Copyright \[co] 2022 Matthias Quintern.
|
|
License GPLv3+: GNU GPL version 3 <https://gnu.org/licenses/gpl.html>.
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
This is free software: you are free to change and redistribute it.
|
|
There is NO WARRANTY, to the extent permitted by law.
|
|
.SH AUTHORS
|
|
Matthias Quintern.
|