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="IE-9"/>
\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
33 margin: 10px 20px 0px 20px;
\r
35 border: 1px solid #8d8d8d;
\r
36 background-color: #f5f5f5;
\r
44 a, a:active, a:link, a:visited {
\r
46 text-decoration: none;
\r
50 text-decoration: underline;
\r
60 border:1px solid #2A85B3;
\r
65 position:absolute; background: #E3F3FF; width:100%; height:230px; top:0px; left:0px; z-index:-1;
\r
66 background: -webkit-gradient(linear, left top, left bottom, from(rgba(227, 243, 255, 1)), to(rgba(227, 243, 255, 0)));
\r
67 background: -moz-linear-gradient(top, rgba(227, 243, 255, 1), rgba(227, 243, 255, 0.1)); /* for firefox 3.6+ */
\r
70 @keyframes mymove { 0% {top:130px;} 50% {top:150px;} 100% {top:130px;} }
\r
71 @-moz-keyframes mymove { 0% {top:130px;} 50% {top:135px;} 100% {top:130px;} }
\r
72 @-webkit-keyframes mymove { 0% {top:130px;} 50% {top:140px;} 100% {top:130px;} }
\r
73 @-o-keyframes mymove { 0% {top:130px;} 50% {top:135px;} 100% {top:130px;} }
\r
75 width:80px; margin-top:10px; float:right; position:absolute; margin-left: 810px;
\r
76 animation:mymove 0.5s ease 5s 7;
\r
77 -moz-animation:mymove 0.5s ease 5s 7;
\r
78 -webkit-animation:mymove 0.5s ease 5s 7;
\r
79 -o-animation:mymove 0.5s ease 5s 7;
\r
81 #fb,#g1,#tw{ float:left; margin:0 5px; width: 60px; height:63px; text-align: center; margin-bottom: 10px; padding:7px 2px; border:2px solid #2A85B3; background: #E3F3FF; border-radius:10px;}
\r
82 #fb span {width:50px !important}
\r
83 /* Place Holder Style */
\r
91 background: none repeat scroll 0 0 white;
\r
92 border: 3px solid #2A85B3;
\r
93 -moz-border-radius:20px;
\r
94 -webkit-border-radius:20px;
\r
95 border-radius: 20px;
\r
98 padding: 5px 20px 10px;
\r
106 font-family: 'Magra', Verdana, Arial;
\r
111 margin-bottom: 0px;
\r
112 background:transparent url(http://yourls.org/images/yourls-logo.png) left 5px no-repeat;
\r
115 padding-left:220px;
\r
118 h1 a:hover{text-decoration:none}
\r
121 text-decoration:underline;
\r
124 font-family: 'Magra', Verdana, Arial;
\r
130 h2.first{margin-top:10px}
\r
136 font-family: 'Magra', Verdana, Arial;
\r
148 font-family: Verdana, Arial;
\r
151 list-style-type: none;
\r
152 padding-bottom: 28px;
\r
153 border-bottom: 1px solid #2A85B3;
\r
154 margin:0 30px 12px 30px;
\r
160 background-color: #deedfb;
\r
161 margin: 3px 0px 0px 5px;
\r
162 border: 2px solid #2A85B3;
\r
163 -webkit-border-top-left-radius: 10px;
\r
164 -webkit-border-top-right-radius: 10px;
\r
165 -moz-border-radius-topleft: 10px;
\r
166 -moz-border-radius-topright: 10px;
\r
167 border-top-left-radius: 10px;
\r
168 border-top-right-radius: 10px;
\r
174 text-decoration: none;
\r
177 #Tabs li.Tab a:hover {
\r
178 background-color: #bfe0fe;
\r
179 -webkit-border-top-left-radius: 10px;
\r
180 -webkit-border-top-right-radius: 10px;
\r
181 -moz-border-radius-topleft: 10px;
\r
182 -moz-border-radius-topright: 10px;
\r
183 border-top-left-radius: 10px;
\r
184 border-top-right-radius: 10px;
\r
187 #Tabs li.SelectedTab {
\r
190 background-color: #fff;
\r
191 margin: 0px 0px 0px 5px;
\r
192 border-top: 2px solid #2A85B3;
\r
193 border-right: 2px solid #2A85B3;
\r
194 border-left: 2px solid #2A85B3;
\r
195 border-bottom: 6px solid #fff;
\r
196 -webkit-border-top-left-radius: 10px;
\r
197 -webkit-border-top-right-radius: 10px;
\r
198 -moz-border-radius-topleft: 10px;
\r
199 -moz-border-radius-topright: 10px;
\r
200 border-top-left-radius: 10px;
\r
201 border-top-right-radius: 10px;
\r
203 #Tabs li.SelectedTab a {
\r
207 text-decoration: none;
\r
221 border:1px solid #2A85B3;
\r
222 -webkit-border-radius: 10px;
\r
223 -webkit-border-bottom-right-radius: 25px;
\r
224 -webkit-border-bottom-left-radius: 25px;
\r
225 -moz-border-radius: 10px;
\r
226 -moz-border-radius-bottomright: 30px;
\r
227 -moz-border-radius-bottomleft: 30px;
\r
228 border-radius: 10px;
\r
229 border-bottom-right-radius: 30px;
\r
230 border-bottom-left-radius: 30px;
\r
233 background:#fff url(http://yourls.org/images/favicon.gif) 2px center no-repeat;
\r
237 <!--[if IE]> <style>#fade{display:none}</style> <![endif]-->
\r
240 <div id="fb-root"></div>
\r
241 <div id="Container">
\r
244 <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
248 <li id="MoreTab" class="Tab"><a href="#More" onclick="toggle(this);">More</a></li>
\r
249 <li id="FAQTab" class="Tab"><a href="#FAQ" onclick="toggle(this);">FAQ</a></li>
\r
250 <li id="APITab" class="Tab"><a href="#API" onclick="toggle(this);">API</a></li>
\r
251 <li id="PluginsTab" class="Tab"><a href="#Plugins" onclick="toggle(this);">YOURLS plugins</a></li>
\r
252 <li id="ConfigTab" class="Tab"><a href="#Config" onclick="toggle(this);">Config</a></li>
\r
253 <li id="InstallTab" class="Tab"><a href="#Install" onclick="toggle(this);">Install/Upgrade</a></li>
\r
254 <li id="AboutTab" class="SelectedTab"><a href="#About" onclick="toggle(this);">About</a></li>
\r
262 <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
264 <script>(function(d, s, id) {
\r
265 var js, fjs = d.getElementsByTagName(s)[0];
\r
266 if (d.getElementById(id)) return;
\r
267 js = d.createElement(s); js.id = id;
\r
268 js.src = "https://connect.facebook.net/en_US/all.js#xfbml=1&appId=125474947598196";
\r
269 fjs.parentNode.insertBefore(js, fjs);
\r
270 }(document, 'script', 'facebook-jssdk'));</script>
\r
273 <div class="g-plusone" data-size="tall" data-href="http://yourls.org/"></div>
\r
274 <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
277 <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
278 <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
283 <div id="AboutDiv">
\r
284 <h2 class='first'>About YOURLS</h2>
\r
286 <h3 id="what">What is YOURLS</h3>
\r
287 <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>
\r
289 <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>
\r
291 <h3 id="features">YOURLS Features</h3>
\r
293 <li><tt>Free</tt> and <tt>Open Source</tt> software.</li>
\r
294 <li><tt>Private</tt> (your links only) or <tt>Public</tt> (everybody can create short links, fine for an intranet)</li>
\r
295 <li>Sequential or custom URL keyword</li>
\r
296 <li>Handy <tt>bookmarklets</tt> to easily shorten and share links</li>
\r
297 <li>Awesome <tt>stats</tt>: historical click reports, referrers tracking, visitors geo-location</li>
\r
298 <li>Neat <tt>Ajaxed</tt> interface</li>
\r
299 <li>Terrific <tt>Plugin</tt> architecture to easily implement new features</li>
\r
300 <li>Cool developer <tt>API</tt></li>
\r
301 <li>Full <tt>jsonp</tt> support</li>
\r
302 <li>Friendly <tt>installer</tt></li>
\r
303 <li><tt>Sample files</tt> to create your own public interface and more</li>
\r
306 <h3 id="screenshots">Screenshots</h3>
\r
308 <div class="sshot">
\r
309 <p>Main admin dashboard</p>
\r
310 <img src="http://yourls.org/yourls-org-images/admin-dashboard.gif" />
\r
312 <p>Stats for each short URL</p>
\r
313 <img src="http://yourls.org/yourls-org-images/stats-anim.gif" />
\r
315 <p>See a live example of YOURLS stats on <a href="http://yourls.org/cookie+">http://yourls.org/cookie+</a></p>
\r
318 <h2 id="download">Download</h2>
\r
320 <p><a href="http://yourls.org/download">Download YOURLS</a> from Google Code</p>
\r
321 <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
323 <h2 id="credits">Credits</h2>
\r
325 <p>YOURLS is made by:</p>
\r
327 <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
328 <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
330 <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
333 <!-- Installation Instructions -->
\r
334 <div id="InstallDiv" style="display: none;">
\r
335 <h2 class='first' id="fresh">Fresh Install</h2>
\r
337 <li>Unzip the YOURLS archive</li>
\r
338 <li>Copy <code>user/config-sample.php</code> to <code>user/config.php</code></li>
\r
339 <li>Open <code>user/config.php</code> with a raw text editor (like Notepad) and fill in the required settings</li>
\r
340 <li>Upload the unzipped files to your domain <code>public_html</code> or <code>www</code> folder</li>
\r
341 <li>Create a new database (see <a href="#Config" onclick="toggle(this);">Configuration</a> – you can also use an existing one)</li>
\r
342 <li>Point your browser to <code>http://yoursite.com/admin/</code></li>
\r
345 <h2 id="upgrade">Upgrade</h2>
\r
347 <li><strong>Backup the database!</strong></li>
\r
348 <li>Unzip the YOURLS archive</li>
\r
349 <li>Upload files to your server, overwriting your existing install</li>
\r
350 <li>Point your browser to <code>http://yoursite.com/admin/</code></li>
\r
351 <li>Tip: you can now move your <code>config.php</code> file to the <code>/user</code> directory</li>
\r
354 <h2 id="upgrade13">Upgrade from YOURLS 1.3 or earlier</h2>
\r
356 <li><strong>Backup the database!</strong></li>
\r
357 <li>Make a copy of your <code>config.php</code></li>
\r
358 <li>Delete all files including <code>.htaccess</code> in YOURLS root directory</li>
\r
359 <li>Unzip the YOURLS archive, upload the files</li>
\r
360 <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
361 <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
362 <li>Point your browser to <code>http://yoursite.com/admin/</code> and follow instructions</li>
\r
363 <li>After upgrade is well and over, remove the define <code>YOURLS_DB_TABLE_NEXTDEC</code> from your config file</li>
\r
368 <!-- Configuration Instructions -->
\r
369 <div id="ConfigDiv" style="display: none;">
\r
370 <h2 class='first'>Configuration (in <code>user/config.php</code>)</h2>
\r
371 <h3 id="mysql">MySQL settings</h3>
\r
373 <li><code>YOURLS_DB_USER</code><br/>
\r
374 your MySQL username<br/>
\r
375 <em>Example:</em> <tt>'joe'</tt></li>
\r
376 <li><code>YOURLS_DB_PASS</code><br/>
\r
377 your MySQL password<br/>
\r
378 <em>Example:</em> <tt>'MySeCreTPaSsW0rd'</tt></li>
\r
379 <li><code>YOURLS_DB_NAME</code>:
\r
380 The database name<br/>
\r
381 <em>Example:</em> <tt>'yourls'</tt></li>
\r
382 <li><code>YOURLS_DB_HOST</code><br/>
\r
383 The database host<br/>
\r
384 <em>Example:</em> <tt>'localhost'</tt></li>
\r
385 <li><code>YOURLS_DB_PREFIX</code><br/>
\r
386 The name prefix for all the tables YOURLS will need<br/>
\r
387 <em>Example:</em> <tt>'yourls_'</tt></li>
\r
390 <h3 id="site">Site options</h3>
\r
392 <li><code>YOURLS_SITE</code><br/>
\r
393 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
394 <em>Example:</em> <tt>'http://ozh.in'</tt></li>
\r
395 <li><code>YOURLS_HOURS_OFFSET</code><br/>
\r
396 Timezone GMT offset<br/>
\r
397 <em>Example:</em> <tt>'-5'</tt></li>
\r
398 <li><code>YOURLS_PRIVATE</code><br/>
\r
399 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
400 <em>Example:</em> <tt>'true'</tt></li>
\r
401 <li><code>YOURLS_UNIQUE_URLS</code><br/>
\r
402 Allow multiple short URLs for a same long URL<br/>
\r
403 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
404 <em>Example:</em> <tt>'true'</tt></li>
\r
405 <li><code>YOURLS_COOKIEKEY</code><br/>
\r
406 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
407 <em>Example:</em> <tt>'qQ4KhL_pu|s@Zm7n#%:b^{A[vhm'</tt></li>
\r
408 <li><code>yourls_user_passwords</code><br/>
\r
409 A list of username(s) and password(s) allowed to access the site if private<br/>
\r
410 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
411 <em>Example:</em> <tt>'joe' => 'mypassword'</tt></li>
\r
414 <h3 id="urlsettings">URL Shortening settings</h3>
\r
416 <li><code>YOURLS_URL_CONVERT</code><br/>
\r
417 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
418 <li><code>yourls_reserved_URL</code><br/>
\r
419 A list of reserved keywords that won't be used as short URLs. Define here negative, unwanted or potentially misleading keywords<br/>
\r
420 <em>Example:</em> <tt>'porn', 'faggot', 'sex', 'nigger', 'fuck', 'cunt', 'dick', 'gay'</tt></li>
\r
423 <h3 id="optional">Optional settings</h3>
\r
425 <li><code>YOURLS_PRIVATE_INFOS</code><br/>
\r
426 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
427 <tt>define('YOURLS_PRIVATE_INFOS', false);</tt>
\r
429 <li><code>YOURLS_PRIVATE_API</code><br/>
\r
430 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
431 <tt>define('YOURLS_PRIVATE_API', false);</tt>
\r
432 <li><code>YOURLS_NOSTATS</code><br/>
\r
433 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
437 <h3 id="advanced">Advanced settings</h3>
\r
438 <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
441 <!-- YOURLS plugins -->
\r
442 <div id="PluginsDiv" style="display:none">
\r
443 <h2 class='first'>Plugins for YOURLS</h2>
\r
445 <h3 id="plugins">Plugins?</h3>
\r
446 <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
447 <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
448 <p>There's a growing number of plugins available: check the <a href="http://yourls.org/pluginlist">Plugin list</a>.</p>
\r
450 <h3 id="documentation">Documentation</h3>
\r
451 <p>Several sample plugins are included in the archive. Read the source and learn the concept. It's easy and fun!</p>
\r
452 <p>Check the <a href="http://yourls.org/pluginapi">plugin API documentation</a> to learn more</p>
\r
457 <div id="APIDiv" style="display:none">
\r
458 <h2 class='first'>YOURLS' API</h2>
\r
460 <h3 id="apifeatures">Features</h3>
\r
462 <li>Generate or get existing short URLs, with sequential or custom keyword</li>
\r
463 <li>Get some statistics about your links: top clicked links, least clicked links, newest links</li>
\r
464 <li>Output format: JSON, XML, or simple raw text</li>
\r
465 <li>Authentify either with login/password or using a secure passwordless mechanism</li>
\r
468 <h3 id="apiusage">Usage</h3>
\r
469 <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
471 <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
472 <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
473 <li>With <tt>action = "shorturl"</tt> :
\r
475 <li>the <code>url</code> to shorten</li>
\r
476 <li>optional <code>keyword</code> and <code>title</code> for custom short URLs</li>
\r
477 <li>output <code>format</code>: either <tt>"json"</tt>, <tt>"xml"</tt> or <tt>"simple"</tt></li>
\r
480 <li>With <tt>action = "expand"</tt> :
\r
482 <li>the <code>shorturl</code> to expand (can be either 'abc' or 'http://site/abc')</li>
\r
483 <li>output <code>format</code>: either <tt>"json"</tt>, <tt>"xml"</tt> or <tt>"simple"</tt></li>
\r
486 <li>With <tt>action = "url-stats"</tt> :
\r
488 <li>the <code>shorturl</code> for which to get stats (can be either 'abc' or 'http://site/abc')</li>
\r
489 <li>output <code>format</code>: either <tt>"json"</tt> or <tt>"xml"</tt></li>
\r
492 <li>With <tt>action = "stats"</tt> :
\r
494 <li>the <code>filter</code>: either <tt>"top"</tt>, <tt>"bottom"</tt> , <tt>"rand"</tt> or <tt>"last"</tt></li>
\r
495 <li>the <code>limit</code> (maximum number of links to return)</li>
\r
496 <li>output <code>format</code>: either <tt>"json"</tt> or <tt>"xml"</tt></li>
\r
499 <li>With <tt>action = "db-stats"</tt> :
\r
501 <li>output <code>format</code>: either <tt>"json"</tt> or <tt>"xml"</tt></li>
\r
506 <h3 id="apireturn">Sample return</h3>
\r
507 <pre><tt><result>
\r
509 <keyword>shorter</keyword>
\r
510 <url>http://somereallylongurlyouneedtoshrink.com/</url>
\r
511 <title>The Page Title</title>
\r
512 <date>2009-06-23 18:08:07</date>
\r
513 <ip>127.0.0.1</ip>
\r
515 <status>success</status>
\r
516 <message>http://somereallylongurlyouneedtoshrink.com/ (ID: shorter) added to database</message>
\r
517 <title>The Page Title</title>
\r
518 <shorturl>http://yoursite.com/shorter</shorturl>
\r
519 <statusCode>200</statusCode>
\r
520 </result></tt></pre>
\r
522 <h3 id="apisample">Sample file</h3>
\r
523 <p>There's a sample file included that serves as an example on how to play with the API</p>
\r
528 <!-- FAQ Instructions -->
\r
529 <div id="FAQDiv" style="display: none;">
\r
530 <h2 class='first'>FAQ</h2>
\r
532 <h3 id="requirement">Server requirements</h3>
\r
534 <li>A server with <strong>mod_rewrite</strong> enabled</li>
\r
535 <li>At least <strong>PHP 4.3</strong></li>
\r
536 <li>At least <strong>MYSQL 4.1</strong></li>
\r
537 <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
540 <h3 id="recommendation">Server recommendations</h3>
\r
542 <li>PHP <a href="http://www.php.net/curl">CURL extension</a> installed if you plan on playing with the API</li>
\r
545 <h3 id="limitations">Limitations</h3>
\r
547 <li>Maximum length of long URLs to be shortened is <strong>2000 characters</strong></li>
\r
548 <li>Maximum length of custom keyword is <strong>200 characters</strong></li>
\r
549 <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
552 <h3 id="base3662">Difference Between Base 36 And Base 62 Encoding</h3>
\r
554 <li>Base 36 encoding uses <code>0123456789abcdefghijklmnopqrstuvwxyz</code> for short URLs</li>
\r
555 <li>Base 62 encoding uses <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz</code></li>
\r
556 <li>Stick to one setting, don't change after you've created links as it will change all your short URLs!</li>
\r
557 <li>Base 36 is the default and should be picked if you're not sure.</li>
\r
560 <h3 id="shortdomain">Getting a short domain name for your YOURLS install</h3>
\r
562 <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>
\r
563 <li><a href="http://domai.nr/">Domainr</a> is a fun search tool that might inspire and help you</li>
\r
564 <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
567 <h3 id="htaccess">YOURLS needs its own .htaccess</h3>
\r
569 <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
570 <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
573 <h3 id="does404">If YOURLS generates 404 for your short URLs</h3>
\r
575 <li>Make sure <strong>mod_rewrite</strong> is enabled with your Apache server</li>
\r
576 <li>Make sure your .htaccess file looks like <a href="http://yourls.org/htaccess">this one</a></li>
\r
577 <li>Eventually, check your server Apache configuration allows use of .htaccess (<tt>AllowOverride All</tt> directive, ask your server admin)</li>
\r
580 <h3 id="noindex">There is no index page at the root of the install</h3>
\r
582 <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
583 <li>If you want to make a public interface, there's a sample file provided as an example. In such a case, please be aware that you will most likely attract gazillions of spammers with pharmacy links and the like. You are strongly advised to install anti-spam plugins.</li>
\r
586 <h3 id="lowercase">Uppercase letters in short URLs are eaten up, eg "<code>OmgOzh</code>" becomes "<code>mgzh</code>" !</h3>
\r
588 <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>
\r
589 <li>If you want to force lowercase, you'll need a <a href="http://yourls.org/pluginlist">plugin</a>.</li>
\r
592 <h3 id="feedback">Feedback, feature requests and bug reporting</h3>
\r
594 <li>Please don't get in touch directly by mail or Twitter. <a href="http://yourls.org/support">Please</a>.</li>
\r
595 <li>Check the <a href="http://yourls.org/roadmap">Road Map</a> for future features.</li>
\r
596 <li>Read all the <a href="http://yourls.org/wiki">wiki documents</a>.</li>
\r
597 <li>Search in the <a href="http://yourls.org/closedissues">closed issues</a>.</li>
\r
598 <li>Eventually raise an <a href="http://yourls.org/issues">issue here</a> and give all the details. Thanks!</li>
\r
605 <div id="MoreDiv" style="display: none;">
\r
607 <h2 class='first'>Community</h2>
\r
609 <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
611 <h3 id="ressources">Resources</h3>
\r
613 <li>The official <a href="http://blog.yourls.org">YOURLS blog</a>, for news, hints and showcase.</li>
\r
614 <li>The <a href="http://yourls.org/wiki">wiki</a>: advanced documentation, plugins, tips and more</li>
\r
615 <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>
\r
618 <h2 id="showcase">Showcase</h2>
\r
620 <h3>Here are a few examples of sites running YOURLS with a unique design or concept</h3>
\r
622 <li><a href="http://oe.cd/">http://oe.cd/</a><br/>
\r
623 OECD's internal URL shortener with a neat interface and private features</li>
\r
625 <li><a href="http://freze.it/">http://freze.it/</a></br/>
\r
626 Shortens and saves a screenshot of a long URL</li>
\r
628 <li><a href="http://xib.me/">http://xib.me/</a></br/>
\r
629 A nicely styled YOURLS public interface</li>
\r
631 <li><a href="http://girv.in/">http://girv.in/</a><br/>
\r
632 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
634 <li><a href="http://rml.me/">http://rml.me/</a><br/>
\r
635 A personal URL shortener front page showing new links and most clicked links</li>
\r
637 <li><a href="http://vt802.us/">http://vt802.us/</a><br/>
\r
638 Defined as "The World's First Vermont-centric URL Shortener"</li>
\r
640 <li><a href="http://yourwish.es/">http://yourwish.es/</a><br/>
\r
641 Easily share an Amazon wishlist</li>
\r
643 <li><a href="http://vbly.us">http://vbly.us</a><br/>
\r
644 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
647 <h2 id="frameworks">YOURLS and other platforms or frameworks</h2>
\r
649 <li id="wordpress"><a href="http://wordpress.org/extend/plugins/search.php?q=yourls">WordPress</a><br/>
\r
650 There are numerous WordPress plugin with YOURLS support. The <a href="http://wordpress.org/extend/plugins/yourls-wordpress-to-twitter/">official plugin</a> is no longer maintained. <a href="http://wordpress.org/extend/plugins/yourls-link-creator/">YOURLS Link Creator</a> is recommended.</li>
\r
652 <li id="drupal"><a href="http://drupal.org/project/yourls">Drupal</a><br/>
\r
653 Allows for the automatic creation of short urls using a YOURLS installation</li>
\r
655 <li id="perl"><a href="http://github.com/pjain/WWW-Shorten-Yourls">Perl</a><br/>
\r
656 WWW-Shorten-Yourls is a Perl module to shorten URLs using YOURLS</li>
\r
658 <li id="ruby"><a href="https://github.com/threestage/yourls">Ruby</a><br/>
\r
659 A Ruby wrapper for the YOURLS API</li>
\r
661 <li id="python"><a href="http://tflink.github.com/python-yourls/">Python</a><br/>
\r
662 A Python client for YOURLS</li>
\r
664 <li id="javascript"><a href="http://neocotic.com/yourls-api/">Javascript</a><br/>
\r
665 JavaScript bindings for the YOURLS API to leverage JSONP support</li>
\r
667 <li id="cake"><a href="https://github.com/driflash/CakePHP-YOURLS-Plugin">CakePHP</a><br/>
\r
668 Plugin which integrates CakePHP with Yourls</li>
\r
670 <li id="statusnet"><a href="https://github.com/rthees/yourls-status-net">status.net</a><br/>
\r
671 A plugin for status.net to use YOURLS</li>
\r
673 <li id="sharetronix"><a href="http://developer.sharetronix.com/mpview/12/tag:yourls">Sharetronix</a><br/>
\r
674 A YOURLS addon for Sharetronix</li>
\r
678 <h2>YOURLS works with your favorite sofware or device</h2>
\r
680 <li id="tweetie2"><a href="http://www.eugenegordin.com/etc/how-to-use-your-custom-yourls-shortener-with-tweetie-2.html">Tweetie 2</a><br/>
\r
681 How to set up Tweetie2 so it uses your own service</li>
\r
683 <li id="tweetdeck"><a href="http://remkusdevries.com/how-to-setup-tweetdeck-with-yourls/">TweetDeck</a><br/>
\r
684 Set up TweetDeck to run with YOURLS</li>
\r
686 <li id="tweetbot"><a href="http://2fatdads.com/2012/02/how-to-make-yourls-org-work-in-tweetbot/">Tweetbot</a><br/>
\r
687 Make Tweetbot run with YOURLS</li>
\r
689 <li id="seesmic"><a href="http://christophe.rousee.fr/plugin-yourls-pour-seesmic-desktop-2">Seesmic</a><br/>
\r
690 Use YOURLS with Seesmic</li>
\r
692 <li id="twitterfeed"><a href="http://blog.yourls.org/2011/09/how-to-use-twitterfeed-with-your-custom-yourls-url-shortener/">Twitterfeed</a><br/>
\r
693 Use Twitterfeed with YOURLS</li>
\r
695 <li id="mac"><a href="http://timi.im/app/">Mac Client</a><br/>
\r
696 Simple app to have a global keyboard shortcut send a link to YOURLS</li>
\r
698 <li id="android">Android: <a href="https://play.google.com/store/apps/details?id=com.mndroid.apps.urly">URLy</a> and <a href="https://play.google.com/store/apps/details?id=de.keineantwort.android.urlshortener">URL Shortener</a><br/>
\r
699 Android apps that plays nice with YOURLS</li>
\r
701 <li id="iphone"><a href="http://itunes.apple.com/us/app/clicklytics-track-clicks-on/id444008024?mt=8">iOS</a><br/>
\r
702 Clicklytics track links using YOURLS on iPhone and iPad</li>
\r
704 <li id="chrome"><a href="https://github.com/ukoms/Chrourls">Chrourls</a><br/>
\r
705 Google Chrome quick link shortening addon for YOURLS</li>
\r
707 <li id="firefox"><a href="https://addons.mozilla.org/en-us/firefox/addon/yourls-shortener/">Firefox Addon</a><br/>
\r
708 Firefox Addon for YOURLS</li>
\r
710 <li id="textexpander"><a href="http://www.chrismarquardt.com/blog.php?id=7952283233607249761">Textexpander and YOURLS</a><br/>
\r
711 Making YOURLS and Textexpander on the Mac play together</li>
\r
714 <h2 id="morestuff">More stuff to do with YOURLS</h2>
\r
717 <li><a href="https://github.com/tomslominski/infinity-squared">Infinity Squared</a><br/>
\r
718 ∞² is a public page theme for YOURLS to help you design your own public interface</li>
\r
720 <li><a href="https://github.com/johngirvin/yourls-index-page">John Girvin's page</a><br/>
\r
721 The source of http://girv.in/ home page</li>
\r
723 <li><a href="https://github.com/ctrloptcmd/xs.ht">xs.ht</a><br/>
\r
724 An example front end page for YOURLS</li>
\r
726 <li><a href="http://screenr.com/nTs">http://screenr.com/nTs</a><br/>
\r
727 A screencast explaining how to setup YOURLS</li>
\r
729 <li><a href="http://v007.me/836">YOURLS: Short URL Widget</a><br/>
\r
730 Creates a fully configurable widget that outputs the short URL to the current post or page</li>
\r
732 <li><a href="http://foolrulez.org/blog/2009/09/yourls-widget-released">YOURLS Widget for WordPress</a><br/>
\r
733 This widget adds a convenient short URL service into your sidebar. Check the above link for a live example</li>
\r
735 <li><a href="http://www.stewartallen.org/2010/08/yourls-twitter-tools-wordpress-plugin/">Twitter Tools & YOURLS</a><br/>
\r
736 Companion plugin for Alex King's Twitter Tool for WordPress, that enables YOURLS support</li>
\r
738 <li><a href="http://code.google.com/p/yourls/issues/detail?id=137">Export URLS as text list</a><br/>
\r
739 A simple script to list all URLs, one per line, in plain text (for using as an indexer config file, for example)</li>
\r
741 <li>YOURLS featured on <a href="http://lifehacker.com/5335216/make-your-own-url-shortening-service">Lifehacker</a></li>
\r
744 <h2>"Celebrity endorsements", sort of.</h2>
\r
747 <li><a href="http://ithem.es/">http://ithem.es/</a> by <a href="http://www.ithemes.com/">iThemes</a></li>
\r
749 <li><a href="http://virg.in/">http://virg.in/</a> for the <a href="http://www.virgin.com/">Virgin Group companies</a></li>
\r
751 <li><a href="http://dhurl.org/">http://dhurl.org/</a> by <a href="http://yourls.org/dreamhost">Dreamhost</a></li>
\r
757 </div> <!-- content -->
\r
758 </div> <!-- container -->
\r
760 <div id="fade"></div>
\r
762 <script type="text/javascript">
\r
764 // Dynamically get tabs
\r
765 function getTabs() {
\r
766 var d = document.getElementById('Tabs');
\r
767 var matches = d.innerHTML.match(/<li id="(.+?)Tab"/g);
\r
769 for (i in matches) {
\r
770 tabs[i]= matches[i].replace('<li id="','').replace('Tab"', '');
\r
772 tabs = tabs.reverse();
\r
775 // Scroll to ?anchor
\r
776 // window.location.hash
\r
778 // Toggle tab display
\r
779 function toggle(el) {
\r
780 var hashes = el.toString().replace(/^.*?#/, '').split('#');
\r
781 var target = hashes[0];
\r
782 var anchor = hashes[1];
\r
783 // If tab doesn't exist, exit
\r
784 if( tabs.indexOf( target ) == -1 )
\r
786 for (var tab in tabs) {
\r
788 document.getElementById(tabs[tab]+'Tab').className = 'Tab';
\r
790 document.getElementById(tabs[tab]+'Div').style.display= 'none';
\r
792 // highlight & display target
\r
793 document.getElementById(target+'Div').style.display = 'block';
\r
794 document.getElementById(target+'Tab').className = 'SelectedTab';
\r
796 try { el.blur(); } catch(err) {}
\r
797 // Try scrolling to anchor
\r
799 window.scroll(0,findPos(document.getElementById(anchor)));
\r
800 } catch(err) { window.location.hash = target; }
\r
803 var tabs = getTabs();
\r
804 // On page load/refresh display required tab
\r
805 if (location.hash) {
\r
806 toggle(location.hash);
\r
808 // Background fancyness
\r
810 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
811 var bg = rndbg[ Math.floor( Math.random() * rndbg.length ) ];
\r
812 document.body.style.background='#E3F3FF url(user/plugins/random-bg/img/'+bg+')';
\r
815 //Finds y value of given object
\r
816 function findPos(obj) {
\r
818 if (obj.offsetParent) {
\r
820 curtop += obj.offsetTop;
\r
821 } while (obj = obj.offsetParent);
\r
822 curtop = curtop - 30;
\r
projects / Github / YOURLS.git / blob