pritush/syano

An open-source free URL shortener ๐Ÿ”—. Free alternative to bitly

โ˜… 16Forks 4VueGitHub โ†—Compare

Project website โ†—

marketingmarketing-toolsmartechnuxtshortener-url

README

Syano - Self-Hosted URL Shortener | Open Source Link Management Platform

Syano is a powerful self-hosted URL shortener and open source link management platform, ready for enterprise implementation. Take complete control of your short links with advanced analytics, QR codes, link-in-bio pages, and enterprise-grade features. The best Bitly alternative for privacy-conscious teams.

License: AGPL-3.0 Node.js PostgreSQL Nuxt 3 Docker Ready

Features โ€ข Quick Start โ€ข Deploy โ€ข Documentation โ€ข Demo

Syano - Open Source URL Shortener | Product Hunt


๐ŸŒŸ Why Choose Syano as Your Self-Hosted URL Shortener?

Most URL shorteners lock you into their ecosystem โ€” your links, your data, and your analytics are controlled by someone else. Syano is different. As a fully open source URL shortener, you own everything.

Deploy in serverless or VPS infrastructure. Visit /dashboard to login and manage your links. Set login and settings from .env file.

The Problem with Cloud URL Shorteners

  • ๐Ÿšซ Your links can disappear if the service shuts down
  • ๐Ÿšซ Analytics data is sold to third parties
  • ๐Ÿšซ Pricing changes can break your budget
  • ๐Ÿšซ Limited customization and branding
  • ๐Ÿšซ No control over uptime and performance

The Syano Solution: Self-Hosted URL Shortener

  • โœ… Complete Data Ownership - Your links, your server, your rules
  • โœ… Privacy-First Architecture - No tracking, no data selling
  • โœ… Zero Recurring Costs - One-time setup, unlimited links forever
  • โœ… Enterprise Features - Multi-user access, audit logs, advanced analytics
  • โœ… Deploy Anywhere - Vercel, Netlify, Docker, VPS, or your own infrastructure
  • โœ… Open Source Forever - AGPL-3.0 licensed, community-driven development

๐Ÿ–ผ๏ธ Screenshots

Syano Dashboard - Self-Hosted URL Shortener


โœจ Complete Feature Set

Syano isn't just a URL shortener โ€” it's a comprehensive link management platform designed for teams, marketers, and developers who need professional-grade tools without the SaaS price tag.

๐Ÿ”— Advanced Link Management

Smart URL Shortening

  • Intelligent slug suggestions based on URL analysis (combines domain & path consonants for meaningful abbreviations like gla or gledr)
  • Custom slugs or auto-generated short links
  • Live preview before saving
  • Bulk import/export (JSON format)
  • Real-time search across all link metadata
  • Tag-based organization and filtering

Marketing & Campaign Tools

  • Custom TRAI India SMS compliance Sender IDs with default selection support
  • Built-in UTM parameter builder
  • Link expiration scheduling
  • Password-protected links
  • Device-specific targeting (iOS/Android)
  • Link cloaking with iframe embedding
  • Custom redirect status codes (301/302/307)

Link Organization

  • Hierarchical tag system
  • Internal comments and notes
  • Advanced search and filtering
  • Sort by clicks, date, or custom criteria
  • Batch import

๐Ÿ“Š Professional Analytics Dashboard

Analytics

  • Analytics for each link
  • 24-hour and 7-day trend analysis and customer date range
  • Export analytics data (CSV/JSON)

Geographic Intelligence

  • Country, region, and city-level tracking
  • Interactive world map visualization
  • QR Scan Analytics
  • Acquisition

Technology Analytics

  • Browser and browser version tracking
  • Operating system detection
  • Device type classification (mobile/tablet/desktop)

Marketing Attribution

  • Full UTM parameter tracking
  • Referrer source analysis
  • Acquisition channel breakdown

Analytics

  • Activity heatmap (day ร— hour)
  • Peak traffic time identification
  • Click pattern analysis
  • Recent events feed with real-time updates
  • QR code scan tracking (separate from web clicks)

๐ŸŽจ QR Code Generator

Professional QR Codes

  • Instant QR code generation for every link
  • SVG format (scalable, print-ready)
  • PNG export for digital use
  • Server-side rendering with 7-day caching
  • Automatic QR scan tracking

