diff --git a/README.md b/README.md index f213ecb..188bfc5 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,12 @@ ## Contents -- [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 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 +- [Integrations](#integrations-) - Third-party integrations and frameworks +- [Guides & tutorials](#guides--tutorials-) - Community resources *Something missing or incorrect ? Want to get your work listed ? See how you can [contribute](CONTRIBUTING.md) !* @@ -29,15 +29,15 @@ Official material from the YOURLS team All known plugins - either from the community, or from the YOURLS team, marked with a ☑️ -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) +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-) -### 0-9 [⇡](#plugins) +### 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 -### A [⇡](#plugins) +### 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 @@ -62,14 +62,14 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### 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 [⇡](#plugins) +### 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 @@ -89,7 +89,7 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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` -### D [⇡](#plugins) +### 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. @@ -101,7 +101,7 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### 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. @@ -109,7 +109,7 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### 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...) @@ -118,7 +118,7 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### 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 @@ -130,7 +130,7 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### 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 @@ -140,7 +140,7 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### 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 @@ -150,19 +150,19 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### 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 [⇡](#plugins) +### 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 [⇡](#plugins) +### 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. @@ -174,7 +174,7 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### 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 @@ -185,17 +185,17 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### N [⇡](#plugins-) - [No Traking Admins](https://github.com/joshp23/YOURLS-No-Tracking-Admins) - No loggin clicks for authenticated users (compatible with OIDC). -### O [⇡](#plugins) +### 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 [⇡](#plugins) +### 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 @@ -211,7 +211,7 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### 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](http://techlister.com/plugins-2/qrcode-plugin-for-yourls/354/) - Creates and displays QR Codes within YOURLS @@ -220,7 +220,7 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### 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 @@ -231,7 +231,7 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### 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. @@ -253,7 +253,7 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### 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 @@ -264,30 +264,30 @@ Jump to [0-9](#0-9) | [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) - [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 [⇡](#plugins) +### 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 [⇡](#plugins) +### 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` -### X [⇡](#plugins) +### X [⇡](#plugins-) -### Y [⇡](#plugins) +### 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 [⇡](#plugins) +### Z [⇡](#plugins-) @@ -336,7 +336,7 @@ YOURLS supports localization: this means if a language file for YOURLS in availa Make YOURLS work with other platforms, programming languages or tools -### 3rd party Integrations and Frameworks [⇡](#integrations) +### 3rd party Integrations and Frameworks [⇡](#integrations-) - WordPress * [YOURLS Link Creator](http://wordpress.org/extend/plugins/yourls-link-creator/) @@ -363,7 +363,7 @@ Make YOURLS work with other platforms, programming languages or tools -### Applications [⇡](#integrations) +### 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)) @@ -383,7 +383,7 @@ Make YOURLS work with other platforms, programming languages or tools ## Guides & Tutorials [⇪](#readme) -### Installation guides [⇡](#guides--tutorials) +### 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/) @@ -402,13 +402,13 @@ Make YOURLS work with other platforms, programming languages or tools * [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) +### 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) +### 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/)