Skip to content

Commit

Permalink
readme.html Updates
Browse files Browse the repository at this point in the history 
* Added a link to installation guide for Ubuntu 18.04
* Updated links with HTTPS versions
* Corrected grammar mistakes
* Minor improvements
  • Loading branch information
@yakovmanshin @dgw
yakovmanshin authored and dgw committed Dec 18, 2018
1 parent 19709da commit 3e17759
Showing 1 changed file with 36 additions and 35 deletions.
71 changes: 36 additions & 35 deletions readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@

<!-- Title -->
<header role="banner">
<h1><a href="http://yourls.org/">YOURLS: <span>Y</span>our <span>O</span>wn <span>URL</span> <span>S</span>hortener</a></h1>
<h1><a href="https://yourls.org/">YOURLS: <span>Y</span>our <span>O</span>wn <span>URL</span> <span>S</span>hortener</a></h1>
</header>

<main role="main">
Expand All @@ -263,7 +263,7 @@ <h1><a href="http://yourls.org/">YOURLS: <span>Y</span>our <span>O</span>wn <spa

<div id="buttons">
<div id="fb">
<div class="fb-like" data-href="http://yourls.org/" data-send="false" data-share="true" data-layout="box_count" data-width="60" data-show-faces="false" data-font="verdana"></div>
<div class="fb-like" data-href="https://yourls.org/" data-send="false" data-share="true" data-layout="box_count" data-width="60" data-show-faces="false" data-font="verdana"></div>
<script>(function(d, s, id) {
var js, fjs = d.getElementsByTagName(s)[0];
if (d.getElementById(id)) return;
Expand All @@ -273,7 +273,7 @@ <h1><a href="http://yourls.org/">YOURLS: <span>Y</span>our <span>O</span>wn <spa
}(document, 'script', 'facebook-jssdk'));</script>
</div>
<div id="tw">
<a href="https://twitter.com/share" class="twitter-share-button" data-url="http://yourls.org" data-via="ozh" data-lang="en" data-related="YOURLS">Tweet</a>
<a href="https://twitter.com/share" class="twitter-share-button" data-url="https://yourls.org" data-via="ozh" data-lang="en" data-related="YOURLS">Tweet</a>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="https://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
</div>
<div id="g1">
Expand All @@ -287,15 +287,15 @@ <h1><a href="http://yourls.org/">YOURLS: <span>Y</span>our <span>O</span>wn <spa
<h2 class='first'>About YOURLS</h2>

<h3 id="what">What is YOURLS</h3>
<p><strong>YOURLS</strong> stands for <strong>Your Own URL Shortener</strong>. It is a small set of PHP scripts that will allow you to run your own URL shortening service (<em>a la</em> TinyURL or bitly).</p>
<p><strong>YOURLS</strong> stands for <strong>Your Own URL Shortener</strong>. It is a small set of PHP scripts that will allow you to run your own URL shortening service (<em>a la</em> TinyURL or Bitly).</p>

<p>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.</p>
<p>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.</p>

<h3 id="features">YOURLS Features</h3>
<ul>
<li><tt>Free</tt> and <tt>Open Source</tt> software.</li>
<li><tt>Free</tt> and <tt>open-source</tt> software.</li>
<li><tt>Private</tt> (your links only) or <tt>Public</tt> (everybody can create short links, fine for an intranet)</li>
<li>Sequential or custom URL keyword</li>
<li>Sequential or custom URL keywords</li>
<li>Handy <tt>bookmarklets</tt> to easily shorten and share links</li>
<li>Awesome <tt>stats</tt>: historical click reports, referrers tracking, visitors geo-location</li>
<li>Neat <tt>Ajaxed</tt> interface</li>
Expand All @@ -315,19 +315,19 @@ <h3 id="screenshots">Screenshots</h3>
<p>Stats for each short URL</p>
<img src="https://yourls.org/yourls-org-images/stats-anim.gif" />

<p>See a live example of YOURLS stats on <a href="http://yourls.org/cookie+">http://yourls.org/cookie+</a></p>
<p>See a live example of YOURLS stats on <a href="https://yourls.org/cookie+">https://yourls.org/cookie+</a></p>
</div>

<h2 id="download">Download</h2>

<p><a href="http://yourls.org/download">Download YOURLS</a> from Github</p>
<p>You can follow YOURLS' development on the <a href="http://yourls.org/revisions">commit history</a> and get <a href="https://github.com/YOURLS/YOURLS/archive/master.zip">current development build</a></p>
<p><a href="https://yourls.org/download">Download YOURLS</a> from Github</p>
<p>You can follow YOURLS' development on the <a href="https://yourls.org/revisions">commit history</a> and get <a href="https://github.com/YOURLS/YOURLS/archive/master.zip">current development build</a></p>

