st0yanov / goaccess-docker

Docker Compose skeleton project for GDPR compliant web analytics via GoAccess.

GoAccess Docker Compose

Docker Compose skeleton project for GDPR compliant web analytics via GoAccess.

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

This project aims to provide an example Docker Compose skeleton for setting up GDPR compliant web analytics via a tracking pixel.

Built With

• Docker
• Docker Compose

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Docker
• Docker Compose

Installation

1. Clone the repo

git clone https://github.com/veskoy/goaccess-docker.git

2. Create a website configuration file

mv nginx/sites-available/example.com.conf nginx/sites-available/yoursite.com.conf

3. Alter the server_name, access_log and root values appropriately
4. Adjust the goaccess/html volume and goaccess command --log-file= inside docker-compose.yml

Usage

Run the project:

docker-compose up

Tracking pixel is accessible on http://yoursite.com/stats.gif while the analytics web interface could be found on http://yoursite.com/index.html (you can serve it wherever you want).

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

License: GPL v3

Contact

Veselin Stoyanov: