Skip to content

ShortlinkerMinimalist URL Shortening Service

Supports HTTP 307 redirects, built with Rust, easy deployment and fast response

Shortlinker

⚠️ v0.3.x Version Notice

The current version (v0.3.x) is undergoing significant feature adjustments and refactoring with frequent updates, which may include API changes or functionality modifications.

Recommendations:

  • 📌 Production: Use stable version tags (e.g., v0.2.x)
  • 🔄 Development: Follow the latest version to experience new features
  • 📖 Documentation: Documentation may lag behind code implementation; actual functionality prevails
  • 🐛 Issue Reporting: Please report issues via GitHub Issues

Design Philosophy

Minimalism

Focus on the core functionality of short link redirection with simple configuration and fast deployment

High Performance

Native Rust performance guarantee, SQLite provides production-grade database performance, asynchronous concurrent processing

Easy to Use

Command line tool management, environment variable configuration, one-click Docker deployment

Core Features

  • Multiple Storage Backends: SQLite database (default), PostgreSQL, MySQL, MariaDB for production-grade performance
  • Admin API: HTTP API management interface with authentication and custom route prefix support
  • Health Monitoring: Complete health check API with storage status and runtime monitoring
  • Smart Expiration: Supports flexible time format settings, automatic expiration and cleanup
  • Cross-platform Support: Windows, Linux, macOS, smart process locking to prevent duplicate startup
  • Container Optimization: Docker image deployment with container restart detection support
  • TUI Interface: Terminal user interface for interactive management and monitoring
  • TOML Configuration: Modern configuration file support with environment variable overrides

Quick Experience

bash
# One-click Docker startup
docker run -d -p 8080:8080 e1saps/shortlinker

# Add short link
./shortlinker add github https://github.com

# Access short link
curl -L http://localhost:8080/github

# Launch TUI interface (if compiled with TUI feature)
./shortlinker tui

Use Cases

  • Marketing Promotion: Event links, social media sharing
  • Internal Tools: Document redirection, system integration
  • Temporary Links: Time-limited sharing, test environment
  • API Services: Link management between microservices

Get Started

Ready to go? Check out the Quick Start Guide to begin with Shortlinker More modules: Web Admin Panel | Cloudflare Worker Version.

Released under the MIT License