<h2 id="credits">Credits</h2>

<p>YOURLS is made by <a href="https://github.com/YOURLS/YOURLS/graphs/contributors">awesome people</a>.</p>

<p>Keep up to date: follow <a href="http://twitter.com/yourls">@yourls</a>, <a href="http://twitter.com/ozh">@ozh</a> (lead developer)and read the official <a href="http://blog.yourls.org/">YOURLS Blog</a></p>
<p>Keep up to date: follow <a href="https://twitter.com/yourls">@yourls</a>, <a href="https://twitter.com/ozh">@ozh</a> (lead developer) and read the official <a href="http://blog.yourls.org/">YOURLS Blog</a></p>
</div>

<!-- Installation Instructions -->
Expand All @@ -344,9 +344,10 @@ <h2 class='first' id="fresh">Fresh Install</h2>
<h3 class='first' id="auto">Install Guides</h3>
<p>Here is a list of some (unofficial) install guides using automated tools:</p>
<ul>
<li><a href="https://www.rosehosting.com/blog/how-to-install-yourls-on-ubuntu-14-04/">How to Install YOURLS on Ubuntu 14.04</a></li>
<li><a href="https://thishosting.rocks/how-to-shorten-your-links-with-your-own-domain/">How to Install YOURLS on a VPS or shared hosting</a></li>
<li><a href="https://www.websitehostingrating.com/how-to-install-yourls-using-softaculous/">How to Install YOURLS using Softaculous</a></li>
<li><a href="https://www.rosehosting.com/blog/how-to-install-yourls-on-ubuntu-14-04/">How to Install YOURLS on Ubuntu 14.04</a></li>
<li><a href="https://computingforgeeks.com/how-to-install-yourls-your-own-url-shortener-on-ubuntu-18-04-bionic-beaver-linux/">How to install YOURLS on Ubuntu 18.04</a></li>
<li><a href="https://thishosting.rocks/how-to-shorten-your-links-with-your-own-domain/">How to Install YOURLS on a VPS or shared hosting</a></li>
<li><a href="https://www.websitehostingrating.com/how-to-install-yourls-using-softaculous/">How to Install YOURLS using Softaculous</a></li>
</ul>
<h2 id="upgrade">Upgrade</h2>
<ol>
Expand Down Expand Up @@ -390,18 +391,18 @@ <h3 id="site">Site options</h3>
Timezone GMT offset<br/>
<em>Example:</em> <tt>define( 'YOURLS_HOURS_OFFSET', '-5' );</tt></li>
<li><code>YOURLS_PRIVATE</code><br/>
Private means the admin area will be protected with login/pass as defined below. See <a href="http://yourls.org/privatepublic">Private or Public</a> for more.<br/>
Private means the admin area will be protected with login/pass as defined below. See <a href="https://yourls.org/privatepublic">Private or Public</a> for more.<br/>
<em>Example:</em> <tt>define( 'YOURLS_PRIVATE', 'true' );</tt></li>
<li><code>YOURLS_UNIQUE_URLS</code><br/>
Allow multiple short URLs for a same long URL<br/>
Set to <tt>true</tt> to allow only one pair of shortURL/longURL (default YOURLS behavior), or to <tt>false</tt> to allow creation of multiple short URLs pointing to the same long URL (as bit.ly does)<br/>
<em>Example:</em> <tt>define( 'YOURLS_UNIQUE_URLS', 'true' );</tt></li>
<li><code>YOURLS_COOKIEKEY</code><br/>
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 <a href="http://yourls.org/cookie">http://yourls.org/cookie</a><br/>
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 <a href="https://yourls.org/cookie">https://yourls.org/cookie</a><br/>
<em>Example:</em> <tt>define( 'YOURLS_COOKIEKEY', 'qQ4KhL_pu|s@Zm7n#%:b^{A[vhm' );</tt></li>
<li><code>yourls_user_passwords</code><br/>
A list of username(s) and password(s) allowed to access the site if private<br/>
Passwords can either be in plain text, or encrypted: see <a href="http://yourls.org/userpassword">http://yourls.org/userpassword</a> for more information.<br/>
Passwords can either be in plain text, or encrypted: see <a href="https://yourls.org/userpassword">https://yourls.org/userpassword</a> for more information.<br/>
<em>Example:</em> <tt>'joe' => 'mypassword'</tt></li>
</ul>

