{"id":15148659,"url":"https://github.com/wravoc/goaccess-openbsd","last_synced_at":"2025-10-24T05:30:22.608Z","repository":{"id":188121339,"uuid":"655458670","full_name":"wravoc/goaccess-openbsd","owner":"wravoc","description":"OpenBSD theme for GoAccess Web Log analyzer with prompted ASN database download matching a pre-configured conf which excludes Web Monitoring services and also generates HTML reports. ","archived":false,"fork":false,"pushed_at":"2023-08-13T20:22:21.000Z","size":797,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-04T09:45:21.879Z","etag":null,"topics":["analytics","asn","asn-lookup","geoip","http-requests","log","logs","openbsd","security","security-tools"],"latest_commit_sha":null,"homepage":"https://www.quadhelion.engineering","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wravoc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-06-19T00:16:12.000Z","updated_at":"2024-08-06T00:28:46.000Z","dependencies_parsed_at":"2023-08-13T21:43:48.900Z","dependency_job_id":null,"html_url":"https://github.com/wravoc/goaccess-openbsd","commit_stats":null,"previous_names":["wravoc/goaccess-openbsd"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wravoc%2Fgoaccess-openbsd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wravoc%2Fgoaccess-openbsd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wravoc%2Fgoaccess-openbsd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wravoc%2Fgoaccess-openbsd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wravoc","download_url":"https://codeload.github.com/wravoc/goaccess-openbsd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237915423,"owners_count":19386724,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analytics","asn","asn-lookup","geoip","http-requests","log","logs","openbsd","security","security-tools"],"created_at":"2024-09-26T13:21:31.082Z","updated_at":"2025-10-24T05:30:22.237Z","avatar_url":"https://github.com/wravoc.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GoAccess Tools for OpenBSD 7.3\n\n[GoAccess](https://goaccess.io/) is an open source **real-time** **web log analyzer** and interactive viewer that runs in a **terminal** in *nix systems or through your **browser**.\n\nIt provides **fast** and valuable HTTP statistics for system administrators that require a visual server report on the fly.\n\n----\n\n![](images/GoAccessOpenBSDtheme.png)\n\n\n\n## Summary\n\nOpenBSD has some quirks dealing with log formats so to make it easier I have made a preconfigured *goaccess.conf* and some simple shell scripts to execute commands that work with the default package version of GoAccess provided by OpenBSD using self same conventions.\n\n# Requirements\n**Log Style Combined**\n\n1. Inside the `server` section of your `httpd.conf` add the directive `log style combined`\n\n    a.  `rcctl reload httpd`\n\n## Features\n\n* OpenBSD Themed\n\n* Prompted [ASN Database](https://www.arin.net/resources/guide/asn/) Download and Configuration Option\n\n    * Options for DB-IP, MaxMind Github \n\n* IP Exclusions for Web Monitoring \n    * [Uptime Robot](https://uptimerobot.com/?rid=d8e3c5122ea836)\n\t* UpDown.io\n\n* Simplified shell script for single and combined log reporting output to HTML\n\n  \n\n## Obtain\n\n1. `pkg_add goaccess`\n\n\n\n## Backup\n\n1. Backup `/etc/goaccess/goaccess.conf` and then put repository version in place\n\n\n\n## Execute\n\n1. `chmod 750 goaccess.sh`\n2. `goaccess` (Uses OpenBSD theme, GeoIP, ASN, and Exclusions)\n    1. Downloads database to default `/var/db/GeoIP` installed by the OpenBSD binary\n\n3. `goaccess.sh` to create an HTML report for the current access.log *(ignores goaccess.conf)*\n4. `goaccess.sh full` to combine all logs (including gzipped) into one report *(ignores goaccess.conf)*\n5. Check your `/var/log`\n    1. `goaccess-report-Month-Day.html`\n    2. `goaccess-total-report.html`\n\n\n\n## Customize\n\nAfter you've made your first reports you can choose to get more out of your logs and GoAccess\n\n1. Add your ASN provider in the `CUSTOMIZE` section *(does not permit authenticated logins)*\n\n2. Once you have downloaded the ASN database via the script edit your `/etc/goaccess/goaccess.conf`\n\n     1.  Line 839 `geoip-database /var/db/GeoIP/ASN.mmdb`\n\n3. Using with [MaxMind Data](https://www.maxmind.com/en/accounts/871098/geoip/downloads) on a free account \n\n     1.  GeoIP **Country** Data: Copy database to `/var/db/GeoIP/GeoLite2-Country.mmdb`\n\n     2.  GeoIP **City** Data: Download database to `/var/db/GeoIP/GeoLite2-City.mmdb`\n\n       1.  Insert into `goasscess.conf` line 840 `geoip-database /var/db/GeoIP/GeoLite2-City.mmdb`\n\n     3.  **MaxMind ASN** Autoupdate requires this `ASN_URL` with your **license key added** to the URL\n\n         1.  ```\n           https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-ASN\u0026license_key=YOUR_LICENSE_KEY\u0026suffix=tar.gz\n           ```\n\n4. Change shell script as needed. Add any [options](https://goaccess.io/man#options) for the shell script, some popular ones:\n     * `--exclude-ip='216.144.248.23'`\n     * `--unknowns-log=\u003cfilename\u003e`\n     * `--invalid-requests=\u003cfilename\u003e`\n\n---\n\n\n\n**LICENSE**\n\n[GoAccess Tools for OpenBSD](https://bitbucket.org/quadhelion-engineering/goaccess-openbsd) © 2023 by [Elias Christopher Griffin](https://www.eliasgriffin.com) is licensed under CC BY-NC-SA 4.0. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwravoc%2Fgoaccess-openbsd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwravoc%2Fgoaccess-openbsd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwravoc%2Fgoaccess-openbsd/lists"}