.github | ||
.gitattributes | ||
CONTRIBUTING.md | ||
LICENSE | ||
README.md |
Awesome YOURLS
A curated list of awesome things related to YOURLS
Contents
- Official Links - Official guides and tools
- Plugins - what makes YOURLS so versatile and powerful. Currently: 193 plugins listed.
- Themes - to customize how YOURLS looks
- Translations - YOURLS in your language
- Integrations - Third-party integrations and frameworks
- Guides & tutorials - Community resources
- Showcases - Inspiration and celebrity endorsements
Something missing or incorrect? Want to get your work listed? See how you can contribute!
Official Links
Official material from the YOURLS team :
Official tools from the YOURLS team :
- YOURLS using Docker
- YOURLS using Helm for Kubernetes
- Sample YOURLS plugin
- YOURLS plugins using Composer
- YOURLS test suite for plugins
Plugins
All known plugins: they are either from the community, or from the YOURLS team (marked with a ☑️). Plugins featuring there own unit tests have the 🧪 icon.
Currently we have 193 plugins listed.
Willing to get your plugins featured here? Please contribute!
Jump to 0-9 | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z
0-9
- 302-Instead - Send a 302 (temporary) redirect instead of 301 (permanent), for sites where shortlinks may change.
- 302-Instead - A fork of previous plugin, with some more options.
- 404 If Not Found ☑️ - Give a 404 Not Found if the short URL is not found.
A
- AAF Rapid Connect auth - AAF Rapid Connect authentication plugin for YOURLS.
- Abuse Desk for YOURLS - A Google Safe Browsing implementation for YOURLS to avoid spam links.
- Access Control Allow Origin - Prevents CORS issue with domain CNAMES and aliases for admin actions.
- Additional Charsets - Define additional character sets for short URLs.
- Admin Issue Diagnostic - A.I.D. - Collects YOURLS environmentals and formats a template to copy/paste into a YOURLS issue.
- Admin NoReCAPTCHA - Protect logins with Google's No CAPTCHA reCAPTCHA (Google's ReCAPTCHA v2.0).
- Admin reCaptcha - Spam protection for private YOURLS admin interface with reCaptcha.
- Advanced Reserved URLs - Extends the reserved word functionality, blocking short URLs containing reserved words, even if mixed case or written in leetspeak.
- Allow Aliases - Allow YOURLS to work with alias hostnames for the server.
- Allow Forward Slashes in Short URLs - Just as the name says.
- Allow Full Stops in Short URLs - This plugin will allow full stops
.
in keywords when shortening URLS. - Always-302 - A newer alternative to 302-Instead.
- Amazon Affiliate - Adds your Amazon Affiliate Tag to all Amazon URLs before redirection.
- Amazon Affiliate With Notice - Adds your Amazon Affiliate Tag to all Amazon URLs before redirection with a notice of Amazon Affiliate link usage.
- Anonymise - Anonymise the log data that YOURLS captures.
- Antispam ☑️ - Merciless antispam plugin using the 3 major domain blacklists.
- YOURLS APC Cache - Add support for APC to reduce MySQL queries.
- API Action ☑️ - Example plugin for YOURLS 1.6+ to show how to implement custom API actions.
- API Contract - API action opposite to "expand": check if a URL has been shortened before
- API Delete - Add a "delete" action to the API.
- API Edit URL - Add an "update" action to the API to edit a URL, and a "geturl" action to get the long URL of a short URL.
- API List All - Add a "list" action to the API to show all keywords.
- Append Query String - Appends the query string to a long URL.
- Auth Manager - Assign users to roles like "Editor" and "Contributor" to limit the changes they are permitted to make (edit URLs, manage plugins...).
- Auth Manager Plus - Seperates user data & manages authorization with role-based access controls (RBAC).
- Auto Login ☑️ - Automatically populate login/password with test/test (for test installs).
B
- Blacklist Domains - A simple plugin to blacklist domains from shortening URLs.
- Blacklist IPs - A simple plugin to blacklist IPs from shortening URLs.
- Bulk Import and Shorten - Import links from a CSV file.
- Bulk URL Shortening - Shortening of multiple URLs with one API request.
C
- cAuth - Client side SSL certificate authentication for admin pages.
- Cache Stat Pages ☑️ - Serve stat pages (
http://sho.rt/blah+
) from cache. - CAS Plugin - Enable authentication through a CAS server.
- Case Insensitive - Makes all keywords case insensitive (creates and calls all keywords lowercase).
- Case Insensitive - Make YOURLS case insensitive: if you create
http://sho.rt/MyLink
, then variations likemylink
orMYLINK
will redirect to the same URL. - Change Error Messages - Changes the error message when a keyword or URL already exists and displays the long URL.
- YOURLS GWall Change Logo - Allows you to change the image of the YOURLS logo and its alt and title tags.
- Change Password ☑️ - Change your password from within YOURLS instead of editing the config file.
- Change Password - Allow users to change their password via the administration interface.
- Change Title - Change the html
<title>
tag of your admin interface. - Check URL - Check if a long URL is reachable before creating a short URL.
- Compliance - Anti-abuse plugin, designed to address link complaints from 3rd parties.
- Conditional Toolbar ☑️ - A plugin to conditionally enable the toolbar:
http://sho.rt/blah
for normal redirect,http://sho.rt/tb/blah
for a toolbar. - Conditional Advertisements - A plugin to conditionally send links through various link monetizing services:
http://your.site/short
is normal,http://your.site/a/short
redirects through AdFly. - Custom Header & Footer - A plugin administration page to add custom header and footer style and content.
- Custom Javascript - Add custom javascript to admin pages.
- Custom Number of Displayed Links ☑️ - Change the default number of links per page, if 15 isn't your taste.
- Custom Protocol ☑️ - If the user is known, this plugin adds custom protocol (eg
blah://
) to authorized protocols, otherwise restricts tohttp|s
.
D
- Disable JSONP - Disables JSONP access for the YOURLS API.
- DNSBL - Uses various DNSBLs to check the submitter's IP and prevent shortening URLs if any malicious activity has been detected.
- Domain Limit - Limit the domains that users can create shortlinks to.
- Domain Limiter - Fork of Nic Waller's plugin with the addition of an admin panel to edit the white list from the admin area.
- Do TLS - Always use SSL/TLS for a destination url if available.
- Don't Log Bots ☑️ - Ignore bot hits in your stats (both click count as seen in the main admin page and in detailed stats).
- Don't Log Crawlers - A fork of the
Don't Log Bots
, with more bots filtered out. - Don't Log Health Checker - A fork of
Don't Log Bots
, with more bots filtered out. - Don't Track Admin Clicks ☑️🧪 - Don't count clicks on short URL if user is logged in.
- Download Plugin - Download and install YOURLS plugins from the admin panel.
E
- Edition Logger - Logs to a file every url insertion, deletion, or modification, to provide traceability of users' actions allowing an open edition policy.
- Email Notify - Sends you an email with identifying information whenever someone clicks the link they were sent.
- Emojis - Create an emoji-only short link, like
http://sho.rt/✨
orhttp://sho.rt/😎🆒🔗
- Enhanced Auth Cookies ☑️ - Enhances the cookie based authentication, making each auth cookie name unique and time based.
- Every Click Counts - Click count include multiple clicks for the same client (ie there will be no browser caching of the redirection).
- Expiry - Defines optional conditions under which links will expire, able to set time and click limited links globally or per individual links.
F
- Fallback URL - Redirect to a custom URL when the short URL does not exist.
- Favicon ☑️ - Properly displayed favicon in all cases (home screen on iOS, Android, Chrome, Safari...).
- Filter Code - Allow to select 3XX Status Code to return per keyword.
- Fix long URLs - Fix long URLs that contain %20 and other similar encodings.
- Fix Youtube titles ☑️ - Get correct video title, not "
Before you continue to YouTube
" - Force Lowercase ☑️ - Force lowercase so
http://sho.rt/ABC
→http://sho.rt/abc
. - Fuzzy Keyword Suggestions - Handles typos and other "near-misses" for any shortened link (eg if you have
sho.rt/dh1ik
but someone typessho.rt/dhlik
, the 404 page will show suggestions for similar short URLs).
G
- GA MP - Track YOURLS link clicks with Google Analytics Measurement protocol in Real Time.
- Git Version - Add version information from the git repository into the footer of the admin page.
- Geo API - Plugin to look up country code from another 3rd party API (geoiplookup.net).
- GeoIP Update ☑️ - Update the GeoIP database
- GeoShortURL - Plugin to add per-country support to existing short URLs (use it with 302-Instead).
- Google Analytics Link Tagging - Add GA tags (utm_source and others) to your shortened links.
- Google Auth - Enables Google Authentication for YOURLS.
- Google Safe Browsing ☑️ - Check every new URL against Google's Safe Browsing Lookup service.
- GTM for YOURLS - Google Tag Manager for every single click.
H
- hexdec - Changes the sequential keywords from base36 to base16 (ie
[0-9a-f]
). - Hide Referrer - Hide referrer on all or some short links.
- Hide Version String - Hide the version string in the footer.
- HTTP:BL - Prevent spam using the black list from Project Honeypot.
- HTTP Proxy - Get remote content using an HTTP proxy, for instance when YOURLS is running behind a firewall (e.g. corporate intranet).
- HTTP status per link - Select
3XX
Status Code to return per keyword.
I
- Identi.ca for YOURLS - Share YOURLS links via identi.ca.
- YOURLS IDN ☑️ - Add IDN support to YOURLS.
- Image Placeholder ☑️ - Simple image placeholder service for YOURLS.
- YOURLS Import Export - A plugin to import and export YOURLS URL.
- Integrated QRCodes - Integrated QRCodes is an updated fork of Inline QRCode, but more compact, configurable, and just as efficient with more features.
- Insert Fake Links ☑️ - Insert fake links (for test installs)
- iOS URL - Adds support for URLs starting with
itms-apps://
anditms-services://
. - iTunes-Affiliate - Adds your iTunes Affiliate-Token to all iTunes URLs before redirection.
J
- Jappix - Adds a JappixMini chat on your YOURLS admin pages.
- JSON Response - Add
.json
(or a custom string/character) to the short URL to get info about it as a JSON response.
K
- Keep Query String - Adds the short URL's query string (if any) to the long URL.
- Keywords, Charset & Length - Custom charset, custom link length and random short urls, all in one plugin, with an admin panel.
- Keyword not found - If keyword isn't found in the database, redirect to admin page and pre-populate the short URL field.
- Keyword Prefix - Adds a defined prefix to your short URLs.
L
- LDAP - Enables use of LDAP for user authentication.
- Link Anonymizer - Generate a link that will take you to an anonymizer service.
- Link List - List recent links added, in the admin interface or on a public page.
- Limit keyword length - This plugin limits the number of characters allowed for the custom keyword.
- Limit keyword length - This plugin defines the minimal amount of characters for the custom keyword.
- Limited Links ☑️ -limit the number of redirections of a specific link.
- log-login - Logs login atempts to YOURLS. To be used with fail2ban.
- Login Timeout - Adds a timeout after a certain number of failed logins to mitigate brute force logins.
- Lookup keywords by long URL substring - Add a "lookup-url-substr" action to YOURLS API which searches keywords by long URL substring (implements
url LIKE %substr%
SQL operation). - lowercase username - Makes the username lowercase when logging in.
M
- Mailto - Adds a "mailto:" sharing option, next to Twitter and Facebook.
- Mailto Bookmarklet - Adds a bookmarklet to share links by mail.
- Mass Remove Link ⭐ - Remove several links at once. Select by date, date range, IP or URL matching.
- Mass Update - Adds an API action to mass update links from
old_domain
tonew_domain
. - Memcached - Memcached plugin for YOURLS.
- Meta Redirect - Redirect using HTML meta tag when you prepend the short URL with an underscore (eg
http://sho.rt/_bleh
). - Mobile Detect - Add ability to redirect by user device OS.
N
- No Traking Admins - No loggin clicks for authenticated users (compatible with OIDC).
- No Version Check ☑️ - Stop YOURLS from checking if a new release is available.
- Notifier - Sends notifications when actions occurs, like creating a new shortened url.
O
- OAuth Sign In - Enable OAuth sign in support (using GitLab as an example).
- OIDC - OpenID Connect authentication against a generic OpenID Connect server.
- Open Graph Meta Scraper - Get Open Graph (OG) information for your shortened links.
P
- Password Protection - Password protect any Short URL you want so that users are prompted for a password before redirection.
- Phishtank - Prevent spam links using Phishtank's API.
- Phishtank 2.0 - Functional rewrite of the old Phishtank plugin with more features.
- Piwik-YOURLS - Piwik and a few other features.
- Popular Clicks - Display the top of the most clicked links during past days.
- Popular Clicks Extended - Shows which short links get clicked the most during a specific time frame.
- Popular Links - Adds an admin page that displays your shortener's most popular links.
- Preview URL ☑️ - Add the character '~' to a short URL to display a preview screen before redirection.
- Preview URL with QR Code - Add the character '~' to a short URL to display a preview screen & QR code before redirection.
- Preview URL with QR Code And Thumbnail - Add the character '~' to a short URL to display a QR code and Thumbnail image before redirection.
- Public "Prefix n' Shorten" ☑️ - Redirect
http://sho.rt/http://someurl.com/
to a public interface instead of the admin area. - YOURLS Pseudonymize - This plugin "pseudonymizes" the IP addresses so that it is in line with the German privacy laws (the last 2 segments/bytes of a visitor's IP address are removed).
- PUNS - A Plugin Update Notification System: provides a report-generating page and an API with optional email notifications.
Q
- QRCode ☑️ - Add ".qr" to short URLs to display the shorturl's QR code.
- QRCode - Creates and displays QR Codes within YOURLS.
- QR Google Charts - Another QR Code plugin, using Google Charts API.
- QRCode - Another QR Code plugin. Get the QR code by simply clicking on a button in the Admin area (or by adding ".qr" to the end of the keyword).
- QueryString Forward - Forward the query string on short link to long URL (eg
http://sho.rt/kk?a=1
tohttp://long.url/somepage/?a=1
). - Query String Keeper - Pass the query string from the shortlink to the long URL (eg
http://sho.rt/kk?hey
forwards tohttp://long.url/bleh/?hey
).
R
- reCaptcha - YOURLS plugin implementing reCaptcha for unauthenticated users in your public interface.
- Redirect Index - Redirect the user to another site if they go to the base directory of your YOURLS installation.
- Referral Link Checkpoint - Add a landing page to let visitors know when it is a referral link.
- Regenerate URL - Regenerate a new keyword for a URL that has already been shortened.
- Remove The Share Function - Remove the Share button and box that toggles the sharing options on the Admin page.
- Remove YouTube Play Indicator - Removes the triangle from the title of Youtube shortened URL.
- Reset URLs ☑️ - Deletes all URLs. For your test install needs.
- Reverse Proxy - Fixes the user IPs to point to the actual user instead of your cloud provider’s infrastructure IPs (Cloudflare, Heroku...).
- rscrub - An "HTTP referrer scrubbing swiss army knife for YOURLS" (evolution of the Hide Referrer plugin).
S
- SAML Authentication - Sign in via SAML-based single sign-on.
- Save By Keyword - API action to update the long URL of an existing keyword, or creates a new short URL.
- Semantic Scuttle - Allows the sharing of the URL to a Semantic Scuttle installation.
- Separate Users - Adds a username to each created URL, and filters the admin interface.
- Shaarli - Allows the sharing of the URL to a Shaarli installation.
- Share LinkedIn - Adds LinkedIn to the Quick Share Box.
- Share with Tumblr ☑️ - In the Quick Share box, add a one-click share to Tumblr link.
- Shibboleth - Enable authentication with Shibboleth.
- ShortShort - Checks if a URL is already shortened (e.g. t.co, bit.ly, youtu.be) to avoid nested shortened links.
- Show Git Branch ☑️ - Using YOURLS on a dev box under Git? Show the current branch in page footer.
- SimpleDB Clickqueue - Queue clicks to Amazon SimpleDB before processing. This allows using a regular MySQL store even in the face of a high frequency of writes, without concern of connection limit overflow. Clicks are inserted later into the database via an import job.
- Skimlinks - Push all links through Skimlinks to automatically embed affiliate codes.
- Skip Click Count - Don't count clicks on short URLs.
- Slack Notifier - Send a notification to a Slack channel whenever a new short URL is created.
- SMTP Contact - Provides a public contact page using PHPMailer for outbound mail delivery.
- Snapshot - Visual preview plugin with image caching powered by PhantomJS.
- YOURLS SQLite ☑️ - SQLite driver for YOURLS. It is now considered outdated.
- YOURLS SQLite - A fork of the original SQLite driver for YOURLS, actively maintained.
- Static Titles - Provide two options to avoid the network traffic when retrieving URL titles.
- SSL for SSL - Generates SSL short links if the original link was SSL.
- Swap Short URL - A plugin to have
http://sho.rt/blah
while having YOURLS installed inhttp://sho.rt/yourls/
T
- Telegram Quickshare - Quickly share a shortened URL via Telegram Messenger.
- Title Refetch - Refetch page titles.
- Timezones ☑️ - Tell YOURLS your time zone and how you'd like times and dates displayed.
- Thumbnail URL image - Get the Thumbnail URL image (long URL) by adding
.i
to the end of the keyword. - Time-Period Clicks - A simple API plugin for reporting URL clicks in a specific time period (e.g. the last week, January 1 - February 1, etc).
- Time Limit Link - Set a time limit for links.
- Track Custom Keyword - Add a new field to YOURLS designed to track if a keyword was randomly assigned or manually specified.
- Typer, a yourls prank plugin - Add an underscore * to your shortlink and the user will be shown a page where they have to type the shortlink themselves.
U
- Upload and Shorten - Upload and share files with YOURLS.
- U-SRV - Provides secure links to files while obfuscating filesystem paths, allowing easy, secure access to files between plugins or from 3rd party scripts. Manual uploading of files is supported.
- Update 30X - An API plugin to test single, domain based, or all available links and update the URL in YOURLS if redirection occures at the destination.
- URL Health Check - Checks submitted URLs for validity, reachability, and redirection. In the case of redirection, the final destination URL will be stored avoiding nested redirects.
- Users in Database - Reads users from a database table instead of a config file. Currently does not provide an interface for adding/editing users though.
W
- wallabag - Allows the sharing of the URL to a Wallabag installation (previously named Poche).
- Whatsapp quickshare - Allows you to share your short URL via whatsapp.
- Word Based Short URLs ☑️ - Generate short URLs with adjectives and nouns, like
http://sho.rt/FluffyArrogantUnicorn
.
X
Y
- YAPCache - YAPCache is an APC based cache designed to reduce the database load of YOURLS and increase performance.
- YOURS-TN - Display thumbnails on YOURLS admin page and stats page, using thumbnail.ws.
- YouTube Title Fix - Fetch YouTube page titles via Google API.
Z
Themes
This will be the next big thing when YOURLS fully support theming
- ∞² - Infinity Squared, a beautiful public page theme for YOURLS.
- Air 66 - A responsive admin theme for YOURLS.
- Sleeky - A sleek and simple frontend & backend theme for YOURLS with light and dark modes.
Translations
YOURLS supports localization: this means if a language file for YOURLS in available in your language, YOURLS will speak your language!
- Brazilian: here and here (
pt_BR
) - Bulgarian (
bg_BG
) - Catalan (
ca_ES
) - Czech (
cs_CZ
) - Danish (
da_DK
) - Dutch (
nl_NL
) - Farsi (
fa_FA
) - Finnish (
fi_FI
) - French (
fr_FR
) - German (
de_DE
) - Hindi (
hi-IN
) - Indonesian (
id_ID
) - Italian (
it_IT
) - Japanese (
ja_JP
) - Korean (
ko_KR
) - Norwegian (bokmål) (
nb_NO
) - Polish (
pl_PL
) - Portuguese (
pt_PT
) - Russian (
ru_RU
) - Simplified Chinese (
zh_CN
) - Slovak (
sk_SK
) - Spanish (
es_ES
) - Telugu (
te_IN
) - Turkish (
tr_TR
) - Traditional Chinese (
zh_TW
)
Integrations
Make YOURLS work with other platforms, programming languages or tools.
3rd party platforms
- Integromat - Automate actions with YOURLS (eg new blog post -> shorten link -> share on Discord)
3rd party Integrations and Frameworks
- Bash
- YOURLS BASH - a simple BASH script to shorten URLs with YOURLS
- CakePHP - Plugin to integrate YOURLS.
- Drupal - YOURLS for Drupal.
- FreeBSD Freshport - a FreeBSD package.
- Gnome Desktop - Gnome Shell extension to shorten links in the clipboard.
- Laravel
- NodeJS
- JavaScript bindings for the YOURLS API - JavaScript bindings to leverage JSONP support.
- YOURLS API for nodejs
- Perl
- WWW::Shorten::Yourls - A Perl module to shorten URLs using YOURLS.
- AmazonAffiliatesToYourls - Amazon affiliate management.
- Prometheus exporter - A Prometheus exporter to monitor a YOURLS instance.
- Python
- pyourls3 - A Python client for YOURLS, built for Python 3.
- python-yourls - Alternative Python 2 client for YOURLS.
- yourls-python -
pip install yourls
for Python 2 or 3
- Ruby - A Ruby wrapper for the YOURLS API.
- status.net - Plugin for status.net to use YOURLS.
- Telegram
- Telegram bot - A Telegram bot to shorten links.
- YOURLS Bot - Open source code base for hosting your own Telegram bot to shorten links via your own YOURLS instance. Includes access control by default, so suitable for non-public YOURLS instances.
- VB .Net - A VB .Net 4.0 wrapper for the YOURLS API.
- WordPress
- YOURLS Link Creator
- YOURLS Widget - Fetch and display YOURLS links and a QR code in a widget.
- There are numerous WordPress plugins with YOURLS support.
Applications
- Android
- aYourls - A dedicated app for YOURLS supporting server-side deletion (needs API Delete).
- URL Shortener - Supports various shortener, including YOURLS.
- iC-YOURLS - A simple YOURLS app for Android, supports receiving links from other apps.
- AutoAffiliate - Automatically convert someone's affiliate link to your affiliate link.
- iOS
- ShortTail - An elegant YOURLS client for iPhone.
- ShortFox2
- Short Menu - YOURLS support requires a one-time in-app purchase of about $2 USD (See also: Setup instructions).
- Chrome
- Firefox
- Mac
- Short Menu - Available for $6 from the App Store or directly from the developer (See also: Setup instructions).
- Windows
- YOURLS on Windows - Run YOURLS as a Windows program.
Guides & Tutorials
Installation guides
- Installing YOURLS on a Plesk-Hosted Domain
- How to Install YOURLS using Softaculous
- How to Install YOURLS on a VPS or shared hosting
- YOURLS on Azure
- CentOS
- YOURLS on Cherokee
- YOURLS on Cloudron
- YOURLS on Installatron
- YOURLS on IIS
- YOURLS on Fedora
- Guides for Ubuntu:
Installation guides in other languages
- 宝塔面板搭建短链接服务 YOURLS
- Cómo instalar YOURLS, usando Softaculous
- Cómo instalar YOURLS en Ubuntu 20.04
- Installer YOURLS, un système d'URL raccourcies
- Трекер Yourls ваш собственный сокращатель ссылок (URL)
Other tutorials
- Getting Started with YOURLS - a video presentation that includes API examples with Keyboard Maestro
- YOURLS with Tweetbot
Showcases
Sites running YOURLS with a unique design or concept
- https://oe.cd/ - Europe OECD's internal URL shortener with a neat interface and private features.
- https://kiwi.gg/ - A sexy shortener home page with stats and details.
- https://u.nu/ - Very neat public interface and their own command line tool.
- https://yourwish.es/ - Easily share an Amazon wishlist.
- http://vbly.us - YOURLS early adopter, once taken down by Libya! (story).
Celebrity endorsements (sort of)
- Early review on Lifehacker.
- https://mclrn.co/ by McLaren Cars.
- https://smashed.by/ by Smashing Magazine.
- https://cuny.is/ by the City University of New York.
- https://dhurl.org/ by Dreamhost.
YOURLS has also been used by the NASA, Virgin and Epic Games. Sweet! 😊
Contribute
Contributions welcome! Read the contribution guidelines first.