https://github.com/imranr98/pixelntfy

A simple tracking pixel generator that uses ntfy for pixel access alerts.
https://github.com/imranr98/pixelntfy

docker nodejs self-hosted tracking-pixel

Last synced: about 1 month ago
JSON representation

A simple tracking pixel generator that uses ntfy for pixel access alerts.

• Host: GitHub
• URL: https://github.com/imranr98/pixelntfy
• Owner: ImranR98
• License: gpl-3.0
• Created: 2023-03-26T08:49:44.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-03T01:21:56.000Z (5 months ago)
• Last Synced: 2024-08-03T03:14:38.943Z (5 months ago)
• Topics: docker, nodejs, self-hosted, tracking-pixel
• Language: JavaScript
• Homepage:
• Size: 107 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# PixelNtfy

A simple [tracking pixel](https://en.wikipedia.org/wiki/Web_beacon) generator that uses [ntfy](https://ntfy.sh/) for pixel access alerts.

Each pixel is associated with a tag and a timestamp that are included in the access notification. This service is stateless, meaning it has no database - pixel-associated info is stored in the pixel URL itself.

This service is meant to be self-hosted and single-user. To prevent unauthorized usage, the ntfy topic doubles as a password, and must be provided when the pixel is generated.

Environment variables needed (a `.env` file can be used for this):

- `NTFY_TOPIC`: The ntfy topic - this MUST be 32 characters long (if not provided, a topic is auto-generated and printed to the console).

- `NTFY_TOKEN`: A ntfy access token (optional).

- `NTFY_SERVER_URL`: The ntfy server URL (optional - defaults to [ntfy.sh](https://ntfy.sh)).

- `PORT`: The port to listen on (optional - defaults to `3000`).

Screenshot: