gohits

GoHits visitor counter

Description

An easy way to track your page or project views ("hits") of any GitHub or online project.

Generate your own: hits.webklex.com

Table of Contents

• Features
• Installation
• Configuration
  • HTTP & HTTPS
  • Letsencrypt
  • Middlewares & Extensions
  • Rate limiting & Quota management
  • Logging
  • Additional
• Api
  • Output
    • CSV
    • XML
    • JSON
  • Websocket
• Build
• Service
• Support
• Security
• Credits
• License

Features

• Serving over HTTPS (TLS) using your own certificates, or provisioned automatically using LetsEncrypt.org
• HSTS ready to restrict your browser clients to always use HTTPS
• Configurable read and write timeouts to avoid stale clients consuming server resources
• Reverse proxy ready
• Configurable CORS to restrict access to specific domains
• Configurable api prefix to serve the API alongside other APIs on the same host
• Optional round trip optimization by enabling TCP Fast Open
• Integrated rate limit (quota) for your clients (per client IP) based on requests per time interval; several backends such as in-memory map (for single instance), or redis or memcache for distributed deployments are supported

Installation

Download and unpack a fitting pre-compiled binary or build a binary yourself by by following the build instructions.

Continue by configuring your application:

gohits -http=:8080 -gui gui -save

Open a browser and navigate to http://localhost:8080/ to verify everything is working.

Please take a look at the available options for further details.

Server Options

To see all the available options, use the -help option:

gohits -help

                    |

HTTP & HTTPS

Letsencrypt

Middlewares & Extensions

Logging

Additional

If you're using LetsEncrypt.org to provision your TLS certificates, you have to listen for HTTPS on port 443. Following is an example of the server listening on 2 different ports: http (80) and https (443):

gohits \
    -http=:8080 \
    -https=:8443 \
    -hsts=max-age=31536000 \
    -letsencrypt \
    -letsencrypt-hosts=example.com \
    -gui gui \
    -save

$ cat conf/settings.config
{
    "HTTP": ":8080",
    "HTTPS": ":8443",
    "HSTS": "max-age=31536000",
    "LETSENCRYPT": true,
    "LETSENCRYPT_HOSTS": "example.com",
    ...

By default, HTTP/2 is enabled over HTTPS. You can disable by passing the -http2=false flag.

If the web server is running behind a reverse proxy or load balancer, you have to run it passing the -use-x-forwarded-for parameter and provide the X-Forwarded-For HTTP header in all requests. This is for the gohits web server be able to log the client IP, and to perform correctly identify new hits.

API

The API is served by endpoints that encode the response in different formats.

curl :8080/json/{username}/{repository}

Same semantics are available for the /xml/{username}/{repository} and /csv/{username}/{repository} endpoints.

Output

Section

CSV

curl :8080/csv/webklex/gohits

webklex,gohits,55,2020-09-11 07:01:23,2020-09-12 00:10:07

XML

curl :8080/xml/webklex/gohits

<Section>
    <Username>webklex</Username>
    <Repository>gohits</Repository>
    <Total>55</Total>
    <CreatedAt>2020-09-11T07:01:23.252745204+02:00</CreatedAt>
    <UpdatedAt>2020-09-12T00:10:07.7275806+02:00</UpdatedAt>
</Section>

JSON

curl :8080/json/webklex/gohits

{
  "username": "webklex",
  "repository": "gohits",
  "total": 55,
  "created_at": "2020-09-11T07:01:23.252745204+02:00",
  "updated_at": "2020-09-12T00:10:07.7275806+02:00"
}

Websocket

Url: :8080/ws

You can subscribe to specific channels or to all in order to receive all recent hits.

Payloads:

Subscribe to channel all:

{
  "name": "subscribe",
  "payload": "all"
}

Subscribe to channel webklex/gohits:

{
  "name": "subscribe",
  "payload": "webklex/gohits"
}

Delete a the subscription of all:

{
  "name": "unsubscribe",
  "payload": "all"
}

Output

00:26:07 webklex/gohits

Build

You can build your own binaries by calling build.sh

build.sh build_dir

Service

Create a new file like /etc/systemd/system/gohits.service and add the following:

[Unit]
Description=GoHits
After=multi-user.target
After=syslog.target
After=network-online.target

[Service]
Type=simple

User=www-data
Group=www-data

WorkingDirectory=/opt/gohits
ExecStart=/opt/gohits/gohits

Restart=on-failure
RestartSec=5s

[Install]
WantedBy=multi-user.target

Start the service and check for any errors.

systemctl start gohits.service

Features & pull requests

Everyone can contribute to this project. Every pull request will be considered but it can also happen to be declined. To prevent unnecessary work, please consider to create a feature issue first, if you're planning to do bigger changes. Of course you can also create a new feature issue if you're just wishing a feature ;)

Off topic, rude or abusive issues will be deleted without any notice.

Support

If you encounter any problems or if you find a bug, please don't hesitate to create a new issue. However please be aware that it might take some time to get an answer.

If you need immediate or commercial support, feel free to send me a mail at github@webklex.com.

Change log

Please see CHANGELOG for more information what has changed recently.

Security

If you discover any security related issues, please email github@webklex.com instead of using the issue tracker.

Credits

• Webklex
• All Contributors

License

The MIT License (MIT). Please see License File for more information.