pub / goaccess_dashboard

Tiny tool for privacy-preserving web-analytics
git clone https://src.jayvii.de/pub/goaccess_dashboard.git
Home | Log | Files | Exports | Refs | Submodules | README | RSS

commit 22132af02745236fee0be69fedc4327cc6a6435b
parent 6e2d375c70ba364397c66c417384163d6a12e30f
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date:   Sat, 29 Jun 2024 21:32:06 +0200

feat: transform readme to markdown

Diffstat:
DREADME | 54------------------------------------------------------
AREADME.md | 56++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 56 insertions(+), 54 deletions(-)

diff --git a/README b/README @@ -1,54 +0,0 @@ -goaccess_dashboard -================== - -Please send patches or remarks to <jayvii[AT]posteo[DOT]de> - -A tiny tool based on goaccess (https://goaccess.io/) which creates a summary of -aggregated privacy preserving website traffic analytics. - -This tool tracks traffic, not people. It is unnecessary to insert tracking -code in websites. No micro-level information need to be stored whatsoever. This -tool works with purely technically necessary and minimal information that users -send to the webserver. - -The goal is to create an easy to use dashboard and web-frontend for different -weblog analytics created with goaccess. - -This tool creates analytics for all time, by year, by month, by week (and -optionally daily). - -Setup -===== - -- Go and get https://goaccess.io -- Adjust the log-output of your webserver according to the goaccess manuals. By - default, the script assumes the logs to be stored under - /var/log/apache/www.example.com_access.log -- Insert the index.html in a designated webroot. This is where your - traffic-dahsboard lives (e.g. traffic.www.example.com) -- Setup a cron-job to run create_logs-report.sh periodically - -Apache2 Configuration ---------------------- - -Snippet for the log-definition in your apache configuration: - - ErrorLog ${APACHE_LOG_DIR}/www.example.com_error.log - LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"" custom - CustomLog ${APACHE_LOG_DIR}/www.example.com_access.log custom - -Cronjob - - # |----------- minutes - # | - # | |--------- hours - # | | - # | | |------- day of month - # | | | - # | | | |----- month - # | | | | - # | | | | |--- day of week - # | | | | | - # | | | | | |- command - # | | | | | | - 0 * * * * ~/goaccess/create_logs_report.sh "www.example.com" diff --git a/README.md b/README.md @@ -0,0 +1,56 @@ +# goaccess_dashboard + +Please send patches or remarks to +[jayvii[AT]posteo[DOT]de](mailto:jayvii[AT]posteo[DOT]de) + +A tiny tool based on [goaccess](https://goaccess.io/) which creates a summary of +aggregated privacy preserving website traffic analytics. + +This tool tracks traffic, not people. It is unnecessary to insert tracking +code in websites. No micro-level information need to be stored whatsoever. This +tool works with purely technically necessary and minimal information that users +send to the webserver. + +The goal is to create an easy to use dashboard and web-frontend for different +weblog analytics created with goaccess. + +This tool creates analytics for all time, by year, by month, by week (and +optionally daily). + +## Setup + +- Go and get [goaccess](https://goaccess.io) +- Adjust the log-output of your webserver according to the goaccess manuals. By + default, the script assumes the logs to be stored under + `/var/log/apache/www.example.com_access.log` +- Insert the index.html in a designated webroot. This is where your + traffic-dahsboard lives (e.g. traffic.www.example.com) +- Setup a cron-job to run create_logs-report.sh periodically + +## Apache2 Configuration + +Snippet for the log-definition in your apache configuration: + +```apache +ErrorLog ${APACHE_LOG_DIR}/www.example.com_error.log +LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"" custom +CustomLog ${APACHE_LOG_DIR}/www.example.com_access.log custom +``` + +Cronjob: + +```cron +# |----------- minutes +# | +# | |--------- hours +# | | +# | | |------- day of month +# | | | +# | | | |----- month +# | | | | +# | | | | |--- day of week +# | | | | | +# | | | | | |- command +# | | | | | | + 0 * * * * ~/goaccess/create_logs_report.sh "www.example.com" +```