Use Cases

  • Print marketing materials
  • Event tickets and badges
  • Product packaging
  • Restaurant menus
  • Business cards

๐ŸŒ Link-in-Bio Pages

Personal Landing Pages

  • Customizable bio page on your home page
  • Profile photo and initials
  • Bio text and description
  • Unlimited custom links
  • Social media icon row (20+ platforms)

Link Customization

  • Custom titles and subtitles
  • Icon selection from curated library
  • Color accent customization
  • Drag-and-drop reordering
  • Show/hide individual links

Homepage Modes

  • Default Syano landing page
  • Custom redirect with delay
  • Link-in-bio page
  • Instant switching via dashboard

๐Ÿ‘ฅ Multi-User & Team Management

User Access Control

  • Unlimited dashboard users
  • Individual user accounts with secure authentication
  • Enable/disable users without deletion
  • User activity tracking in audit logs

Granular Permission System

  • 4 preset roles: Viewer, Editor, Manager, Admin
  • 10+ individual permissions
  • Custom permission combinations
  • Role-based access control (RBAC)
  • Permission inheritance

๐Ÿ”Œ REST API

Programmatic Access

  • Full REST API for link management
  • API key authentication with granular permissions
  • OpenAPI-compatible endpoints
  • Modern API documentation and API playground using Scalar

API Features

  • Create, read, update, delete links
  • Bulk link creation
  • Analytics data export
  • Tag management
  • Search across links

Integration Examples

  • Zapier workflows
  • Make.com (Integromat) scenarios
  • n8n automation
  • Custom applications
  • CI/CD pipelines
  • Slack/Discord notifications

โšก Performance & Infrastructure

Supported Databases:

  • PostgreSQL (local or self-hosted)
  • Neon (serverless PostgreSQL)
  • Supabase (PostgreSQL as a service)
  • Aiven (managed PostgreSQL)
  • AWS RDS, Google Cloud SQL, Azure Database
  • Docker PostgreSQL containers

๐ŸŽจ User Experience

Modern Interface

  • Clean, intuitive dashboard
  • Full dark mode support
  • Responsive design (mobile, tablet, desktop)
  • Real-time updates

Developer Experience

  • TypeScript throughout
  • Type-safe database queries (Drizzle ORM)
  • Comprehensive API documentation
  • Easy local & cloud setup
  • One click database update
  • Easy database migration from dashboard

๐Ÿš€ Quick Start Guide

Get your self-hosted URL shortener running in under 5 minutes.

Prerequisites

  • Node.js 18 or higher
  • PostgreSQL 14 or higher
  • pnpm (recommended)

Installation Steps

1. Clone the Repository

git clone https://github.com/pritush/syano.git
cd syano
pnpm install

2. Configure Environment Variables

cp .env.example .env

Edit .env with your configuration:

# Database Connection
# For serverless (Netlify/Vercel): Use Neon pooled connection
DATABASE_URL=postgresql://user:[email protected]/db?sslmode=require

# For traditional servers (VPS/Docker): Use direct connection
# DATABASE_URL=postgresql://user:pass@localhost:5432/syano

# Authentication (for login /dashboard)
NUXT_SITE_TOKEN=your-secure-random-token-here
NUXT_SITE_USER=root

# Optional: Connection Pool Tuning
# DB_POOL_MAX=20
# DB_POOL_MIN=2

# Optional: Application Settings
# NUXT_CACHE_TTL=30
# NUXT_REDIRECT_STATUS_CODE=301
# NUXT_PUBLIC_SLUG_DEFAULT_LENGTH=6

3. Set Up Database

Option A: Local PostgreSQL

createdb syano
psql -d syano -f database/schema.sql

Option B: Docker PostgreSQL

docker run -d \
  --name syano-db \
  -e POSTGRES_PASSWORD=password \
  -e POSTGRES_DB=syano \
  -p 5432:5432 \
  postgres:16-alpine

docker exec -i syano-db psql -U postgres -d syano < database/schema.sql

Option C: Cloud Database (Neon, Supabase)

# Copy the SQL from database/schema.sql and run it in your cloud database console
# Or use psql with your cloud connection string
psql -d "your-cloud-connection-string" -f database/schema.sql