Expand Down Expand Up @@ -432,7 +433,7 @@ <h3 id="advanced">Advanced settings</h3>
<ul>
<li>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 <code>config.php</code>:<br/>
<tt>define( 'YOURLS_DB_DRIVER', 'mysqli' );</tt></li>
<li>You can install YOURLS behind a firewall or a proxy: see <a href="http://yourls.org/proxy">Proxy Support</a></li>
<li>You can install YOURLS behind a firewall or a proxy: see <a href="https://yourls.org/proxy">Proxy Support</a></li>
<li>File <code>includes/load-yourls.php</code> contains a few more undocumented but self explanatory and commented settings. Add them to your own <code>config.php</code> if you know what you're doing.</li>
</ul>
</div>
Expand All @@ -444,11 +445,11 @@ <h2 class='first'>Plugins for YOURLS</h2>
<h3 id="plugins">Plugins?</h3>
<p>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.</p>
<p>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.</p>
<p>There's a growing number of plugins available: check the <a href="http://yourls.org/pluginlist">Plugin list</a>.</p>
<p>There's a growing number of plugins available: check the <a href="https://yourls.org/pluginlist">Plugin list</a>.</p>

<h3 id="documentation">Documentation</h3>
<p>Several sample plugins are included in the archive. Read the source and learn the concept. It's easy and fun!</p>
<p>Check the <a href="http://yourls.org/pluginapi">plugin API documentation</a> to learn more</p>
<p>Check the <a href="https://yourls.org/pluginapi">plugin API documentation</a> to learn more</p>

</div>

Expand All @@ -465,9 +466,9 @@ <h3 id="apifeatures">Features</h3>
</ul>

<h3 id="apiusage">Usage</h3>
<p>You need to send parameters to <code>http://your-own-domain-here.com/yourls-api.php</code> either via <code>GET</code> or <code>POST</code> (remember to <strong></strong>URL encode parameters</strong> if via GET). These parameters are:</p>
<p>You need to send parameters to <code>http://your-own-domain-here.com/yourls-api.php</code> either via <code>GET</code> or <code>POST</code> (remember to <strong>URL-encode parameters</strong> if via GET). These parameters are:</p>
<ul>
<li>A valid <code>username</code> / <code>password</code> pair, or your <code>signature</code> (see <a href="http://yourls.org/passwordlessapi">Passwordless API requests</a>)</li>
<li>A valid <code>username</code> / <code>password</code> pair, or your <code>signature</code> (see <a href="https://yourls.org/passwordlessapi">Passwordless API requests</a>)</li>
<li>The requested <code>action</code>: <tt>"shorturl"</tt> (get short URL for a link), <tt>"expand"</tt> (get long URL of a shorturl), <tt>"url-stats"</tt> (get stats about one short URL), <tt>"stats"</tt> (get stats about your links) or <tt>"db-stats"</tt> (get global link and click count)</li>
<li>With <tt>action = "shorturl"</tt> :
<ul>
Expand Down Expand Up @@ -577,7 +578,7 @@ <h3 id="apisample">Sample file</h3>
<p>There's a sample PHP file included that serves as an example on how to play with the API</p>

<h3 id="expand_api">Expand the API</h3>
<p>You can easily implement custom API actions with a plugin. See the <a href="http://yourls.org/pluginlist">plugin list</a> for examples.</p>
<p>You can easily implement custom API actions with a plugin. See the <a href="https://yourls.org/pluginlist">plugin list</a> for examples.</p>

</div>

Expand Down Expand Up @@ -615,7 +616,7 @@ <h3 id="base3662">Difference Between Base 36 And Base 62 Encoding</h3>

<h3 id="shortdomain">Getting a short domain name for your YOURLS install</h3>
<ul>
<li>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 <a href="http://yourls.org/dreamhost">Dreamhost</a> and it works just great.</li>
<li>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 <a href="https://yourls.org/dreamhost">Dreamhost</a> and it works just great.</li>
<li><a href="http://domai.nr/">Domainr</a> is a fun search tool that might inspire and help you</li>
<li>Aim for exotic top level domains (.in, .im, .li ...), they're often cheap and a lot are still available. <a href="https://www.gandi.net/domain/buy/search/">Gandi</a> is a pretty comprehensive registrar, for instance.</li>
</ul>
Expand All @@ -629,7 +630,7 @@ <h3 id="htaccess">YOURLS needs its own .htaccess</h3>
<h3 id="does404">If YOURLS generates 404 for your short URLs</h3>
<ul>
<li>Make sure <strong>mod_rewrite</strong> is enabled with your Apache server</li>
<li>Make sure your .htaccess file looks like <a href="http://yourls.org/htaccess">this one</a></li>
<li>Make sure your .htaccess file looks like <a href="https://yourls.org/htaccess">this one</a></li>
<li>Eventually, check your server Apache configuration allows use of .htaccess (<tt>AllowOverride All</tt> directive, ask your server admin)</li>
</ul>

