1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
\r
2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
\r
4 <meta http-equiv="X-UA-Compatible" content="chrome=1">
\r
5 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
\r
6 <title>YOURLS: Your Own URL Shortener</title>
\r
7 <link href='http://fonts.googleapis.com/css?family=Magra:400,700' rel='stylesheet' type='text/css'>
\r
8 <style type="text/css" media="screen">
\r
11 font-family: Verdana, Arial, sans-serif;
\r
32 margin: 10px 20px 0px 20px;
\r
34 border: 1px solid #8d8d8d;
\r
35 background-color: #f5f5f5;
\r
43 a, a:active, a:link, a:visited {
\r
45 text-decoration: none;
\r
49 text-decoration: underline;
\r
59 border:1px solid #2A85B3;
\r
64 position:absolute; background: #E3F3FF; width:100%; height:230px; top:0px; left:0px; z-index:-1;
\r
65 background: -webkit-gradient(linear, left top, left bottom, from(rgba(227, 243, 255, 1)), to(rgba(227, 243, 255, 0)));
\r
66 background: -moz-linear-gradient(top, rgba(227, 243, 255, 1), rgba(227, 243, 255, 0.1)); /* for firefox 3.6+ */
\r
68 #buttons{ width:80px; margin-top:10px; float:right; position:absolute; margin-left: 810px;}
\r
69 #fb,#g1,#tw{ float:left; margin:0 5px; width: 60px; text-align: center; margin-bottom: 10px; padding:7px 2px; border:2px solid #2A85B3; background: #E3F3FF; border-radius:10px;}
\r
70 #fb span {width:50px !important}
\r
72 /* Place Holder Style */
\r
80 background: none repeat scroll 0 0 white;
\r
81 border: 3px solid #2A85B3;
\r
82 -moz-border-radius:20px;
\r
83 -webkit-border-radius:20px;
\r
84 border-radius: 20px;
\r
87 padding: 5px 20px 10px;
\r
95 font-family: 'Magra', Verdana, Arial;
\r
100 margin-bottom: 0px;
\r
101 background:transparent url(http://yourls.org/images/yourls-logo.png) left 5px no-repeat;
\r
104 padding-left:220px;
\r
107 h1 a:hover{text-decoration:none}
\r
110 text-decoration:underline;
\r
113 font-family: 'Magra', Verdana, Arial;
\r
119 h2.first{margin-top:10px}
\r
125 font-family: 'Magra', Verdana, Arial;
\r
137 font-family: Verdana, Arial;
\r
140 list-style-type: none;
\r
141 padding-bottom: 28px;
\r
142 border-bottom: 1px solid #2A85B3;
\r
143 margin:0 30px 12px 30px;
\r
149 background-color: #deedfb;
\r
150 margin: 3px 0px 0px 5px;
\r
151 border: 2px solid #2A85B3;
\r
152 -webkit-border-top-left-radius: 10px;
\r
153 -webkit-border-top-right-radius: 10px;
\r
154 -moz-border-radius-topleft: 10px;
\r
155 -moz-border-radius-topright: 10px;
\r
156 border-top-left-radius: 10px;
\r
157 border-top-right-radius: 10px;
\r
163 text-decoration: none;
\r
166 #Tabs li.Tab a:hover {
\r
167 background-color: #bfe0fe;
\r
168 -webkit-border-top-left-radius: 10px;
\r
169 -webkit-border-top-right-radius: 10px;
\r
170 -moz-border-radius-topleft: 10px;
\r
171 -moz-border-radius-topright: 10px;
\r
172 border-top-left-radius: 10px;
\r
173 border-top-right-radius: 10px;
\r
176 #Tabs li.SelectedTab {
\r
179 background-color: #fff;
\r
180 margin: 0px 0px 0px 5px;
\r
181 border-top: 2px solid #2A85B3;
\r
182 border-right: 2px solid #2A85B3;
\r
183 border-left: 2px solid #2A85B3;
\r
184 border-bottom: 6px solid #fff;
\r
185 -webkit-border-top-left-radius: 10px;
\r
186 -webkit-border-top-right-radius: 10px;
\r
187 -moz-border-radius-topleft: 10px;
\r
188 -moz-border-radius-topright: 10px;
\r
189 border-top-left-radius: 10px;
\r
190 border-top-right-radius: 10px;
\r
192 #Tabs li.SelectedTab a {
\r
196 text-decoration: none;
\r
210 border:1px solid #2A85B3;
\r
211 -webkit-border-radius: 10px;
\r
212 -webkit-border-bottom-right-radius: 25px;
\r
213 -webkit-border-bottom-left-radius: 25px;
\r
214 -moz-border-radius: 10px;
\r
215 -moz-border-radius-bottomright: 30px;
\r
216 -moz-border-radius-bottomleft: 30px;
\r
217 border-radius: 10px;
\r
218 border-bottom-right-radius: 30px;
\r
219 border-bottom-left-radius: 30px;
\r
222 background:#fff url(http://yourls.org/images/favicon.gif) 2px center no-repeat;
\r
226 <!--[if IE]> <style>#fade{display:none}</style> <![endif]-->
\r
229 <div id="fb-root"></div>
\r
230 <div id="Container">
\r
233 <h1><a href="http://yourls.org/">YOURLS: <span>Y</span>our <span>O</span>wn <span>URL</span> <span>S</span>hortener</a></h1>
\r
237 <li id="MoreTab" class="Tab"><a href="#More" onclick="toggle(this);">More</a></li>
\r
238 <li id="FAQTab" class="Tab"><a href="#FAQ" onclick="toggle(this);">FAQ</a></li>
\r
239 <li id="APITab" class="Tab"><a href="#API" onclick="toggle(this);">API</a></li>
\r
240 <li id="PluginTab" class="Tab"><a href="#Plugin" onclick="toggle(this);">WordPress plugin</a></li>
\r
241 <li id="PluginsTab" class="Tab"><a href="#Plugins" onclick="toggle(this);">YOURLS plugins</a></li>
\r
242 <li id="ConfigTab" class="Tab"><a href="#Config" onclick="toggle(this);">Config</a></li>
\r
243 <li id="InstallTab" class="Tab"><a href="#Install" onclick="toggle(this);">Install/Upgrade</a></li>
\r
244 <li id="AboutTab" class="SelectedTab"><a href="#About" onclick="toggle(this);">About</a></li>
\r
252 <div class="fb-like" data-href="http://yourls.org/" data-send="false" data-layout="box_count" data-width="60" data-show-faces="true" data-font="verdana"></div>
\r
254 <script>(function(d, s, id) {
\r
255 var js, fjs = d.getElementsByTagName(s)[0];
\r
256 if (d.getElementById(id)) return;
\r
257 js = d.createElement(s); js.id = id;
\r
258 js.src = "https://connect.facebook.net/en_US/all.js#xfbml=1&appId=125474947598196";
\r
259 fjs.parentNode.insertBefore(js, fjs);
\r
260 }(document, 'script', 'facebook-jssdk'));</script>
\r
263 <div class="g-plusone" data-size="tall" data-href="http://yourls.org/"></div>
\r
264 <script type="text/javascript">(function(){var po=document.createElement('script');po.type='text/javascript';po.async=true;po.src='https://apis.google.com/js/plusone.js';var s=document.getElementsByTagName('script')[0];s.parentNode.insertBefore(po,s);})();</script>
\r
267 <a href="https://twitter.com/share" class="twitter-share-button" data-url="http://yourls.org" data-via="ozh" data-lang="en" data-related="YOURLS" data-count="vertical">Tweet</a>
\r
268 <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>
\r
273 <div id="AboutDiv">
\r
274 <h2 class='first'>About YOURLS</h2>
\r
276 <h3>What is YOURLS</h3>
\r
277 <p>YOURLS is a small set of PHP scripts that will allow you to run your own URL shortening service (<em>a la</em> TinyURL). You can make it private or public, you can pick custom keyword URLs, it comes with its own API. You will love it.</p>
\r
278 <p>There's a <a href="#Plugin" onclick="toggle(this);">WordPress plugin</a> available for YOURLS, making integration with your blog a snap: create short URLs and tweet them automagically as you publish blog posts.</p>
\r
280 <h3>YOURLS Features</h3>
\r
282 <li><tt>Private</tt> (your links only) or <tt>Public</tt> (everybody can create short links, fine for an intranet)</li>
\r
283 <li>Sequential or custom URL keyword</li>
\r
284 <li>Handy <tt>bookmarklets</tt> to easily shorten and share links</li>
\r
285 <li>Awesome <tt>stats</tt>: historical click reports, referrers tracking, visitors geo-location</li>
\r
286 <li>Neat <tt>Ajaxed</tt> interface</li>
\r
287 <li>Terrific <tt>Plugin</tt> architecture to easily implement new features</li>
\r
288 <li>Cool developer <tt>API</tt></li>
\r
289 <li>Full <tt>jsonp</tt> support</li>
\r
290 <li>Friendly <tt>installer</tt></li>
\r
291 <li><tt>Sample files</tt> to create your own public interface and more</li>
\r
294 <h3>Screenshots</h3>
\r
296 <div class="sshot">
\r
297 <p>Main admin dashboard</p>
\r
298 <img src="http://yourls.org/yourls-org-images/admin-dashboard.gif" />
\r
300 <p>Stats for each short URL</p>
\r
301 <img src="http://yourls.org/yourls-org-images/stats-anim.gif" />
\r
303 <p>See a live example of YOURLS stats on <a href="http://yourls.org/cookie+">http://yourls.org/cookie+</a></p>
\r
308 <p><a href="http://yourls.org/download">Download YOURLS</a> from Google Code</p>
\r
309 <p>You can follow YOURLS' development on the <a href="http://yourls.org/revisions">revision list</a> and get current snapshot <a href="http://yourls.org/svnco">using SVN</a></p>
\r
313 <p>YOURLS is made by:</p>
\r
315 <li><a href="http://yourls.org/lesterchan" title="Visit Lester Chan's site">Lester Chan</a> – <a href="http://twitter.com/gamerz">@GamerZ</a> on Twitter (initial idea)</li>
\r
316 <li><a href="http://yourls.org/ozh" title"Visit Ozh's site">Ozh Richard</a> – <a href="http://twitter.com/ozh">@Ozh</a> on Twitter (development)</li>
\r
318 <p>Keep up to date: follow <a href="http://twitter.com/ozh">Ozh</a> and read the official <a href="http://blog.yourls.org/">YOURLS Blog</a></p>
\r
321 <!-- Installation Instructions -->
\r
322 <div id="InstallDiv" style="display: none;">
\r
323 <h2 class='first'>Fresh Install</h2>
\r
325 <li>Unzip the YOURLS archive</li>
\r
326 <li>Copy <code>user/config-sample.php</code> to <code>user/config.php</code></li>
\r
327 <li>Open <code>user/config.php</code> with a raw text editor (like Notepad) and fill in the required settings</li>
\r
328 <li>Upload the unzipped files to your domain <code>public_html</code> or <code>www</code> folder</li>
\r
329 <li>Create a new database (see <a href="#Config" onclick="toggle(this);">Configuration</a> – you can also use an existing one)</li>
\r
330 <li>Point your browser to <code>http://yoursite.com/admin/</code></li>
\r
335 <li><strong>Backup the database!</strong></li>
\r
336 <li>Unzip the YOURLS archive</li>
\r
337 <li>Upload files to your server, overwriting your existing install</li>
\r
338 <li>Point your browser to <code>http://yoursite.com/admin/</code></li>
\r
339 <li>Tip: you can now move your <code>config.php</code> file to the <code>/user</code> directory</li>
\r
342 <h2>Upgrade from YOURLS 1.3 or earlier</h2>
\r
344 <li><strong>Backup the database!</strong></li>
\r
345 <li>Make a copy of your <code>config.php</code></li>
\r
346 <li>Delete all files including <code>.htaccess</code> in YOURLS root directory</li>
\r
347 <li>Unzip the YOURLS archive, upload the files</li>
\r
348 <li>Copy <code>config-sample.php</code> to <code>config.php</code> and fill in details. <strong>Don't start with your old config file</strong>, use the new sample config file.</li>
\r
349 <li>In your new <code>config.php</code>, add the <em>defines</em> for <code>YOURLS_DB_TABLE_URL</code> and <code>YOURLS_DB_TABLE_NEXTDEC</code> you had in your previous config file
\r
350 <li>Point your browser to <code>http://yoursite.com/admin/</code> and follow instructions</li>
\r
351 <li>After upgrade is well and over, remove the define <code>YOURLS_DB_TABLE_NEXTDEC</code> from your config file</li>
\r
356 <!-- Configuration Instructions -->
\r
357 <div id="ConfigDiv" style="display: none;">
\r
358 <h2 class='first'>Configuration (in <code>user/config.php</code>)</h2>
\r
359 <h3>MySQL settings</h3>
\r
361 <li><code>YOURLS_DB_USER</code><br/>
\r
362 your MySQL username<br/>
\r
363 <em>Example:</em> <tt>'joe'</tt></li>
\r
364 <li><code>YOURLS_DB_PASS</code><br/>
\r
365 your MySQL password<br/>
\r
366 <em>Example:</em> <tt>'MySeCreTPaSsW0rd'</tt></li>
\r
367 <li><code>YOURLS_DB_NAME</code>:
\r
368 The database name<br/>
\r
369 <em>Example:</em> <tt>'yourls'</tt></li>
\r
370 <li><code>YOURLS_DB_HOST</code><br/>
\r
371 The database host<br/>
\r
372 <em>Example:</em> <tt>'localhost'</tt></li>
\r
373 <li><code>YOURLS_DB_PREFIX</code><br/>
\r
374 The name prefix for all the tables YOURLS will need<br/>
\r
375 <em>Example:</em> <tt>'yourls_'</tt></li>
\r
378 <h3>Site options</h3>
\r
380 <li><code>YOURLS_SITE</code><br/>
\r
381 Your (short) domain URL, no trailing slash, lowercase. If you pick the non-www version of your domain, don't use the www version in your browser (and vice-versa)<br/>
\r
382 <em>Example:</em> <tt>'http://ozh.in'</tt></li>
\r
383 <li><code>YOURLS_HOURS_OFFSET</code><br/>
\r
384 Timezone GMT offset<br/>
\r
385 <em>Example:</em> <tt>'-5'</tt></li>
\r
386 <li><code>YOURLS_PRIVATE</code><br/>
\r
387 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/>
\r
388 <em>Example:</em> <tt>'true'</tt></li>
\r
389 <li><code>YOURLS_UNIQUE_URLS</code><br/>
\r
390 Allow multiple short URLs for a same long URL<br/>
\r
391 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/>
\r
392 <em>Example:</em> <tt>'true'</tt></li>
\r
393 <li><code>YOURLS_COOKIEKEY</code><br/>
\r
394 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/>
\r
395 <em>Example:</em> <tt>'qQ4KhL_pu|s@Zm7n#%:b^{A[vhm'</tt></li>
\r
396 <li><code>yourls_user_passwords</code><br/>
\r
397 A list of username(s) and password(s) allowed to access the site if private<br/>
\r
398 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/>
\r
399 <em>Example:</em> <tt>'joe' => 'mypassword'</tt></li>
\r
402 <h3>URL Shortening settings</h3>
\r
404 <li><code>YOURLS_URL_CONVERT</code><br/>
\r
405 URL shortening method: base <tt>36</tt> or <tt>62</tt>. See <a onclick="toggle(this);" href="#FAQ">FAQ</a> for more explanations</li>
\r
406 <li><code>yourls_reserved_URL</code><br/>
\r
407 A list of reserved keywords that won't be used as short URLs. Define here negative, unwanted or potentially misleading keywords<br/>
\r
408 <em>Example:</em> <tt>'porn', 'faggot', 'sex', 'nigger', 'fuck', 'cunt', 'dick', 'gay'</tt></li>
\r
411 <h3>Optional settings</h3>
\r
413 <li><code>YOURLS_PRIVATE_INFOS</code><br/>
\r
414 If <code>YOURLS_PRIVATE</code> is set to <tt>true</tt>, you can still make stat pages public. To do so, define with:<br/>
\r
415 <tt>define('YOURLS_PRIVATE_INFOS', false);</tt>
\r
417 <li><code>YOURLS_PRIVATE_API</code><br/>
\r
418 If <code>YOURLS_PRIVATE</code> is set to <tt>true</tt>, you can still make your API public. To do so, define with:<br/>
\r
419 <tt>define('YOURLS_PRIVATE_API', false);</tt>
\r
420 <li><code>YOURLS_NOSTATS</code><br/>
\r
421 If <code>YOURLS_NOSTATS</code> is set to <tt>true</tt>, redirects won't be logged and there will be not stats available.<br/>
\r
425 <h3>Advanced settings</h3>
\r
426 <p>File <code>includes/yourls-load.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</p>
\r
429 <!-- WordPress plugin -->
\r
430 <div id="PluginDiv" style="display:none">
\r
431 <h2 class='first'>WordPress Plugin</h2>
\r
435 <li>Generate short URLs for each new post or page</li>
\r
436 <li>Generate short URLs for all your old posts and pages if wished</li>
\r
437 <li>Send a tweet on your Twitter account with the post title and short URL as you publish them</li>
\r
438 <li>Works if YOURLS is hosted on the same server or on a remote server</li>
\r
441 <h3>Download & more informations</h3>
\r
443 <li>Download <a href="http://yourls.org/plugin">YOURLS: WordPress to Twitter</a> from the official WordPress plugin repository</li>
\r
444 <li>More information, tips and feedback on <a href="http://yourls.org/plugindoc">the plugin page</a> from planetOzh</li>
\r
449 <!-- YOURLS plugins -->
\r
450 <div id="PluginsDiv" style="display:none">
\r
451 <h2 class='first'>Plugins for YOURLS</h2>
\r
454 <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>
\r
455 <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>
\r
456 <p>There's a growing number of plugins available: check the <a href="http://yourls.org/pluginlist">Plugin list</a>.</p>
\r
458 <h3>Documentation</h3>
\r
459 <p>Several sample plugins are included in the archive. Read the source and learn the concept. It's easy and fun!</p>
\r
460 <p>Check the <a href="http://yourls.org/pluginapi">plugin API documentation</a> to learn more</p>
\r
465 <div id="APIDiv" style="display:none">
\r
466 <h2 class='first'>YOURLS' API</h2>
\r
470 <li>Generate or get existing short URLs, with sequential or custom keyword</li>
\r
471 <li>Get some statistics about your links: top clicked links, least clicked links, newest links</li>
\r
472 <li>Output format: JSON, XML, or simple raw text</li>
\r
473 <li>Authentify either with login/password or using a secure passwordless mechanism</li>
\r
477 <p>You need to send parameters to <code>http://yoursite.com/yourls-api.php</code> either via <code>GET</code> or <code>POST</code> (remember to URL encode parameters if via GET). These parameters are:</p>
\r
479 <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>
\r
480 <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>
\r
481 <li>With <tt>action = "shorturl"</tt> :
\r
483 <li>the <code>url</code> to shorten</li>
\r
484 <li>optional <code>keyword</code> for custom short URLs</li>
\r
485 <li>output <code>format</code>: either <tt>"json"</tt>, <tt>"xml"</tt> or <tt>"simple"</tt></li>
\r
488 <li>With <tt>action = "expand"</tt> :
\r
490 <li>the <code>shorturl</code> to expand (can be either 'abc' or 'http://site/abc')</li>
\r
491 <li>output <code>format</code>: either <tt>"json"</tt>, <tt>"xml"</tt> or <tt>"simple"</tt></li>
\r
494 <li>With <tt>action = "url-stats"</tt> :
\r
496 <li>the <code>shorturl</code> for which to get stats (can be either 'abc' or 'http://site/abc')</li>
\r
497 <li>output <code>format</code>: either <tt>"json"</tt> or <tt>"xml"</tt></li>
\r
500 <li>With <tt>action = "stats"</tt> :
\r
502 <li>the <code>filter</code>: either <tt>"top"</tt>, <tt>"bottom"</tt> , <tt>"rand"</tt> or <tt>"last"</tt></li>
\r
503 <li>the <code>limit</code> (maximum number of links to return)</li>
\r
504 <li>output <code>format</code>: either <tt>"json"</tt> or <tt>"xml"</tt></li>
\r
507 <li>With <tt>action = "db-stats"</tt> :
\r
509 <li>output <code>format</code>: either <tt>"json"</tt> or <tt>"xml"</tt></li>
\r
514 <h3>Sample return</h3>
\r
515 <pre><tt><result>
\r
517 <keyword>shorter</keyword>
\r
518 <url>http://somereallylongurlyouneedtoshrink.com/</url>
\r
519 <title>The Page Title</title>
\r
520 <date>2009-06-23 18:08:07</date>
\r
521 <ip>127.0.0.1</ip>
\r
523 <status>success</status>
\r
524 <message>http://somereallylongurlyouneedtoshrink.com/ (ID: shorter) added to database</message>
\r
525 <title>The Page Title</title>
\r
526 <shorturl>http://yoursite.com/shorter</shorturl>
\r
527 <statusCode>200</statusCode>
\r
528 </result></tt></pre>
\r
530 <h3>Sample file</h3>
\r
531 <p>There's a sample file included that serves as an example on how to play with the API</p>
\r
536 <!-- FAQ Instructions -->
\r
537 <div id="FAQDiv" style="display: none;">
\r
538 <h2 class='first'>FAQ</h2>
\r
540 <h3>Server requirements</h3>
\r
542 <li>A server with <strong>mod_rewrite</strong> enabled</li>
\r
543 <li>At least <strong>PHP 4.3</strong></li>
\r
544 <li>At least <strong>MYSQL 4.1</strong></li>
\r
545 <li><em>Note</em>: YOURLS can also run on <a href="http://www.packetcollision.com/2012/01/27/yourls-and-nginx-an-updated-config/">Nginx</a> and <a href="http://www.ututech.com/2010/10/configuring-yourls-to-work-with-cherokee-web-server/">Cherokee</a></li>
\r
548 <h3>Server recommendations</h3>
\r
550 <li>PHP <a href="http://www.php.net/curl">CURL extension</a> installed if you plan on playing with the API</li>
\r
553 <h3>Limitations</h3>
\r
555 <li>Maximum length of long URLs to be shortened is <strong>2000 characters</strong></li>
\r
556 <li>Maximum length of custom keyword is <strong>200 characters</strong></li>
\r
557 <li>That makes about <strong>8 sexdecillions of centillions</strong> of available URLs (<a href="http://en.wikipedia.org/wiki/Names_of_large_numbers">seriously</a>. That's a 355 digits number). </li>
\r
560 <h3>Difference Between Base 36 And Base 62 Encoding</h3>
\r
562 <li>Base 36 encoding uses <code>0123456789abcdefghijklmnopqrstuvwxyz</code> for short URLs</li>
\r
563 <li>Base 62 encoding uses <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz</code></li>
\r
564 <li>Stick to one setting, don't change after you've created links as it will change all your short URLs!</li>
\r
565 <li>Base 36 is the default and should be picked if you're not sure.</li>
\r
568 <h3>Getting a short domain name for your YOURLS install</h3>
\r
570 <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://www.dreamhost.com/r.cgi?114740">Dreamhost</a> and it works just great.</li>
\r
571 <li><a href="http://domai.nr/">Domainr</a> is a fun search tool that might inspire and help you</li>
\r
572 <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>
\r
575 <h3>YOURLS needs its own .htaccess</h3>
\r
577 <li>You cannot install YOURLS and, say, WordPress, in the same directory. Both need to handle URLs differently and need their own <tt>.htaccess</tt> file.</li>
\r
578 <li>If you want to install YOURLS on the same domain than your blog, give it its own (short) subdirectory, such as yourblog.com/s/ (for "short") or yourblog.com/x/ (for "exit")</li>
\r
581 <h3>If YOURLS generates 404 for your short URLs</h3>
\r
583 <li>Make sure <strong>mod_rewrite</strong> is enabled with your Apache server</li>
\r
584 <li>Make sure your .htaccess file looks like <a href="http://yourls.org/htaccess">this one</a></li>
\r
587 <h3>There is no index page at the root of the install</h3>
\r
589 <li>Indeed. It's intented. 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>
\r
590 <li>If you want to make a public interface, there's a sample file provided as an example.</li>
\r
593 <h3>Feedback, feature requests and bug reporting</h3>
\r
595 <li>Please don't get in touch directly by mail or Twitter. <a href="http://yourls.org/support">Please</a>.</li>
\r
596 <li>Check the <a href="http://yourls.org/roadmap">Road Map</a> for future features.</li>
\r
597 <li>Read all the <a href="http://yourls.org/wiki">wiki documents</a>.</li>
\r
598 <li>Search in the <a href="http://yourls.org/closedissues">closed issues</a>.</li>
\r
599 <li>Eventually raise an <a href="http://yourls.org/issues">issue here</a> and give all the details. Thanks!</li>
\r
606 <div id="MoreDiv" style="display: none;">
\r
608 <h2 class='first'>Community</h2>
\r
610 <p>YOURLS is open source, so the community of users plays a great role in its development, by contributing, helping others or giving feedback that helps improve the software.</p>
\r
614 <li>The official <a href="http://blog.yourls.org">YOURLS blog</a>, for news, hints and showcase.</li>
\r
615 <li>The <a href="http://yourls.org/wiki">wiki</a>: advanced documentation, plugins, tips and more</li>
\r
616 <li>Follow <a href="https://twitter.com/YOURLS">@YOURLS</a> to get the scoops on development, and <a href="https://twitter.com/ozh">@Ozh</a> for tips and news (and random geekiness too)</li>
\r
621 <h3>Here are a few examples of sites running YOURLS with a unique design or concept</h3>
\r
623 <li><a href="http://mrte.ch/">http://mrte.ch/</a><br/>
\r
624 Mr Tech's public YOURLS setup, listing top links and some stats</li>
\r
626 <li><a href="http://freze.it/">http://freze.it/</a></br/>
\r
627 Shortens and saves a screenshot of a long URL</li>
\r
629 <li><a href="http://xib.me/">http://xib.me/</a></br/>
\r
630 A nicely styled YOURLS public interface</li>
\r
632 <li><a href="http://girv.in/">http://girv.in/</a><br/>
\r
633 John Girvin's YOURLS setup with all links in a sortable display (and its <a href="https://github.com/johngirvin/yourls-index-page">source</a>)</li>
\r
635 <li><a href="http://rml.me/">http://rml.me/</a><br/>
\r
636 A personal URL shortener front page showing new links and most clicked links</li>
\r
638 <li><a href="http://vt802.us/">http://vt802.us/</a><br/>
\r
639 Defined as "The World's First Vermont-centric URL Shortener"</li>
\r
641 <li><a href="http://yourwish.es/">http://yourwish.es/</a><br/>
\r
642 Easily share an Amazon wishlist</li>
\r
644 <li><a href="http://vbly.us">http://vbly.us</a><br/>
\r
645 Public YOURLS setup and early adopter, run by famous sex writer Violet Blue as "the internet's first and only sex-positive url shortener", once taken down by Libya (<a href="http://www.readwriteweb.com/archives/libya_shuts_down_vbly_bitly_owly_next.php">story</a>)</li>
\r
648 <h2>YOURLS and other platforms or frameworks</h2>
\r
650 <li><a href="http://github.com/pjain/WWW-Shorten-Yourls">Perl</a><br/>
\r
651 WWW-Shorten-Yourls is a Perl module to shorten URLs using YOURLS</li>
\r
653 <li><a href="https://github.com/threestage/yourls">Ruby</a><br/>
\r
654 A Ruby wrapper for the YOURLS API</li>
\r
656 <li><a href="http://tflink.github.com/python-yourls/">Python</a><br/>
\r
657 A Python client for YOURLS</li>
\r
659 <li><a href="http://neocotic.com/yourls-api/">Javascript</a><br/>
\r
660 JavaScript bindings for the YOURLS API to leverage JSONP support</li>
\r
662 <li><a href="https://github.com/driflash/CakePHP-YOURLS-Plugin">CakePHP</a><br/>
\r
663 Plugin which integrates CakePHP with Yourls</li>
\r
665 <li><a href="http://drupal.org/project/yourls">Drupal</a><br/>
\r
666 Allows for the automatic creation of short urls using a YOURLS installation</li>
\r
668 <li><a href="https://github.com/rthees/yourls-status-net">status.net</a><br/>
\r
669 A plugin for status.net to use YOURLS</li>
\r
671 <li><a href="http://developer.sharetronix.com/mpview/12/tag:yourls">Sharetronix</a><br/>
\r
672 A YOURLS addon for Sharetronix</li>
\r
676 <h2>YOURLS works with your favorite sofware or device</h2>
\r
678 <li><a href="http://www.eugenegordin.com/etc/how-to-use-your-custom-yourls-shortener-with-tweetie-2.html">Tweetie 2</a><br/>
\r
679 How to set up Tweetie2 so it uses your own service</li>
\r
681 <li><a href="http://remkusdevries.com/how-to-setup-tweetdeck-with-yourls/">TweetDeck</a><br/>
\r
682 Set up TweetDeck to run with YOURLS</li>
\r
684 <li><a href="http://2fatdads.com/2012/02/how-to-make-yourls-org-work-in-tweetbot/">Tweetbot</a><br/>
\r
685 Make Tweetbot run with YOURLS</li>
\r
687 <li><a href="http://christophe.rousee.fr/plugin-yourls-pour-seesmic-desktop-2">Seesmic</a><br/>
\r
688 Use YOURLS with Seesmic</li>
\r
690 <li><a href="http://blog.yourls.org/2011/09/how-to-use-twitterfeed-with-your-custom-yourls-url-shortener/">Twitterfeed</a><br/>
\r
691 Use Twitterfeed with YOURLS</li>
\r
693 <li><a href="http://timi.im/app/">Mac Client</a><br/>
\r
694 Simple app to have a global keyboard shortcut send a link to YOURLS</li>
\r
696 <li><a href="https://play.google.com/store/apps/details?id=com.mndroid.apps.urly">Android</a><br/>
\r
697 URLy is an Android app that plays nice with YOURLS</li>
\r
699 <li><a href="http://itunes.apple.com/us/app/clicklytics-track-clicks-on/id444008024?mt=8">iOS</a><br/>
\r
700 Clicklytics track links using YOURLS on iPhone and iPad</li>
\r
702 <li><a href="https://github.com/ukoms/Chrourls">Chrourls</a><br/>
\r
703 Google Chrome quick link shortening addon for YOURLS</li>
\r
705 <li><a href="https://addons.mozilla.org/en-us/firefox/addon/yourls-shortener/">Firefox Addon</a><br/>
\r
706 Firefox Addon for YOURLS</li>
\r
708 <li><a href="http://www.chrismarquardt.com/blog.php?id=7952283233607249761">Textexpander and YOURLS</a><br/>
\r
709 Making YOURLS and Textexpander on the Mac play together</li>
\r
712 <h2>More stuff to do with YOURLS</h2>
\r
715 <li><a href="https://github.com/tomslominski/infinity-squared">Infinity Squared</a><br/>
\r
716 ∞² is a public page theme for YOURLS to help you design your own public interface</li>
\r
718 <li><a href="https://github.com/johngirvin/yourls-index-page">John Girvin's page</a><br/>
\r
719 The source of http://girv.in/ home page</li>
\r
721 <li><a href="https://github.com/ctrloptcmd/xs.ht">xs.ht</a><br/>
\r
722 An example front end page for YOURLS</li>
\r
724 <li><a href="http://screenr.com/nTs">http://screenr.com/nTs</a><br/>
\r
725 A screencast explaining how to setup YOURLS</li>
\r
727 <li><a href="http://v007.me/836">YOURLS: Short URL Widget</a><br/>
\r
728 Creates a fully configurable widget that outputs the short URL to the current post or page</li>
\r
730 <li><a href="http://foolrulez.org/blog/2009/09/yourls-widget-released">YOURLS Widget for WordPress</a><br/>
\r
731 This widget adds a convenient short URL service into your sidebar. Check the above link for a live example</li>
\r
733 <li><a href="http://www.stewartallen.org/2010/08/yourls-twitter-tools-wordpress-plugin/">Twitter Tools & YOURLS</a><br/>
\r
734 Companion plugin for Alex King's Twitter Tool for WordPress, that enables YOURLS support</li>
\r
736 <li><a href="http://code.google.com/p/yourls/issues/detail?id=137">Export URLS as text list</a><br/>
\r
737 A simple script to list all URLs, one per line, in plain text (for using as an indexer config file, for example)</li>
\r
739 <li>YOURLS featured on <a href="http://lifehacker.com/5335216/make-your-own-url-shortening-service">Lifehacker</a></li>
\r
742 <h2>"Celebrity endorsements", sort of.</h2>
\r
745 <li><a href="http://ithem.es/">http://ithem.es/</a> by <a href="http://www.ithemes.com/">iThemes</a></li>
\r
747 <li><a href="http://virg.in/">http://virg.in/</a> for the <a href="http://www.virgin.com/">Virgin Group companies</a></li>
\r
749 <li><a href="http://dhurl.org/">http://dhurl.org/</a> by <a href="http://www.dreamhost.com/">Dreamhost</a></li>
\r
755 </div> <!-- content -->
\r
756 </div> <!-- container -->
\r
758 <div id="fade"></div>
\r
760 <script type="text/javascript">
\r
762 // Dynamically get tabs
\r
763 function getTabs() {
\r
764 var d = document.getElementById('Tabs');
\r
765 var matches = d.innerHTML.match(/<li id="(.+?)Tab"/g);
\r
767 for (i in matches) {
\r
768 tabs[i]= matches[i].replace('<li id="','').replace('Tab"', '');
\r
770 tabs = tabs.reverse();
\r
773 // Toggle tab display
\r
774 function toggle(el) {
\r
775 //var tabs = ["About", "Install", "Config", "Plugin", "FAQ"];
\r
776 var target = el.toString().replace(/^.*#/, '');
\r
777 for (var tab in tabs) {
\r
779 document.getElementById(tabs[tab]+'Tab').className = 'Tab';
\r
781 document.getElementById(tabs[tab]+'Div').style.display= 'none';
\r
783 // highlight & display target
\r
784 document.getElementById(target+'Div').style.display = 'block';
\r
785 document.getElementById(target+'Tab').className = 'SelectedTab';
\r
787 try { el.blur(); } catch(err) {}
\r
790 var tabs = getTabs();
\r
791 // On page load/refresh display required tab
\r
792 if (location.hash) {
\r
793 toggle(location.hash);
\r
795 // Background fancyness
\r
797 var rndbg = [ 'bg_ants.png', 'bg_circles.png', 'bg_cross.png', 'bg_diag.png', 'bg_fuzzy.png', 'bg_fuzzy_bits.png', 'bg_yourls.png', 'bg_fuzzy_bits.png', 'bg_life.png', 'bg_boobs.png' ];
\r
798 var bg = rndbg[ Math.floor( Math.random() * rndbg.length ) ];
\r
799 document.body.style.background='#E3F3FF url(user/plugins/random-bg/img/'+bg+')';
\r
projects / Github / YOURLS.git / blob