YOURLS: Your Own
-
+
@@ -287,15 +287,15 @@ YOURLS: Your Own About YOURLS
What is YOURLS
- YOURLS stands for Your Own URL Shortener. It is a small set of PHP scripts that will allow you to run your own URL shortening service (a la TinyURL or bitly).
+ YOURLS stands for Your Own URL Shortener. It is a small set of PHP scripts that will allow you to run your own URL shortening service (a la TinyURL or Bitly).
- Running your own URL shortener is fun, geeky and useful: you own your data and don't depend on third party services. It's also a great way to add branding to your short URLs, instead of using the same public URL shortener everyone uses.
+ Running your own URL shortener is fun, geeky and useful: you own your data and don't depend on third-party services. It's also a great way to add branding to your short URLs, instead of using the same public URL shortener everyone uses.
YOURLS Features
- - Free and Open Source software.
+ - Free and open-source software.
- Private (your links only) or Public (everybody can create short links, fine for an intranet)
- - Sequential or custom URL keyword
+ - Sequential or custom URL keywords
- Handy bookmarklets to easily shorten and share links
- Awesome stats: historical click reports, referrers tracking, visitors geo-location
- Neat Ajaxed interface
@@ -315,19 +315,19 @@ Screenshots
Stats for each short URL
- See a live example of YOURLS stats on http://yourls.org/cookie+
+ See a live example of YOURLS stats on https://yourls.org/cookie+
Download
- Download YOURLS from Github
- You can follow YOURLS' development on the commit history and get current development build
+ Download YOURLS from Github
+ You can follow YOURLS' development on the commit history and get current development build
Credits
YOURLS is made by awesome people.
- Keep up to date: follow @yourls, @ozh (lead developer)and read the official YOURLS Blog
+ Keep up to date: follow @yourls, @ozh (lead developer) and read the official YOURLS Blog
@@ -344,9 +344,10 @@ Fresh Install
Install Guides
Here is a list of some (unofficial) install guides using automated tools:
- - How to Install YOURLS on Ubuntu 14.04
- - How to Install YOURLS on a VPS or shared hosting
- - How to Install YOURLS using Softaculous
+ - How to Install YOURLS on Ubuntu 14.04
+ - How to install YOURLS on Ubuntu 18.04
+ - How to Install YOURLS on a VPS or shared hosting
+ - How to Install YOURLS using Softaculous
Upgrade
@@ -390,18 +391,18 @@ Site options
Timezone GMT offset
Example: define( 'YOURLS_HOURS_OFFSET', '-5' );
YOURLS_PRIVATE
- Private means the admin area will be protected with login/pass as defined below. See Private or Public for more.
+ Private means the admin area will be protected with login/pass as defined below. See Private or Public for more.
Example: define( 'YOURLS_PRIVATE', 'true' );YOURLS_UNIQUE_URLS
Allow multiple short URLs for a same long URL
Set to true to allow only one pair of shortURL/longURL (default YOURLS behavior), or to false to allow creation of multiple short URLs pointing to the same long URL (as bit.ly does)
Example: define( 'YOURLS_UNIQUE_URLS', 'true' );YOURLS_COOKIEKEY
- A random secret hash used to encrypt cookies. You don't have to remember it, make it long and complicated. Hint: generate a unique one at http://yourls.org/cookie
+ A random secret hash used to encrypt cookies. You don't have to remember it, make it long and complicated. Hint: generate a unique one at https://yourls.org/cookie
Example: define( 'YOURLS_COOKIEKEY', 'qQ4KhL_pu|s@Zm7n#%:b^{A[vhm' );yourls_user_passwords
A list of username(s) and password(s) allowed to access the site if private
- Passwords can either be in plain text, or encrypted: see http://yourls.org/userpassword for more information.
+ Passwords can either be in plain text, or encrypted: see https://yourls.org/userpassword for more information.
Example: 'joe' => 'mypassword'Advanced settings
- YOURLS will look for the MySQL extension PDO, MySQLi or MySQL, in that order. If you want to force usage of one particular extension, add the following line to your
config.php:
define( 'YOURLS_DB_DRIVER', 'mysqli' );
- - You can install YOURLS behind a firewall or a proxy: see Proxy Support
+ - You can install YOURLS behind a firewall or a proxy: see Proxy Support
- File
includes/load-yourls.php contains a few more undocumented but self explanatory and commented settings. Add them to your own config.php if you know what you're doing.
@@ -444,11 +445,11 @@ Plugins for YOURLS
Plugins?
Plugins are additional PHP scripts that extend the functionalities or features of YOURLS. The core of YOURLS is designed to be as light as possible and avoid bloat (implementing functions not everybody needs) and to allow for easy customization.
Using the plugin architecture, you can add new features to YOURLS without having to modify core files. This way, your changes won't be lost when you upgrade your YOURLS installation and you can easily activate and deactivate a plugin from the admin interface.
- There's a growing number of plugins available: check the Plugin list.
+ There's a growing number of plugins available: check the Plugin list.
Documentation
Several sample plugins are included in the archive. Read the source and learn the concept. It's easy and fun!
- Check the plugin API documentation to learn more
+ Check the plugin API documentation to learn more
@@ -465,9 +466,9 @@ Features
Usage
- You need to send parameters to http://your-own-domain-here.com/yourls-api.php either via GET or POST (remember to URL encode parameters if via GET). These parameters are:
+ You need to send parameters to http://your-own-domain-here.com/yourls-api.php either via GET or POST (remember to URL-encode parameters if via GET). These parameters are:
- - A valid
username / password pair, or your signature (see Passwordless API requests)
+ - A valid
username / password pair, or your signature (see Passwordless API requests)
- The requested
action: "shorturl" (get short URL for a link), "expand" (get long URL of a shorturl), "url-stats" (get stats about one short URL), "stats" (get stats about your links) or "db-stats" (get global link and click count)
- With action = "shorturl" :
@@ -577,7 +578,7 @@ Sample file
There's a sample PHP file included that serves as an example on how to play with the API
Expand the API
- You can easily implement custom API actions with a plugin. See the plugin list for examples.
+ You can easily implement custom API actions with a plugin. See the plugin list for examples.
@@ -615,7 +616,7 @@ Difference Between Base 36 And Base 62 Encoding
Getting a short domain name for your YOURLS install
- - Unless you plan on making it public and as popular as bit.ly, any shared hosting will be fine. Ozh runs all his YOURLS instance on Dreamhost and it works just great.
+ - Unless you plan on making it public and as popular as bit.ly, any shared hosting will be fine. Ozh runs all his YOURLS instance on Dreamhost and it works just great.
- Domainr is a fun search tool that might inspire and help you
- Aim for exotic top level domains (.in, .im, .li ...), they're often cheap and a lot are still available. Gandi is a pretty comprehensive registrar, for instance.
@@ -629,7 +630,7 @@ YOURLS needs its own .htaccess
If YOURLS generates 404 for your short URLs
- Make sure mod_rewrite is enabled with your Apache server
- - Make sure your .htaccess file looks like this one
+ - Make sure your .htaccess file looks like this one
- Eventually, check your server Apache configuration allows use of .htaccess (AllowOverride All directive, ask your server admin)
@@ -650,22 +651,22 @@ "Stats don't update as I think they should", "difference with Goo
There is no index page at the root of the install
- Indeed. It's intended. It's up to the user to make what they need. Some will redirect the root to a different place, some make a public interface for anyone to shorten links, some make a portfolio. You make it.
- - If you want to make a public interface and run your own little bitly.com, there's a sample file provided as an example:
sample-public-front-page.txt. This implies important issues to deal with: spam, performance and security. Read Public Shortening for important information.
+ - If you want to make a public interface and run your own little bitly.com, there's a sample file provided as an example:
sample-public-front-page.txt. This implies important issues to deal with: spam, performance and security. Read Public Shortening for important information.
Uppercase letters in short URLs are eaten up, eg "OmgOzh" becomes "mgzh" !
- Indeed. It's intented if you selected Base 36 (see above). Letters that don't belong to the character set, eg
@#! or ABC, are removed.
- - If you want to force lowercase, you'll need a plugin.
+ - If you want to force lowercase, you'll need a plugin.
Feedback, feature requests and bug reporting
- - Please don't get in touch directly by mail or Twitter. Please.
- - Check the Road Map for future features.
- - Read all the wiki documents.
- - Search in all the issues, open and closed.
- - Eventually raise a new issue. To do so, please read the contribute guidelines. Thanks!
+ - Please don't get in touch directly by mail or Twitter. Please.
+ - Check the Road Map for future features.
+ - Read all the wiki documents.
+ - Search in all the issues, open and closed.
+ - Eventually raise a new issue. To do so, please read the contribute guidelines. Thanks!
@@ -681,7 +682,7 @@ Community
Resources
- The official YOURLS blog, for news, hints and showcase.
- - The wiki: advanced documentation, plugins, tips and more
+ - The wiki: advanced documentation, plugins, tips and more
- Follow @YOURLS for hardcore development, and @Ozh for tips and news (and random geekiness too)
@@ -784,7 +785,7 @@ More stuff to do with YOURLS
- YOURLS Widget for WordPress
This widget adds a convenient short URL service into your sidebar. Check the above link for a live example
- - Twitter Tools & YOURLS
+ - Twitter Tools & YOURLS
Companion plugin for Alex King's Twitter Tool for WordPress, that enables YOURLS support
- YOURLS featured on Lifehacker
@@ -805,7 +806,7 @@ "Celebrity endorsements", sort of.
- http://virg.in/ for the Virgin Group companies
- - http://dhurl.org/ by Dreamhost
+ - http://dhurl.org/ by Dreamhost
- https://rho.st/ by RoseHosting.com
YOURLS: Your Own About YOURLS
What is YOURLS
- YOURLS stands for Your Own URL Shortener. It is a small set of PHP scripts that will allow you to run your own URL shortening service (a la TinyURL or bitly).
+ YOURLS stands for Your Own URL Shortener. It is a small set of PHP scripts that will allow you to run your own URL shortening service (a la TinyURL or Bitly).
- Running your own URL shortener is fun, geeky and useful: you own your data and don't depend on third party services. It's also a great way to add branding to your short URLs, instead of using the same public URL shortener everyone uses.
+ Running your own URL shortener is fun, geeky and useful: you own your data and don't depend on third-party services. It's also a great way to add branding to your short URLs, instead of using the same public URL shortener everyone uses.
YOURLS Features
- - Free and Open Source software.
+ - Free and open-source software.
- Private (your links only) or Public (everybody can create short links, fine for an intranet)
- - Sequential or custom URL keyword
+ - Sequential or custom URL keywords
- Handy bookmarklets to easily shorten and share links
- Awesome stats: historical click reports, referrers tracking, visitors geo-location
- Neat Ajaxed interface
@@ -315,19 +315,19 @@ Screenshots
Stats for each short URL
- See a live example of YOURLS stats on http://yourls.org/cookie+
+ See a live example of YOURLS stats on https://yourls.org/cookie+
What is YOURLS
-YOURLS stands for Your Own URL Shortener. It is a small set of PHP scripts that will allow you to run your own URL shortening service (a la TinyURL or bitly).
+YOURLS stands for Your Own URL Shortener. It is a small set of PHP scripts that will allow you to run your own URL shortening service (a la TinyURL or Bitly).
-Running your own URL shortener is fun, geeky and useful: you own your data and don't depend on third party services. It's also a great way to add branding to your short URLs, instead of using the same public URL shortener everyone uses.
+Running your own URL shortener is fun, geeky and useful: you own your data and don't depend on third-party services. It's also a great way to add branding to your short URLs, instead of using the same public URL shortener everyone uses.
YOURLS Features
-
-
- Free and Open Source software. +
- Free and open-source software.
- Private (your links only) or Public (everybody can create short links, fine for an intranet) -
- Sequential or custom URL keyword +
- Sequential or custom URL keywords
- Handy bookmarklets to easily shorten and share links
- Awesome stats: historical click reports, referrers tracking, visitors geo-location
- Neat Ajaxed interface @@ -315,19 +315,19 @@
Screenshots
Stats for each short URL
- See a live example of YOURLS stats on http://yourls.org/cookie+
+See a live example of YOURLS stats on https://yourls.org/cookie+
Download
-Download YOURLS from Github
-You can follow YOURLS' development on the commit history and get current development build
+Download YOURLS from Github
+You can follow YOURLS' development on the commit history and get current development build
Credits
YOURLS is made by awesome people.
-Keep up to date: follow @yourls, @ozh (lead developer)and read the official YOURLS Blog
+Keep up to date: follow @yourls, @ozh (lead developer) and read the official YOURLS Blog
@@ -344,9 +344,10 @@Fresh Install
Install Guides
Here is a list of some (unofficial) install guides using automated tools:
-
-
- How to Install YOURLS on Ubuntu 14.04 -
- How to Install YOURLS on a VPS or shared hosting -
- How to Install YOURLS using Softaculous +
- How to Install YOURLS on Ubuntu 14.04 +
- How to install YOURLS on Ubuntu 18.04 +
- How to Install YOURLS on a VPS or shared hosting +
- How to Install YOURLS using Softaculous
Upgrade
-
@@ -390,18 +391,18 @@
YOURLS_PRIVATE
- Private means the admin area will be protected with login/pass as defined below. See Private or Public for more.
+ Private means the admin area will be protected with login/pass as defined below. See Private or Public for more.
Example: define( 'YOURLS_PRIVATE', 'true' );YOURLS_UNIQUE_URLS
Allow multiple short URLs for a same long URL
Set to true to allow only one pair of shortURL/longURL (default YOURLS behavior), or to false to allow creation of multiple short URLs pointing to the same long URL (as bit.ly does)
Example: define( 'YOURLS_UNIQUE_URLS', 'true' );YOURLS_COOKIEKEY
- A random secret hash used to encrypt cookies. You don't have to remember it, make it long and complicated. Hint: generate a unique one at http://yourls.org/cookie
+ A random secret hash used to encrypt cookies. You don't have to remember it, make it long and complicated. Hint: generate a unique one at https://yourls.org/cookie
Example: define( 'YOURLS_COOKIEKEY', 'qQ4KhL_pu|s@Zm7n#%:b^{A[vhm' );yourls_user_passwords
A list of username(s) and password(s) allowed to access the site if private
- Passwords can either be in plain text, or encrypted: see http://yourls.org/userpassword for more information.
+ Passwords can either be in plain text, or encrypted: see https://yourls.org/userpassword for more information.
Example: 'joe' => 'mypassword'
@@ -432,7 +433,7 @@ - YOURLS will look for the MySQL extension PDO, MySQLi or MySQL, in that order. If you want to force usage of one particular extension, add the following line to your
config.php:
define( 'YOURLS_DB_DRIVER', 'mysqli' );
- - You can install YOURLS behind a firewall or a proxy: see Proxy Support +
- You can install YOURLS behind a firewall or a proxy: see Proxy Support
- File
includes/load-yourls.phpcontains a few more undocumented but self explanatory and commented settings. Add them to your ownconfig.phpif you know what you're doing. - A valid
username/passwordpair, or yoursignature(see Passwordless API requests)
+ - A valid
username/passwordpair, or yoursignature(see Passwordless API requests) - The requested
action: "shorturl" (get short URL for a link), "expand" (get long URL of a shorturl), "url-stats" (get stats about one short URL), "stats" (get stats about your links) or "db-stats" (get global link and click count) - With action = "shorturl" :
-
@@ -577,7 +578,7 @@
- Unless you plan on making it public and as popular as bit.ly, any shared hosting will be fine. Ozh runs all his YOURLS instance on Dreamhost and it works just great. +
- Unless you plan on making it public and as popular as bit.ly, any shared hosting will be fine. Ozh runs all his YOURLS instance on Dreamhost and it works just great.
- Domainr is a fun search tool that might inspire and help you
- Aim for exotic top level domains (.in, .im, .li ...), they're often cheap and a lot are still available. Gandi is a pretty comprehensive registrar, for instance.
- Make sure mod_rewrite is enabled with your Apache server -
- Make sure your .htaccess file looks like this one +
- Make sure your .htaccess file looks like this one
- Eventually, check your server Apache configuration allows use of .htaccess (AllowOverride All directive, ask your server admin)
- Indeed. It's intended. It's up to the user to make what they need. Some will redirect the root to a different place, some make a public interface for anyone to shorten links, some make a portfolio. You make it. -
- If you want to make a public interface and run your own little bitly.com, there's a sample file provided as an example:
sample-public-front-page.txt. This implies important issues to deal with: spam, performance and security. Read Public Shortening for important information.
+ - If you want to make a public interface and run your own little bitly.com, there's a sample file provided as an example:
sample-public-front-page.txt. This implies important issues to deal with: spam, performance and security. Read Public Shortening for important information. - Indeed. It's intented if you selected Base 36 (see above). Letters that don't belong to the character set, eg
@#!orABC, are removed.
- - If you want to force lowercase, you'll need a plugin. +
- If you want to force lowercase, you'll need a plugin.
- Please don't get in touch directly by mail or Twitter. Please. -
- Check the Road Map for future features. -
- Read all the wiki documents. -
- Search in all the issues, open and closed. -
- Eventually raise a new issue. To do so, please read the contribute guidelines. Thanks! +
- Please don't get in touch directly by mail or Twitter. Please. +
- Check the Road Map for future features. +
- Read all the wiki documents. +
- Search in all the issues, open and closed. +
- Eventually raise a new issue. To do so, please read the contribute guidelines. Thanks!
- The official YOURLS blog, for news, hints and showcase. -
- The wiki: advanced documentation, plugins, tips and more +
- The wiki: advanced documentation, plugins, tips and more
- Follow @YOURLS for hardcore development, and @Ozh for tips and news (and random geekiness too)
- YOURLS Widget for WordPress
This widget adds a convenient short URL service into your sidebar. Check the above link for a live example
- - Twitter Tools & YOURLS
+ - Twitter Tools & YOURLS
Companion plugin for Alex King's Twitter Tool for WordPress, that enables YOURLS support - YOURLS featured on Lifehacker @@ -805,7 +806,7 @@
- http://virg.in/ for the Virgin Group companies -
- http://dhurl.org/ by Dreamhost +
- http://dhurl.org/ by Dreamhost
- https://rho.st/ by RoseHosting.com
Sample file
There's a sample PHP file included that serves as an example on how to play with the API
Expand the API
-You can easily implement custom API actions with a plugin. See the plugin list for examples.
+You can easily implement custom API actions with a plugin. See the plugin list for examples.
@@ -615,7 +616,7 @@Difference Between Base 36 And Base 62 Encoding
Getting a short domain name for your YOURLS install
-
-
YOURLS needs its own .htaccess
If YOURLS generates 404 for your short URLs
"Stats don't update as I think they should", "difference with Goo
There is no index page at the root of the install
Uppercase letters in short URLs are eaten up, eg "
OmgOzh" becomes "mgzh" !Feedback, feature requests and bug reporting
-
-
Community
Resources
More stuff to do with YOURLS
"Celebrity endorsements", sort of.
Site options
Timezone GMT offsetExample: define( 'YOURLS_HOURS_OFFSET', '-5' );
Advanced settings
Plugins for YOURLS
Plugins?
Plugins are additional PHP scripts that extend the functionalities or features of YOURLS. The core of YOURLS is designed to be as light as possible and avoid bloat (implementing functions not everybody needs) and to allow for easy customization.
Using the plugin architecture, you can add new features to YOURLS without having to modify core files. This way, your changes won't be lost when you upgrade your YOURLS installation and you can easily activate and deactivate a plugin from the admin interface.
-There's a growing number of plugins available: check the Plugin list.
+There's a growing number of plugins available: check the Plugin list.
Documentation
Several sample plugins are included in the archive. Read the source and learn the concept. It's easy and fun!
-Check the plugin API documentation to learn more
+Check the plugin API documentation to learn more
@@ -465,9 +466,9 @@Features
Usage
-You need to send parameters to http://your-own-domain-here.com/yourls-api.php either via GET or POST (remember to URL encode parameters if via GET). These parameters are:
You need to send parameters to http://your-own-domain-here.com/yourls-api.php either via GET or POST (remember to URL-encode parameters if via GET). These parameters are:
-
-