Expand All @@ -650,22 +651,22 @@ <h3 id="stats">"Stats don't update as I think they should", "difference with Goo
<h3 id="noindex">There is no index page at the root of the install</h3>
<ul>
<li>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.</li>
<li>If you want to make a public interface and run your own little bitly.com, there's a sample file provided as an example: <code>sample-public-front-page.txt</code>. This implies important issues to deal with: spam, performance and security. Read <a href="http://yourls.org/public">Public Shortening</a> for important information.</li>
<li>If you want to make a public interface and run your own little bitly.com, there's a sample file provided as an example: <code>sample-public-front-page.txt</code>. This implies important issues to deal with: spam, performance and security. Read <a href="https://yourls.org/public">Public Shortening</a> for important information.</li>
</ul>

<h3 id="lowercase">Uppercase letters in short URLs are eaten up, eg "<code>OmgOzh</code>" becomes "<code>mgzh</code>" !</h3>
<ul>
<li>Indeed. It's intented if you selected Base 36 (see above). Letters that don't belong to the character set, eg <code>@#!</code> or <code>ABC</code>, are removed.</li>
<li>If you want to force lowercase, you'll need a <a href="http://yourls.org/pluginlist">plugin</a>.</li>
<li>If you want to force lowercase, you'll need a <a href="https://yourls.org/pluginlist">plugin</a>.</li>
</ul>

<h3 id="feedback">Feedback, feature requests and bug reporting</h3>
<ol>
<li>Please don't get in touch directly by mail or Twitter. <a href="http://yourls.org/support">Please</a>.</li>
<li>Check the <a href="http://yourls.org/roadmap">Road Map</a> for future features.</li>
<li>Read all the <a href="http://yourls.org/wiki">wiki documents</a>.</li>
<li>Search in all the <a href="http://yourls.org/issues">issues</a>, open and closed.</li>
<li>Eventually raise a new issue. To do so, please read the <a href="http://yourls.org/contribute">contribute guidelines</a>. Thanks!</li>
<li>Please don't get in touch directly by mail or Twitter. <a href="https://yourls.org/support">Please</a>.</li>
<li>Check the <a href="https://yourls.org/roadmap">Road Map</a> for future features.</li>
<li>Read all the <a href="https://yourls.org/wiki">wiki documents</a>.</li>
<li>Search in all the <a href="https://yourls.org/issues">issues</a>, open and closed.</li>
<li>Eventually raise a new issue. To do so, please read the <a href="https://yourls.org/contribute">contribute guidelines</a>. Thanks!</li>
</ol>

</div>
Expand All @@ -681,7 +682,7 @@ <h2 class='first'>Community</h2>
<h3 id="ressources">Resources</h3>
<ul>
<li>The official <a href="http://blog.yourls.org">YOURLS blog</a>, for news, hints and showcase.</li>
<li>The <a href="http://yourls.org/wiki">wiki</a>: advanced documentation, plugins, tips and more</li>
<li>The <a href="https://yourls.org/wiki">wiki</a>: advanced documentation, plugins, tips and more</li>
<li>Follow <a href="https://twitter.com/YOURLS">@YOURLS</a> for hardcore development, and <a href="https://twitter.com/ozh">@Ozh</a> for tips and news (and random geekiness too)</li>
</ul>

Expand Down Expand Up @@ -784,7 +785,7 @@ <h2 id="morestuff">More stuff to do with YOURLS</h2>
<li><a href="http://foolrulez.org/blog/2009/09/yourls-widget-released">YOURLS Widget for WordPress</a><br/>
This widget adds a convenient short URL service into your sidebar. Check the above link for a live example</li>

<li><a href="http://www.stewartallen.org/2010/08/yourls-twitter-tools-wordpress-plugin/">Twitter Tools & YOURLS</a><br/>
<li><a href="http://www.stewartallen.org/2010/08/yourls-twitter-tools-wordpress-plugin/">Twitter Tools &amp; YOURLS</a><br/>
Companion plugin for Alex King's Twitter Tool for WordPress, that enables YOURLS support</li>

<li>YOURLS featured on <a href="http://lifehacker.com/5335216/make-your-own-url-shortening-service">Lifehacker</a></li>
Expand All @@ -805,7 +806,7 @@ <h2>"Celebrity endorsements", sort of.</h2>

<li><a href="http://virg.in/">http://virg.in/</a> for the <a href="http://www.virgin.com/">Virgin Group companies</a></li>

<li><a href="http://dhurl.org/">http://dhurl.org/</a> by <a href="http://yourls.org/dreamhost">Dreamhost</a></li>
<li><a href="http://dhurl.org/">http://dhurl.org/</a> by <a href="https://yourls.org/dreamhost">Dreamhost</a></li>

<li><a href="https://rho.st/">https://rho.st/</a> by <a href="https://www.rosehosting.com/">RoseHosting.com</a></li>

Expand Down

0 comments on commit 3e17759

Please sign in to comment.