LinkLogger is an extremely simple and public link shortener and IP logger. Every visit to a registered short link will log the user's IP address, location, user agent, browser, and OS before redirecting them to a specific URL.

The API is built on FastAPI, and the UI is built with React. NOTE: I am NOT a front-end dev, so don't expect much on that. 😅

Feel free to submit an issue for any problems you experience or if you have an idea for a new feature. If you have a fix for anything, feel free to submit a pull request for review.

TL;DR: LinkLogger is like Grabify, but unrestricted and with a rudimentary UI.

API Reference

You can view the full API reference and try out the endpoints on the docs page.

Want to Self-Host?

Docker

Docker is the recommended method of hosting LinkLogger. Running on bare metal is recommended for development.

To run LinkLogger on Docker, check out the docker-compose.yaml file.

Bare metal

If you want to work on the LinkLogger source, or just want to run the project on bare metal, follow the instructions below:

Install python3.10 & pip (other python versions may work, but are currently untested)
Install Node.js
Install Yarn
Install API dependencies (pip install -r requirements.txt)
Run either linklogger.sh (Linux/MacOS) or linklogger.bat (Windows)

NOTE: Running on bare metal means there is not an NGINX instance to serve the UI and proxy API requests to port 5252.

Configuration

Below are all of the configuration variables that are used within the LinkLogger config.yaml file.

Variable	Description	Requirement
`IP_TO_LOCATION`	`BOOLEAN`: Whether or not you want the IP-to-Location feature. (requires IP2Location.io account)	Required
`API_KEY`	`API KEY`: IP2Location.io API Key	Required (only if `IP_TO_LOCATION` is set to `True`)

Languages

Python 47.6%

TypeScript 33%

CSS 8.1%

Shell 4.6%

Batchfile 3.7%

Other 3%