Verify Database Setup:

pnpm run db:check-audit

4. Start Development Server

pnpm dev

Visit http://localhost:7466 and login with your NUXT_SITE_TOKEN.


๐ŸŒ Deployment Options

Deploy your self-hosted URL shortener to any platform in minutes.

Serverless Platforms (Recommended)

Netlify

# Install Netlify CLI
npm install -g netlify-cli

# Deploy
pnpm run build
netlify deploy --prod

Environment Variables:

  • DATABASE_URL - Use Neon pooled connection (-pooler suffix)
  • NUXT_SITE_TOKEN - Your secure token
  • NUXT_SITE_USER - Admin username (default: root)
  • NUXT_PUBLIC_SITE_URL - your domain where the script is hosted

Vercel

Deploy with Vercel

๐ŸŽฏ Use Cases

For Marketers

  • Track campaign performance with UTM parameters
  • A/B test different landing pages
  • Monitor geographic reach
  • Analyze device and browser trends
  • Generate QR codes for offline campaigns

For Developers

  • Self-hosted alternative to Bitly, TinyURL, Short.io
  • REST API for programmatic link creation
  • Webhook integrations with Zapier, Make.com, n8n
  • Custom domain support
  • White-label solution
  • CI/CD pipeline integration
  • Automated link generation from deployments

For Teams

  • Multi-user access with role-based permissions
  • Audit logs for compliance
  • Centralized link management
  • Team collaboration features
  • Secure password-protected links

For Content Creators

  • Link-in-bio pages for social media
  • Track audience engagement
  • Organize links by campaign or topic
  • Professional QR codes for merchandise
  • Analytics for content performance

๐Ÿ› ๏ธ Technology Stack

Frontend:

Backend:


๐Ÿ”’ Security & Privacy

Data Privacy

  • No Third-Party Tracking - Your data never leaves your server
  • No Analytics Selling - Your insights remain private
  • Self-Hosted - Complete data sovereignty

๐Ÿ“Š Live Demo

Experience Syano in action:

Demo Instance: https://syano.vercel.app

Test Links:


Reporting Issues

Found a bug or have a feature request? Open an issue on GitHub.


๐Ÿ“„ License

Syano is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

This means:

  • โœ… Free to use, modify, and distribute
  • โœ… Open source forever
  • โœ… Commercial use allowed
  • โš ๏ธ Must disclose source code if you modify and deploy

See the LICENSE file for full details.

Alternatives Comparison

Syano vs. other URL shorteners:

  • vs. Bitly - Self-hosted, no monthly fees, unlimited links
  • vs. TinyURL - Advanced analytics, team management, audit logs
  • vs. Short.io - Open source, full data ownership, no vendor lock-in
  • vs. Rebrandly - Free forever, customizable, privacy-first

๐Ÿ’ก Frequently Asked Questions

Is Syano really free?

Yes! Syano is 100% free and open source under the AGPL-3.0 license. No hidden costs, no premium tiers, no feature limitations.

Can I use my own domain?

Absolutely! Deploy Syano on any domain you own. Perfect for branded short links like yourbrand.link/promo.

How many links can I create?

Unlimited. There are no artificial limits on links, clicks, or users.

Is it suitable for production use?

Yes! Syano is production-ready with features like connection pooling, caching, health checks, and audit logging.

Can I migrate from Bitly or other services?

Yes! Use the bulk import feature to migrate your existing links. Export from your current service and import into Syano.

What about performance at scale?

Syano is optimized for performance with database indexing, connection pooling, and caching. It handles thousands of redirects per second on modest hardware.

Do I need coding knowledge?

Basic command-line knowledge is helpful for deployment, but the dashboard is user-friendly and requires no coding.

Can I customize the look and feel?

Yes! Syano is fully customizable. Modify the source code, add your branding, or contribute themes back to the community.


Project by Pritush

โญ Star us on GitHub if you find Syano useful!

Self-Hosted URL Shortener โ€ข Open Source Link Management โ€ข Privacy-First Analytics

Get Started โ€ข View Demo โ€ข Read Docs

Made with โค๏ธ for the open source community

Contributors

pritush

Issues