From c08aa6b059262517d351a0efce44f982afd4fe3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E0=BE=85=E0=BC=BB=20=C7=AC=C9=80=C4=A7=20=E0=BC=84?= =?UTF-8?q?=E0=BC=86=E0=BD=89?= Date: Sun, 21 Feb 2021 18:47:41 +0100 Subject: [PATCH] Complete re-order of the page * Move 3rd party stuff from the official readme to here * Adds lots of stuff * Fixes #59 --- README.md | 296 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 172 insertions(+), 124 deletions(-) diff --git a/README.md b/README.md index 32ce5cf..f213ecb 100644 --- a/README.md +++ b/README.md @@ -1,95 +1,43 @@ -# Awesome YOURLS [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) +# Awesome YOURLS [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) [YOURLS Logo](https://github.com/YOURLS/awesome-yourls/) -> A curated list of awesome things related to YOURLS +> A curated list of **awesome things** related to **YOURLS** -- [Resources](#resources) - - [Official Resources](#official-resources) - - [Community](#community) - - [Tutorials](#tutorials) -- [Tools](#tools) - - [Official Tools](#official-tools) - - [3rd party Integrations and Frameworks](#3rd-party-integrations-and-frameworks) - - [Applications](#applications) -- [Plugins](#plugins) - - [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) | [G](#g) | [H](#h) | [I](#i) | [J](#j) | [K](#k) | [L](#l) | [M](#m) | [N](#n) | [O](#o) | [P](#p) | [Q](#q) | [R](#r) | [S](#s) | [T](#t) | [U](#u) | [V](#v) | [W](#w) | [X](#x) | [Y](#y) | [Z](#z) -- [Translations](#translations) +## Contents -## Resources +- [Official Links](#official-links) - Official guides and tools +- [Plugins](#plugins) - what makes YOURLS so versatile and powerful +- [Themes](#themes) - to customize how YOURLS looks +- [Translations](#translations) - YOURLS in your language +- [Integration](#integration) - Third-party integrations and frameworks +- [Guides & tutorials](#guides--tutorials) - Community resources -### Official Resources +*Something missing or incorrect ? Want to get your work listed ? See how you can [contribute](CONTRIBUTING.md) !* -- [Official Guide](https://yourls.org) +## Official Links [⇪](#readme) + +Official material from the YOURLS team + +- [Official Readme](https://yourls.org) - [GitHub Repo](https://github.com/YOURLS/YOURLS) - [Release Notes](https://github.com/YOURLS/YOURLS/releases) - [YOURLS News](http://blog.yourls.org/) - [Official Forum](https://discourse.yourls.org/) - -### Community - -- [Install Guide in Chinese](https://lza59.com/archives/yourls.html) - -### Tutorials - -- [YOURLS with Tweetie 2](http://www.eugenegordin.com/etc/how-to-use-your-custom-yourls-shortener-with-tweetie-2.html) on eugenegordin.com -- [YOURLS with Tweetbot](http://2fatdads.com/2012/02/how-to-make-yourls-org-work-in-tweetbot/) on 2fatdads.com - -## Tools - -### Official Tools - - [YOURLS using Docker](https://hub.docker.com/_/yourls/) - [YOURLS using Helm for Kubernetes](https://hub.helm.sh/charts/yourls/yourls) -### 3rd party Integrations and Frameworks +## Plugins [⇪](#readme) -- WordPress - * [YOURLS Link Creator](http://wordpress.org/extend/plugins/yourls-link-creator/) - * [YOURLS Widget](https://gist.github.com/joshp23/3f990e6ec36e24ba53985968bbfa89f1) - Fetch and display YOURLS links and a QR code in a widget. - * There are numerous other [WordPress plugins](http://wordpress.org/extend/plugins/search.php?q=yourls) with YOURLS support. -- [Drupal](https://www.drupal.org/project/shorten) - YOURLS for Drupal. Requires the [title-refetch](https://github.com/joshp23/YOURLS-title-refetch) and [API Concurrency Fix](https://bitbucket.org/laceous/yourls-concurrency-fix) plugins to be installed in YOURLS. See [this](https://www.drupal.org/project/shorten/issues/2889342) Drupal issue for details. -- [CakePHP](https://github.com/driflash/CakePHP-YOURLS-Plugin) - Plugin to integrate YOURLS -- [Laravel](https://github.com/phpsa/laravel-yourls-plugin) - Plugin to integrate YOURLS -- [status.net](https://github.com/rthees/yourls-status-net) - Plugin for status.net to use YOURLS -- [Perl](https://github.com/pjain/WWW-Shorten-Yourls) - A Perl module to shorten URLs using YOURLS -- [Ruby](https://github.com/threestage/yourls) - A Ruby wrapper for the YOURLS API -- [Python 3](https://pypi.org/project/pyourls3/) - A Python client for YOURLS, built for Python 3 -- [Python 2](https://github.com/tflink/python-yourls/) - Alternative Python 2 client for YOURLS -- [VB .Net](http://www.nugardt.com/open-source/yourls-api/) - A VB .Net 4.0 wrapper for the YOURLS API -- [Javascript](http://neocotic.com/yourls-api/) - JavaScript bindings for the YOURLS API to leverage JSONP support -- [Gnome Desktop](https://github.com/joshp23/gnome-shell-extension-yourls) - Gnome Shell extension to shorten links in the clipboard -- [Telegram bot](https://simon-eller.at/en/projects/lets-short) - A [Telegram bot](https://t.me/LetsShortBot) to shorten links +All known plugins - either from the community, or from the YOURLS team, marked with a ☑️ -### Applications +Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) | [G](#g) | [H](#h) | [I](#i) | [J](#j) | [K](#k) | [L](#l) | [M](#m) | [N](#n) | [O](#o) | [P](#p) | [Q](#q) | [R](#r) | [S](#s) | [T](#t) | [U](#u) | [V](#v) | [W](#w) | [X](#x) | [Y](#y) | [Z](#z) -- Android - * [aYourls](https://gitlab.com/matecode/ayourls/-/tree/develop) - A dedicated app for YOURLS supporting server-side deletion (needs [API Delete](https://github.com/claytondaley/yourls-api-delete)) - * [iC-YOURLS](https://play.google.com/store/apps/details?id=net.inscomers.yourls) - A simple YOURLS app for Android, supports receiving links from other apps - -- iOS - * [ShortFox2](https://apps.apple.com/us/app/shortfox2/id1465812791?ls=1&t=8) - * [Short Menu](https://shortmenu.com/ios/) - YOURLS support requires a one-time in-app purchase of about $2 USD (See also: [Setup instructions](https://shortmenu.com/support/custom-services/yourls/)) -- Chrome - * [YOURLS](https://chrome.google.com/webstore/detail/yourls/nddaaiojgkoldnhnmkoldmkeocbooken) -- Firefox - * [YOURLS shortener](https://addons.mozilla.org/en-us/firefox/addon/yourls-shortener/) -- Mac - * [Short Menu](https://shortmenu.com/mac/) - Available for $6 from the App Store or directly from the developer (See also: [Setup instructions](https://shortmenu.com/support/custom-services/yourls/)) - -### Themes - -* [∞²](https://github.com/tomslominski/infinity-squared) - Infinity Squared, a beautiful public page theme for YOURLS -* [Air 66](https://github.com/air66design/air66-yourls-admin-theme) - A responsive admin theme for YOURLS -* [Sleeky](https://github.com/Flynntes/Sleeky) - A sleek and simple frontend & backend theme for YOURLS with light and dark modes - -## Plugins - -### 0-9 +### 0-9 [⇡](#plugins) - [302-Instead](https://github.com/EpicPilgrim/302-instead) - Send a 302 (temporary) redirect instead of 301 (permanent), for sites where shortlinks may change - [302-Instead](https://github.com/timcrockford/302-instead) - A fork of previous plugin, with some more options -- [404 If Not Found](https://github.com/YOURLS/404-if-not-found) ⭐ - Give a 404 Not Found if the short URL is not found +- [404 If Not Found](https://github.com/YOURLS/404-if-not-found)☑️ - Give a 404 Not Found if the short URL is not found -### A +### A [⇡](#plugins) - [AAF Rapid Connect auth](https://github.com/clmcavaney/aaf-rapidconnect-auth-yourls) - AAF Rapid Connect authentication plugin for YOURLS - [Abuse Desk for YOURLS](http://blog.yourls.org/2011/04/yourls-abuse-anti-spam-plugins/) - A Google Safe Browsing implementation for YOURLS to avoid spam links @@ -105,72 +53,72 @@ - [Amazon Affiliate](https://github.com/floschliep/YOURLS-Amazon-Affiliate) - Adds your Amazon Affiliate Tag to all Amazon URLs before redirection. - [Amazon Affiliate With Notice](https://github.com/Trsmoothie/YOURLS-Amazon-Affiliate-With-Redirect-Notice) - Adds your Amazon Affiliate Tag to all Amazon URLs before redirection with a notice of Amazon Affiliate link usage. - [Anonymise](https://github.com/wlabarron/yourls-anonymise) - Anonymise the log data that YOURLS captures. -- [Antispam](https://github.com/YOURLS/antispam) ⭐ - Merciless antispam plugin using the 3 major domain blacklists +- [Antispam](https://github.com/YOURLS/antispam)☑️ - Merciless antispam plugin using the 3 major domain blacklists - [YOURLS APC Cache](http://blog.yourls.org/2011/06/yourls-apc-cache-plugin/) - Add support for APC to reduce MySQL queries -- [API Action](https://github.com/YOURLS/API-action) ⭐ - Example plugin for YOURLS 1.6+ to show how to implement custom API actions +- [API Action](https://github.com/YOURLS/API-action)☑️ - Example plugin for YOURLS 1.6+ to show how to implement custom API actions - [API Delete](https://github.com/claytondaley/yourls-api-delete) - Add a "delete" action to the API - [API Edit URL](https://github.com/timcrockford/yourls-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 - [Append Query String](https://github.com/drockney/append-qs) - Appends the query string to a long URL- as is - [Auth Manager](https://github.com/nicwaller/yourls-authmgr-plugin) - Assign users to roles like "Editor" and "Contributor" to limit the changes they are permitted to make (edit URLs, manage plugins...) - [Auth Manager Plus](https://github.com/joshp23/YOURLS-AuthMgrPlus) - Seperates user data & manages authorization with role-based access controls (RBAC) -### B +### B [⇡](#plugins) - [Blacklist Domains](https://github.com/apelly/YourlsBlacklistDomains) - A simple plugin to blacklist domains from shortening URLs - [Blacklist IPs](https://github.com/LudoBoggio/YourlsBlacklistIPs) - A simple plugin to blacklist IPs from shortening URLs - [Bulk Import and Shorten](https://github.com/vaughany/yourls-bulk-import-and-shorten) - Import links from a CSV file - [Bulk URL Shortening](https://github.com/tdakanalis/bulk_api_bulkshortener) - Shortening of multiple URLs with one API request -### C +### C [⇡](#plugins) - [cAuth](https://github.com/joshp23/YOURLS-cAuth) - Client side SSL certificate authentication for admin pages. -- [Cache Stat Pages](https://github.com/YOURLS/cache-stats-pages) ⭐ - Serve stat pages (`http://sho.rt/blah+`) from cache +- [Cache Stat Pages](https://github.com/YOURLS/cache-stats-pages)☑️ - Serve stat pages (`http://sho.rt/blah+`) from cache - [CAS Plugin](https://github.com/nicwaller/yourls-cas-plugin) - Enable authentication through a CAS server - [Case Insensitive](https://github.com/seandrickson/YOURLS-Case-Insensitive/) - Makes all keywords case insensitive (creates and calls all keywords lowercase) - [Case Insensitive](https://github.com/adigitalife/yourls-case-insensitive) - Make YOURLS case insensitive: if you create `http://sho.rt/MyLink`, then variations like `mylink` or `MYLINK` will redirect to the same URL. - [Change Error Messages](https://github.com/adigitalife/yourls-change-error-messages) - Changes the error message when a keyword or URL already exists and displays the long URL. - [YOURLS GWall Change Logo](https://github.com/gioxx/YOURLS-GWallChangeLogo) - Allows you to change the image of the YOURLS logo and its alt and title tags. -- [Change Password](https://github.com/ozh/yourls-change-password) ⭐ - Change your password from within YOURLS instead of editing the config file +- [Change Password](https://github.com/ozh/yourls-change-password)☑️ - Change your password from within YOURLS instead of editing the config file - [Change Password](https://github.com/vvanasten/YOURLS-Change-Password) - Allow users to change their password via the administration interface. - [Check URL](https://github.com/adigitalife/yourls-check-url) - Check if a long URL is reachable before creating a short URL - [API Concurrency Fix](https://bitbucket.org/laceous/yourls-concurrency-fix) - A plugin to resolve concurrency issues with the API as described in Issue 765. - [Compliance](https://github.com/joshp23/YOURLS-Compliance) - Anti-abuse plugin, designed to address link complaints from 3rd parties. -- [Conditional Toolbar](http://blog.yourls.org/2011/03/yourls-plugin-example-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 Toolbar](http://blog.yourls.org/2011/03/yourls-plugin-example-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](https://github.com/HeroCC/yourls-conditional-urlads) - 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](https://github.com/scriptgeni/yourls-custom-header-footer) - A plugin administration page to add custom header and footer style and content - [Custom Javascript](https://github.com/scriptgeni/yourls-custom-javascript) - Add custom javascript to admin pages -- [Custom Protocol](https://github.com/YOURLS/custom-protocol) ⭐ - If the user is known, this plugin adds custom protocol (eg `blah://`) to authorized protocols, otherwise restricts to `http|s` +- [Custom Protocol](https://github.com/YOURLS/custom-protocol)☑️ - If the user is known, this plugin adds custom protocol (eg `blah://`) to authorized protocols, otherwise restricts to `http|s` -### D +### D [⇡](#plugins) - [Disable JSONP](https://github.com/seandrickson/YOURLS-Disable-JSONP) - Disables JSONP access for the YOURLS API. - [DNSBL](https://github.com/Diftraku/yourls_dnsbl/) - Uses various DNSBLs to check the submitter's IP and prevent shortening URLs if any malicious activity has been detected. - [Domain Limit](https://github.com/nicwaller/yourls-domainlimit-plugin) - Limit the domains that users can create shortlinks to - [Domain Limiter](https://bitbucket.org/quantumwebco/domain-limiter-yourls-plugin) - Fork of Nic Waller's plugin with the addition of an admin panel to edit the white list from the admin area - [Do TLS](https://github.com/joshp23/YOURLS-doTLS) - Always use SSL/TLS for a destination url if available -- [Don't Log Bots](https://github.com/YOURLS/dont-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 Bots](https://github.com/YOURLS/dont-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](https://github.com/luixxiul/dont-log-crawlers/) - A fork of the `Don't Log Bots`, with more bots filtered out. - [Don't Log Health Checker](https://github.com/guessi/yourls-dont-log-health-checker) - A fork of `Don't Log Bots`, with more bots filtered out. - [Don't Track Admin Clicks](https://github.com/dgw/yourls-dont-track-admins) - Don't count clicks on short URL if user is logged in -### E +### E [⇡](#plugins) - [Edition Logger](https://github.com/esuarezsantana/yourls-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](https://github.com/s22-tech/Yourls-Email-Notify) - Sends you an email with identifying information whenever someone clicks the link they were sent. -- [Enhanced Auth Cookies](https://github.com/ozh/yourls-enhanced-cookies) ⭐ - Enhances the cookie based authentication, making each auth cookie name unique and time based. +- [Enhanced Auth Cookies](https://github.com/ozh/yourls-enhanced-cookies)☑️ - Enhances the cookie based authentication, making each auth cookie name unique and time based. - [Every Click Counts](https://github.com/BstName/every-click-counts) - Click count include multiple clicks for the same client (ie there will be no browser caching of the redirection) - [Expiry](https://github.com/joshp23/YOURLS-Expiry) - Defines optional conditions under which links will expire, able to set time and click limited links globally or per individual links. -### F +### F [⇡](#plugins) -- [Fallback URL](https://github.com/ozh/yourls-fallback-url/) ⭐ - Redirect to a custom URL when the short URL does not exist -- [Favicon](https://github.com/YOURLS/yourls-favicon/) ⭐ - Properly displayed favicon in all cases (home screen on iOS, Android, Chrome, Safari...) +- [Fallback URL](https://github.com/ozh/yourls-fallback-url/)☑️ - Redirect to a custom URL when the short URL does not exist +- [Favicon](https://github.com/YOURLS/yourls-favicon/)☑️ - Properly displayed favicon in all cases (home screen on iOS, Android, Chrome, Safari...) - [Filter Code](https://github.com/ShredCode/YOURLS-filter-code) - Allow to select 3XX Status Code to return per keyword - [Fix long URLs](https://github.com/adigitalife/yourls-fix-long-url) - Fix long URLs that contain %20 and other similar encodings -- [Force Lowercase](https://github.com/YOURLS/force-lowercase) ⭐ - Force lowercase so `http://sho.rt/ABC` → `http://sho.rt/abc` +- [Force Lowercase](https://github.com/YOURLS/force-lowercase)☑️ - Force lowercase so `http://sho.rt/ABC` → `http://sho.rt/abc` - [Fuzzy Keyword Suggestions](https://github.com/philhagen/ltc-fuzzy-keyword-suggestions) - Handles typos and other "near-misses" for any shortened link (eg if you have `sho.rt/dh1ik` but someone types `sho.rt/dhlik`, the 404 page will show suggestions for similar short URLs) -### G +### G [⇡](#plugins) - [GA MP](https://github.com/powerthazan/YOURS-GA-MP-Tracking) - Track YOURLS link clicks with Google Analytics Measurement protocol in Real Time - [Git Version](https://github.com/chtaube/YOURLS-plugin-gitversion) - Add version information from the git repository into the footer of the admin page @@ -179,10 +127,10 @@ - [Google Analytics Link Tagging](https://katz.co/2300/) - Add GA tags (utm_source and others) to your shortened links - [Google Auth](https://github.com/8thwall/google-auth-yourls) - Enables Google Authentication for YOURLS - [Google Analytics YOURLS Plugin](http://www.matbra.com/en/code/google-analytics-yourls-plugin/) - Add your Google Analytics tags to admin and stat pages -- [Google Safe Browsing](https://github.com/YOURLS/google-safe-browsing) ⭐ - Check every new URL against Google's Safe Browsing Lookup service +- [Google Safe Browsing](https://github.com/YOURLS/google-safe-browsing)☑️ - Check every new URL against Google's Safe Browsing Lookup service - [GTM for YOURLS](https://github.com/dorks-delivered/GTM-for-YOURLS) - Google Tag Manager for every single click -### H +### H [⇡](#plugins) - [hexdec](https://github.com/plttn/yourls-hexdec) - Changes the sequential keywords from base36 to base16 (ie `[0-9a-f]`) - [Hide Referrer](https://github.com/Sire/yourls-hide-referrer) - Hide referrer on all or some short links @@ -190,42 +138,43 @@ - [HTTP:BL](https://github.com/joshp23/YOURLS-httpBL) - Prevent spam using the black list from Project Honeypot. - [HTTP Proxy](https://github.com/adigitalife/yourls-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](https://github.com/Jelle-S/YOURLS-http-status-per-link) - Plugin to allow you to select `3XX` Status Code to return per keyword. +- [HTTP status per link](https://github.com/digipolisgent/yourls_plugin_http-status-per-link) - Select `3XX` Status Code to return per keyword. -### I +### I [⇡](#plugins) - [Identi.ca for YOURLS](http://blog.yourls.org/2011/04/yourls-identi-ca-and-tumblr-plugins/) - Share YOURLS links via identi.ca -- [YOURLS IDN](https://github.com/YOURLS/YOURLS-IDN) ⭐ - Add IDN support to YOURLS -- [Image Placeholder](https://github.com/LeoColomb/yourls-image-placeholder) - Simple image placeholder service for YOURLS +- [YOURLS IDN](https://github.com/YOURLS/YOURLS-IDN)☑️ - Add IDN support to YOURLS +- [Image Placeholder](https://github.com/LeoColomb/yourls-image-placeholder)☑️ - Simple image placeholder service for YOURLS - [YOURLS Import Export](https://github.com/GautamGupta/YOURLS-Import-Export) - A plugin to import and export YOURLS URL - [Integrated QRCodes](https://github.com/joshp23/YOURLS-IQRCodes) - Integrated QRCodes is an updated fork of Inline QRCode, but more compact, configurable, and just as efficient with more features. - [iOS URL](https://github.com/suculent/yourls-ios-url-schemes-plugin) - Adds support for URLs starting with `itms-apps://` and `itms-services://` - [iTunes-Affiliate](https://github.com/floschliep/YOURLS-iTunes-Affiliate) - Adds your iTunes Affiliate-Token to all iTunes URLs before redirection -### J +### J [⇡](#plugins) - [Jappix](https://github.com/jonrandoem/yourls-jappix) - Adds a JappixMini chat on your YOURLS admin pages - [JSON Response](https://github.com/tessus/yourls-json-response) - Add `.json` (or a custom string/character) to the short URL to get info about it as a JSON response. -### K +### K [⇡](#plugins) - [Keep Query String](https://github.com/rinogo/yourls-keep-query-string) - Adds the short URL's query string (if any) to the long URL - [Keywords, Charset & Length](https://github.com/peterberbec/yourls-keyword_charset_length) - Custom charset, custom link length and random short urls, all in one plugin, with an admin panel. - [Keyword not found](https://github.com/8thwall/keyword-not-found-set-field-yourls) - If keyword isn't found in the database, redirect to admin page and pre-populate the short URL field - [Keyword Prefix](https://github.com/jangrewe/yourls-keyword-prefix) - Adds a defined prefix to your short URLs -### L +### L [⇡](#plugins) - [LDAP](https://github.com/k3a/yourls-ldap-plugin) - Enables use of LDAP for user authentication. - [Link Anonymizer](https://github.com/katzwebservices/YOURLS-Link-Anonymizer) - Generate a link that will take you to an anonymizer service. - [Link List](https://github.com/ruthtillman/yourls-linklist) - List recent links added, in the admin interface or on a public page - [Limit keyword length](https://github.com/adigitalife/yourls-limit-keyword-length) - This plugin limits the number of characters allowed for the custom keyword. -- [Limited Links](https://github.com/LeoColomb/yourls-limited-links) -limit the number of redirections of a specific link. +- [Limited Links](https://github.com/LeoColomb/yourls-limited-links)☑️ -limit the number of redirections of a specific link. - [log-login](https://github.com/SweBarre/log-login) - Logs login atempts to YOURLS. To be used with fail2ban. - [Login Timeout](https://github.com/reanimus/yourls-login-timeout) - Adds a timeout after a certain number of failed logins to mitigate brute force logins. - [Lookup keywords by long URL substring](https://github.com/bryzgaloff/yourls-api-lookup-keywords-by-url-substr) - Add a "lookup-url-substr" action to YOURLS API which searches keywords by long URL substring (implements `url LIKE %substr%` SQL operation). - [lowercase username](https://github.com/Virinum/yourls-lowercase-username) - Makes the username lowercase when logging in. -### M +### M [⇡](#plugins) - [Mailto](https://github.com/peterberbec/yourls-mailto) - Adds a "mailto:" sharing option, next to Twitter and Facebook - [Mailto Bookmarklet](https://github.com/peterberbec/yourls-mailto-bookmarklet) - Adds a bookmarklet to share links by mail @@ -236,17 +185,17 @@ - [Multi User](http://www.matbra.com/en/code/multi-user-yourls-plugin/) - Add support for multiple users - [Mobile Detect](https://github.com/guessi/yourls-mobile-detect) - Add ability to redirect by user device OS -### N +### N [⇡](#plugins) - [No Traking Admins](https://github.com/joshp23/YOURLS-No-Tracking-Admins) - No loggin clicks for authenticated users (compatible with OIDC). -### O +### O [⇡](#plugins) - [OAuth Sign In](https://github.com/LouisSung/YOURLS-OAuth_Sign_In) - Enable OAuth sign in support (using GitLab as an example) - [OIDC](https://github.com/joshp23/YOURLS-OIDC) - OpenID Connect authentication against a generic OpenID Connect server - [Open Graph Meta Scraper](https://github.com/LK608/OG-Scraper) - Get Open Graph (OG) information for your shortened links -### P +### P [⇡](#plugins) - [Password Protection](https://github.com/MatthewC/yourls-password-protection) - Password protect any Short URL you want so that users are prompted for a password before redirection - [Phishtank](http://blog.yourls.org/2011/04/yourls-abuse-anti-spam-plugins/) - Prevent spam links using Phishtank's API @@ -255,90 +204,104 @@ - [Popular Clicks](https://github.com/miconda/yourls/tree/master/plugins/popular-clicks) - Display the top of the most clicked links during past days - [Popular Clicks Extended](https://github.com/vaughany/yourls-popular-clicks-extended) - Shows which short links get clicked the most during a specific time frame - [Popular Links](https://github.com/laaabaseball/Yourls-Popular-Links) - Adds an admin page that displays your shortener's most popular links -- [Preview URL](https://github.com/YOURLS/YOURLS/wiki/Plugin-=-Preview-URL) ⭐ - Add the character '~' to a short URL to display a preview screen before redirection +- [Preview URL](https://github.com/YOURLS/YOURLS/wiki/Plugin-=-Preview-URL)☑️ - Add the character '~' to a short URL to display a preview screen before redirection - [Preview URL with QR Code](https://github.com/dennydai/yourls-preview-url-with-qrcode) - Add the character '~' to a short URL to display a preview screen & QR code before redirection - [Preview URL with QR Code And Thumbnail](https://github.com/prog-it/yourls-preview-url-with-qrcode-thumbnail) - Add the character '~' to a short URL to display a QR code and Thumbnail image before redirection -- [Public "Prefix n' Shorten"](https://github.com/YOURLS/YOURLS/wiki/Plugin-=-Public-Prefix-'n'-Shorten) ⭐ - Redirect `http://sho.rt/http://someurl.com/` to a public interface instead of the admin area +- [Public "Prefix n' Shorten"](https://github.com/YOURLS/YOURLS/wiki/Plugin-=-Public-Prefix-'n'-Shorten)☑️ - Redirect `http://sho.rt/http://someurl.com/` to a public interface instead of the admin area - [YOURLS Pseudonymize](https://github.com/ubicoo/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](https://github.com/joshp23/YOURLS-PUNS) - A Plugin Update Notification System: provides a report-generating page and an API with optional email notifications. -### Q +### Q [⇡](#plugins) -- [QRCode](https://github.com/YOURLS/YOURLS/wiki/Plugin-=-QRCode-ShortURL) ⭐ - Add ".qr" to short URLs to display the shorturl's QR code +- [QRCode](https://github.com/YOURLS/YOURLS/wiki/Plugin-=-QRCode-ShortURL)☑️ - Add ".qr" to short URLs to display the shorturl's QR code - [QRCode](http://techlister.com/plugins-2/qrcode-plugin-for-yourls/354/) - Creates and displays QR Codes within YOURLS - [QR Google Charts](http://aiaraldea.github.com/qr-google-charts/) - Another QR Code plugin, using Google Charts API - [QRCode](https://github.com/seandrickson/YOURLS-QRCode-Plugin) - 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](https://github.com/llonchj/yourls_plugins) - Forward the query string on short link to long URL (eg `http://sho.rt/kk?a=1` to `http://very.long.url/somepage/?a=1`) - [Query String Keeper](https://github.com/jessemaps/yourls-query-string-keeper) - Pass the query string from the shortlink to the long URL (eg `http://sho.rt/kk?hey` forwards to `http://longurl/bleh/?hey`) -### R +### R [⇡](#plugins) - [reCaptcha](https://github.com/spbriggs/recaptcha-plugin) - YOURLS plugin implementing reCaptcha for unauthenticated users in your public interface - [Redirect Index](https://github.com/tomslominski/yourls-redirect-index) - Redirect the user to another site if they go to the base directory of your YOURLS installation - [Regenerate URL](https://github.com/TheLeonKing/yourls-api-regenerate-url) - Regenerate a new keyword for a URL that has already been shortened. - [Remove The Share Function](https://github.com/seandrickson/YOURLS-Remove-the-Share-Function) - Remove the Share button and box that toggles the sharing options on the Admin page - [Remove YouTube Play Indicator](https://github.com/UltraNurd/youtube-play-indicator) - Removes the triangle from the title of Youtube shortened URL -- [Reset URLs](https://gist.github.com/ozh/a0090f46569b50835520d95f9481d9fd) ⭐ - Deletes all URLs. For your test install needs. +- [Reset URLs](https://gist.github.com/ozh/a0090f46569b50835520d95f9481d9fd)☑️ - Deletes all URLs. For your test install needs. - [Reverse Proxy](https://github.com/Diftraku/yourls_reverseproxy) - Fixes the user IPs to point to the actual user instead of your cloud provider’s infrastructure IPs (Cloudflare, Heroku...) - [rscrub](https://github.com/joshp23/YOURLS-rscrub) - An "HTTP referrer scrubbing swiss army knife for YOURLS" (evolution of the Hide Referrer plugin) -### S +### S [⇡](#plugins) - [Semantic Scuttle](https://github.com/jonrandoem/yourls-semanticscuttle) - Allows the sharing of the URL to a Semantic Scuttle installation. - [Separate Users](https://github.com/ianbarber/Yourls-Separate-Users) - Adds a username to each created URL, and filters the admin interface. - [Shaarli](https://github.com/miwasp/yourls-shaarli) - Allows the sharing of the URL to a Shaarli installation - [Share G+](https://github.com/ChrTang/yourls-share-gplus) - Adds Google+ to the Quick Share Box. - [Share LinkedIn](https://github.com/popnt/yourls-linkedin-share) - Adds LinkedIn to the Quick Share Box. -- [Share with Tumblr](https://github.com/YOURLS/YOURLS/wiki/Plugin-=-Share-Tumblr) ⭐ - In the Quick Share box, add a one-click share to Tumblr link. +- [Share with Tumblr](https://github.com/YOURLS/YOURLS/wiki/Plugin-=-Share-Tumblr)☑️ - In the Quick Share box, add a one-click share to Tumblr link. - [Shibboleth](https://github.com/fuero/yourls-shibboleth) - Enable authentication with Shibboleth - [ShortShort](https://github.com/abaumg/yourls-shortshort) - Checks if a URL is already shortened (e.g. t.co, bit.ly, youtu.be) to avoid nested shortened links. -- [Show Git Branch](https://github.com/ozh/show-git-branch) - Using YOURLS on a dev box under Git? Show the current branch in page footer. +- [Show Git Branch](https://github.com/ozh/show-git-branch)☑️ - Using YOURLS on a dev box under Git? Show the current branch in page footer. - [SimpleDB Clickqueue](https://github.com/ianbarber/Yourls-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](http://www.mattytemple.com/2010/12/yourls-plugin-skimlinks/) - Push all links through Skimlinks to automatically embed affiliate codes - [Skip Click Count](https://github.com/vipwangtian/yourls-skip-click-count) - Don't count clicks on short URLs - [SMTP Contact](https://github.com/joshp23/YOURLS-SMTP-contact) - Provides a public contact page using PHPMailer for outbound mail delivery - [Snapshot](https://github.com/joshp23/YOURLS-Snapshot) - Visual preview plugin with image caching powered by PhantomJS. -- [YOURLS SQLite](https://github.com/ozh/yourls-sqlite) - SQLite driver for YOURLS. It is now considered outdated. +- [YOURLS SQLite](https://github.com/ozh/yourls-sqlite)☑️ - SQLite driver for YOURLS. It is now considered outdated. - [YOURLS SQLite](https://github.com/Flameborn/yourls-sqlite) - A fork of the original SQLite driver for YOURLS, actively maintained. - [Static Titles](https://github.com/softius/yourls-static-titles) - Provide two options to avoid the network traffic when retrieving URL titles. - [SSL for SSL](https://github.com/tipichris/ssl4ssl) - Generates SSL short links if the original link was SSL. - [Swap Short URL](https://github.com/ggwarpig/Yourls-Swap-Short-Url) - A plugin to have `http://sho.rt/blah` while having YOURLS installed in `http://sho.rt/yourls/` -### T +### T [⇡](#plugins) - [Telegram Quickshare](https://github.com/ColinTheShark/YOURLS_tg-quickshare) - Quickly share a shortened URL via Telegram Messenger. - [Title Refetch](https://github.com/joshp23/YOURLS-title-refetch) - Refetch page titles -- [Timezones](https://github.com/YOURLS/timezones) ⭐ - Tell YOURLS your time zone and how you'd like times and dates displayed +- [Timezones](https://github.com/YOURLS/timezones)☑️ - Tell YOURLS your time zone and how you'd like times and dates displayed - [Thumbnail URL image](https://github.com/stevecohenfr/yourls-thumbnail-url) - Get the Thumbnail URL image (long URL) by adding `.i` to the end of the keyword - [Time-Period Clicks](https://github.com/rinogo/yourls-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](https://github.com/chesterrush/yourls-Time-Limit-Link) - Set a time limit for links - [Track Custom Keyword](https://github.com/timcrockford/track-custom-keywords) - Add a new field to YOURLS designed to track if a keyword was randomly assigned or manually specified - [Typer, a yourls prank plugin](https://github.com/koma5/typer) - Add an underscore * to your shortlink and the user will be shown a page where they have to type the shortlink themselves. -### U +### U [⇡](#plugins) - [Upload and Shorten](https://github.com/fredl99/YOURLS-Upload-and-Shorten) - Upload and share files with YOURLS - [U-SRV](https://github.com/joshp23/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](https://github.com/joshp23/YOURLS-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](https://github.com/joshp23/YOURLS-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. -### W +### W [⇡](#plugins) - [wallabag](https://github.com/jonrandoem/yourls-wallabag) - Allows the sharing of the URL to a Wallabag installation (previously named Poche) - [Whatsapp quickshare](https://github.com/WisseHesNL/Whatsapp-quickshare) - Allows you to share your short URL via whatsapp -- [Word Based Short URLs](https://github.com/ozh/yourls-word-based-short-urls) ⭐ - Generate short URLs with adjectives and nouns, like `http://sho.rt/FluffyArrogantUnicorn` +- [Word Based Short URLs](https://github.com/ozh/yourls-word-based-short-urls)☑️ - Generate short URLs with adjectives and nouns, like `http://sho.rt/FluffyArrogantUnicorn` -### X +### X [⇡](#plugins) -### Y + + +### Y [⇡](#plugins) - [YAPCache](https://github.com/tipichris/YAPCache) - YAPCache is an APC based cache designed to reduce the database load of YOURLS and increase performance - [YOURS-TN](https://github.com/sgiovagnoli/YOURLS-TN) - Display thumbnails on YOURLS admin page and stats page, using thumbnail.ws - [YouTube Title Fix](https://github.com/joshp23/YOURLS-YouTube-title-fix) - Fetch YouTube page titles via Google API -### Z +### Z [⇡](#plugins) -## Translations + + +## Themes [⇪](#readme) + +This will be the next big thing when YOURLS fully support theming + +* [∞²](https://github.com/tomslominski/infinity-squared) - Infinity Squared, a beautiful public page theme for YOURLS +* [Air 66](https://github.com/air66design/air66-yourls-admin-theme) - A responsive admin theme for YOURLS +* [Sleeky](https://github.com/Flynntes/Sleeky) - A sleek and simple frontend & backend theme for YOURLS with light and dark modes + + + +## Translations [⇪](#readme) YOURLS supports localization: this means if a language file for YOURLS in available in your language, YOURLS will speak your language! @@ -368,10 +331,95 @@ YOURLS supports localization: this means if a language file for YOURLS in availa - [Traditional Chinese](https://github.com/aee1027/YOURLS-zh_TW) (`zh_TW`) - [Viet Nam](https://github.com/tmtung144/YOURLS) (`vi_VN`) -## Contribute + +## Integrations [⇪](#readme) + +Make YOURLS work with other platforms, programming languages or tools + +### 3rd party Integrations and Frameworks [⇡](#integrations) + +- WordPress + * [YOURLS Link Creator](http://wordpress.org/extend/plugins/yourls-link-creator/) + * [YOURLS Widget](https://gist.github.com/joshp23/3f990e6ec36e24ba53985968bbfa89f1) - Fetch and display YOURLS links and a QR code in a widget. + * There are numerous [WordPress plugins](http://wordpress.org/extend/plugins/search.php?q=yourls) with YOURLS support. +- [Drupal](https://www.drupal.org/project/shorten) - YOURLS for Drupal. Requires the [title-refetch](https://github.com/joshp23/YOURLS-title-refetch) and [API Concurrency Fix](https://bitbucket.org/laceous/yourls-concurrency-fix) plugins to be installed in YOURLS. See [this](https://www.drupal.org/project/shorten/issues/2889342) Drupal issue for details. +- [CakePHP](https://github.com/driflash/CakePHP-YOURLS-Plugin) - Plugin to integrate YOURLS +- [FreeBSD Freshport](https://www.freshports.org/www/yourls/) - a FreeBSD package +- Laraval + * [Laravel YOURLS Plugin](https://github.com/phpsa/laravel-yourls-plugin) + * [Laraval YOURLS](https://github.com/orumad/laravel-yourls) +- Perl + * [WWW::Shorten::Yourls](https://github.com/pjain/WWW-Shorten-Yourls) - A Perl module to shorten URLs using YOURLS + * [AmazonAffiliatesToYourls](https://github.com/acaranta/AmazonAffiliatesToYourls) - Amazon affiliate management +- [Ruby](https://github.com/threestage/yourls) - A Ruby wrapper for the YOURLS API +- [Python 3](https://pypi.org/project/pyourls3/) - A Python client for YOURLS, built for Python 3 +- [Python 2](https://github.com/tflink/python-yourls/) - Alternative Python 2 client for YOURLS +- [status.net](https://github.com/rthees/yourls-status-net) - Plugin for status.net to use YOURLS +- [VB .Net](http://www.nugardt.com/open-source/yourls-api/) - A VB .Net 4.0 wrapper for the YOURLS API +- [Javascript](http://neocotic.com/yourls-api/) - JavaScript bindings for the YOURLS API to leverage JSONP support +- [YOURLS API for nodejs](https://www.npmjs.com/package/yourls) +- [Gnome Desktop](https://github.com/joshp23/gnome-shell-extension-yourls) - Gnome Shell extension to shorten links in the clipboard +- [Telegram bot](https://simon-eller.at/en/projects/lets-short) - A [Telegram bot](https://t.me/LetsShortBot) to shorten links + + + +### Applications [⇡](#integrations) + +- Android + * [aYourls](https://gitlab.com/matecode/ayourls/-/tree/develop) - A dedicated app for YOURLS supporting server-side deletion (needs [API Delete](https://github.com/claytondaley/yourls-api-delete)) + * [iC-YOURLS](https://play.google.com/store/apps/details?id=net.inscomers.yourls) - A simple YOURLS app for Android, supports receiving links from other apps + +- iOS + * [ShortFox2](https://apps.apple.com/us/app/shortfox2/id1465812791?ls=1&t=8) + * [Short Menu](https://shortmenu.com/ios/) - YOURLS support requires a one-time in-app purchase of about $2 USD (See also: [Setup instructions](https://shortmenu.com/support/custom-services/yourls/)) +- Chrome + * [YOURLS](https://chrome.google.com/webstore/detail/yourls/nddaaiojgkoldnhnmkoldmkeocbooken) +- Firefox + * [YOURLS shortener](https://addons.mozilla.org/en-us/firefox/addon/yourls-shortener/) +- Mac + * [Short Menu](https://shortmenu.com/mac/) - Available for $6 from the App Store or directly from the developer (See also: [Setup instructions](https://shortmenu.com/support/custom-services/yourls/)) + + + +## Guides & Tutorials [⇪](#readme) + +### Installation guides [⇡](#guides--tutorials) + +- [Installing YOURLS on a Plesk-Hosted Domain](https://www.danhendricks.com/2018/10/installing-yourls-on-plesk-shared-hosting-domain/) +- [How to Install YOURLS using Softaculous](https://www.websitehostingrating.com/how-to-install-yourls-using-softaculous/) +- [How to Install YOURLS on a VPS or shared hosting](https://thishosting.rocks/how-to-shorten-your-links-with-your-own-domain/) +- [YOURLS on Azure](https://www.juharyhanen.com/technology/create-personal-url-shortener-in-5-simple-steps/) +- CentOS + * [How to Install YOURLS on CentOS 7](https://www.vultr.com/docs/how-to-install-yourls-on-centos-7) + * [How to install YOURLS on Centos 7](https://www.linuxcloudvps.com/blog/how-to-install-yourls-on-centos-7/) + * [How to Install YOURLS on CentOS 8](https://www.howtoforge.com/how-to-install-yourls-on-centos-8/) +- [YOURLS on Cloudron](https://www.cloudron.io/store/org.yourls.cloudronapp.html) +- [YOURLS on Installatron](https://installatron.com/yourls) +- [YOURLS on Fedora](https://fedoraproject.org/wiki/Install_and_configure_YOURLS_for_AutoQA) +- Guides for Ubuntu : + * [How to install YOURLS on Ubuntu 14.04](https://www.rosehosting.com/blog/how-to-install-yourls-on-ubuntu-14-04/) + * [How to install YOURLS on Ubuntu 18.04](https://computingforgeeks.com/how-to-install-yourls-your-own-url-shortener-on-ubuntu-18-04-bionic-beaver-linux//) + * [How to install YOURLS on Ubuntu 20.04](https://linuxbuz.com/linuxhowto/install-yourls-ubuntu-20-04) + * [How to Install YOURLS on Ubuntu with Nginx and Let’s Encrypt](https://linuxstans.com/how-to-install-yourls/) + +### Installation guides in other languages [⇡](#guides--tutorials) + +- [宝塔面板搭建短链接服务 YOURLS](https://lza59.com/archives/yourls.html) +- [Cómo instalar YOURLS](https://www.websitehostingrating.com/es/how-to-install-yourls-using-softaculous/) +- [Installer YOURLS, un système d'URL raccourcies](https://www.justegeek.fr/tuto-installer-yourls-un-systeme-durl-raccourcies/) + +### Other tutorials [⇡](#guides--tutorials) + +- [YOURLS with Tweetie 2](http://www.eugenegordin.com/etc/how-to-use-your-custom-yourls-shortener-with-tweetie-2.html) +- [YOURLS with Tweetbot](http://2fatdads.com/2012/02/how-to-make-yourls-org-work-in-tweetbot/) + + + +## Contribute [⇪](#readme) Contributions welcome! Read the [contribution guidelines](CONTRIBUTING.md) first. -## License +## License [⇪](#readme) [![CC0](https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](https://creativecommons.org/publicdomain/zero/1.0) +