Home
Softono
shrtlin

shrtlin

Open source MIT Kotlin
Website GitHub
13
Stars
1
Forks
17
Issues
1
Watchers
10 months
Last Commit
Link Shortening & Tracking

About shrtlin

shrtlin - is an all-in-one privacy-focused self-hosted open-source URL shortener for all platforms

Platforms

Web Self-hosted Docker Android

Languages

Kotlin

Links

Website Source Code
s
Published by
samoylenkodmitry
Visit View Profile

README.md

View on GitHub

Build and Create Release GitHub Release GitHub License GitHub top language Website

Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge
yes yes yes yes yes yes yes

shrtlin

shrtlin

shrtlin is a feature-rich, open-source URL shortening service. It provides a seamless experience across Android, iOS, Web, and Desktop Linux, Mac, Windows.

About

shrtlin leverages the power of Kotlin Multiplatform to deliver a unified codebase for multiple platforms. It offers a user-friendly interface for shortening URLs and managing your links, all while ensuring secure authentication using JWT tokens and Proof of Work. Powered by a Ktor backend and PostgreSQL database.

Features

  • Easy URL shortening: Quickly shorten URLs using intuitive interfaces on Android, iOS, Web, and Desktop.
  • Seamless Authentication: Securely authenticate using JWT tokens and Proof of Work, no email, respects your privacy.
  • URL Management: View, edit, and delete your shortened URLs.
  • Cross-platform compatibility: Enjoy a consistent experience across Android, iOS, Web, and Desktop.
  • PostgreSQL database: Reliable and scalable data storage.
  • Easy deployment: Deploy the entire application on a single VPS.

Roadmap

  • Analytics: Track click-through rates and gain insights into your shortened URLs.
  • QR Codes: Generate QR codes for your shortened URLs for easy sharing.
  • Enhanced URL Management: Implement features like custom slugs, expiration dates, and more.

Getting Started

Prerequisites:

  • Your own VPS (Virtual Private Server) with Linux installed

Arch Linux Installation (Single Command):

sudo yay -S git jdk17-openjdk docker docker-compose postgresql wget unzip vim --noconfirm

Arch Linux extra preparation:


yay linux-headers #must have linux-headers installed
sudo modprobe bridge br_netfilter overlay #must have bridge and br_netfilter modules loaded
sudo systemctl enable docker
sudo systemctl start docker
systemctl status docker #check docker status
sudo usermod -aG docker $USER #add user to docker group
docker swarm init #init docker swarm for storing secrets
sudo ufw status #check firewall status, ports 80, 443 must be open

Set JAVA_HOME for oh-my-zsh (Copy-paste this into your ~/.zshrc):

export JAVA_HOME="/usr/lib/jvm/java-17-openjdk"
export PATH="$JAVA_HOME/bin:$PATH"

Steps:

TLDR
git clone https://github.com/samoylenkodmitry/shrtlin.git && cd shrtlin && chmod +x ./deploy.sh && ./deploy.sh
  1. Clone the repository: git clone https://github.com/samoylenkodmitry/shrtlin.git
  2. Ensure the prerequisites are installed and configured as described above.
  3. Build and run the application: ./deploy.sh
  4. Check environment the created .env

License

This project is licensed under the LICENSE.

Contributing

We welcome contributions from the community! Please feel free to submit issues, feature requests, or pull requests to help us improve shrtlin.