Skip to content

Latest commit

 

History

History
114 lines (91 loc) · 3.42 KB

README.md

File metadata and controls

114 lines (91 loc) · 3.42 KB
Raw

Docker GoAccess

Based on GregYankovoy/docker-goaccess

This is an Alpine linux container which builds GoAccess including GeoIP. It reverse proxies the GoAccess HTML files and websockets through nginx, allowing GoAccess content to be viewed without any other setup.

Features

  • Uses S6 overlay.
  • GoAccess builds from master branch. allinurl/goaccess.
  • Supports .gz and access.log.* files. Thanks to PR#16.
  • Automatic GeoIP2 city and ASN database updation. Runs every Sunday at 00:00.

Supported Architectures

Simply pulling ghcr.io/niniyas/docker-goaccess:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

Also available on quay quay.io/niniyas/docker-goaccess:latest

Architecture Tag
x86-64 amd64
arm64 arm64
armhf armv7

Usage

docker run

docker run -d --name GoAccess -p 7889:7889 -e MAXMINDDB_LICENSE_KEY=<license-key> -e TZ=Europe/Brussels -e PUID=1000 -e PGID= 1000 -v /path/to/host/nginx/logs:/opt/log -v /path/to/goaccess/storage:/config ghcr.io/niniyas/docker-goaccess:latest

docker compose

version: '3.9'
services:
  goaccess:
    container_name: GoAccess
    #build:                                    #
    #  context: .                              #
    #  dockerfile: Dockerfile                  # - If you want to build.
    #  args:                                   #
    #      OVERLAY_ARCH:                       #
    image: ghcr.io/niniyas/docker-goaccess:latest
    ports:
      - 7889:7889
    volumes:
      - .config:/config
      - .goaccess/logs:/opt/log
    environment:
      - PUID=1000
      - PGID=1000
      - UMASK=022
      - MAXMIND_LICENSE_KEY=<license-key>
      - TZ=Europe/Brussels

Variables

  • MAXMIND_LICENSE_KEY
    • License key to automatically download and update GeoIP2 database. Get it for free here. Optional
  • TZ
    • Timezone. View available values here. Default is Europe/Brussels. Optional
  • PUID
    • User ID. Optional
  • PGID
    • Group ID. Optional
  • Umask
  • TINI_VERBOSITY
    • Set to 1 if you want to don't want supress tini output. Default is 0. Optional
  • INCLUDE_ALL_LOGS
    • Include all logs under /opt/log such as .gz and access.log.* files. true|false. Default is false. Optional

Files

  • /config/goaccess.conf
    • GoAccess config file (populated with modified config.)
  • /config/html
    • GoAccess generated static HTML
  • /config/GeoIP
    • GeoIP2 databases and cron log location.

Volume Mounts

  • /config
    • Used to store configuration and GoAccess generated files
  • /opt/log
    • Map to nginx log directory

Reverse Proxy

nginx

    location / {
        proxy_connect_timeout 5m;
        proxy_send_timeout 5m;
        proxy_read_timeout 5m;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Connection "keep-alive";
        proxy_pass_request_headers on;
        proxy_http_version 1.1;

        proxy_pass http://192.168.1.2:7889;
    }