readme.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   3 <head>
   4         <meta http-equiv="X-UA-Compatible" content="IE-9"/>
   5         <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   6         <title>YOURLS: Your Own URL Shortener</title>
   7         <link href='https://fonts.googleapis.com/css?family=Fira+Sans:400,700' rel='stylesheet' type='text/css'>
   8         <style type="text/css" media="screen">
   9                 /* Default Style */
  10                 body {
  11                         font-family: Verdana, Arial, sans-serif;
  12                         font-size: 12px;
  13                         color: #595441;
  14                         background:#E3F3FF;
  15                         margin-top:0px;
  16                         margin-bottom:30px;
  17                 }
  18                 p {
  19                         padding-left: 10px;
  20                 }
  21                 code {
  22                         background:#eaeaef;
  23                         padding:0 2px;
  24                 }
  25                 tt {
  26                         background:#ffc;
  27                         padding:0 2px;
  28                 }
  29                 pre tt {
  30                         display:block;
  31                 }
  32                 blockquote {
  33                         margin: 10px 20px 0px 20px;
  34                         padding: 10px;
  35                         border: 1px solid #8d8d8d;
  36                         background-color: #f5f5f5;
  37                 }
  38                 li {
  39                         margin-top: 20px;
  40                 }
  41                 ul li ul li {
  42                         margin-top: 10px;
  43                 }
  44                 a, a:active, a:link, a:visited {
  45                         color: #7ba7e4;
  46                         text-decoration: none;
  47                 }
  48                 a:hover {
  49                         color: #5577a5;
  50                         text-decoration: underline;
  51                 }
  52                 div.sshot {
  53                 }
  54                 div.sshot p {
  55                         zcolor:#5577a5;
  56                         zfont-size:90%;
  57                 }
  58                 div.sshot img {
  59                         margin-bottom:1em;
  60                         border:1px solid #2A85B3;
  61                         padding:10px;
  62                         border-radius:10px;
  63                 }
  64                 #fade {
  65                         position:absolute; background: #E3F3FF; width:100%; height:230px; top:0px; left:0px; z-index:-1;
  66                         background: -webkit-gradient(linear, left top, left bottom, from(rgba(227, 243, 255, 1)), to(rgba(227, 243, 255, 0)));
  67                         background: -moz-linear-gradient(top,  rgba(227, 243, 255, 1),  rgba(227, 243, 255, 0.1)); /* for firefox 3.6+ */
  68                 }
  69                 /* Social */
  70                 @keyframes mymove { 0% {top:130px;} 50% {top:150px;} 100% {top:130px;} }
  71                 @-moz-keyframes mymove { 0% {top:130px;} 50% {top:135px;} 100% {top:130px;} }
  72                 @-webkit-keyframes mymove { 0% {top:130px;} 50% {top:140px;} 100% {top:130px;} }
  73                 @-o-keyframes mymove { 0% {top:130px;} 50% {top:135px;} 100% {top:130px;} }
  74                 #buttons{
  75                         width:80px; margin-top:10px; float:right; position:absolute; margin-left: 810px;
  76                         animation:mymove 0.5s ease 5s 7;
  77                         -moz-animation:mymove 0.5s ease 5s 7;
  78                         -webkit-animation:mymove 0.5s ease 5s 7;
  79                         -o-animation:mymove 0.5s ease 5s 7;
  80                 }
  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;}
  82                 #fb span {width:50px !important}
  83                 #fb .fb_iframe_widget iframe{position:relative}
  84                 /* Place Holder Style */
  85                 #Container {
  86                         width: 850px;
  87                         margin-left: auto;
  88                         margin-right: auto;
  89                         z-index:1337;
  90                 }
  91                 #Content {
  92                     background: none repeat scroll 0 0 white;
  93                     border: 3px solid #2A85B3;
  94                         -moz-border-radius:20px;
  95                         -webkit-border-radius:20px;
  96                     border-radius: 20px;
  97                         margin-top:-13px;
  98                     min-height: 150px;
  99                     padding: 5px 20px 10px;
 100                     text-align: left;
 101                         z-index:2;
 102                 }
 103                 /* Title Style */
 104                 h1{margin:0px}
 105                 #Container h1 a {
 106                         display:block;
 107                         font-family: 'Fira Sans', Verdana, Arial;
 108                         font-size: 32px;
 109                         font-weight: 700;
 110                         color: #2A85B3;
 111                         margin-top:0px;
 112                         margin-bottom: 0px;
 113                         background:transparent url(https://yourls.org/images/yourls-logo.png) left 5px no-repeat;
 114                         padding-top:15px;
 115                         height:80px;
 116                         padding-left:220px;
 117                         text-align:left;
 118                 }
 119                 h1 a:hover{text-decoration:none}
 120                 h1 a:hover span {
 121                         color: #88C0EB;
 122                         text-decoration:underline;
 123                 }
 124                 h2 {
 125                         font-family: 'Fira Sans', Verdana, Arial;
 126                         font-size: 22px;
 127                         font-weight: 700;
 128                         color: #5b87b4;
 129                         margin-top:50px;
 130                 }
 131                 h2.first{margin-top:10px}
 132                 h2:before {
 133                         content: '\00BB  ';
 134                         color:#BFE0FE;
 135                 }
 136                 h3 {
 137                         font-family: 'Fira Sans', Verdana, Arial;
 138                         font-size: 18px;
 139                         font-weight: bold;
 140                         color: #73a4d6;
 141                         margin-top:2em;
 142                 }
 143                 h3:before {
 144                         content: '\203A  ';
 145                         color:#BFE0FE;
 146                 }
 147                 /* Tabs */
 148                 ul#Tabs {
 149                         font-family: Verdana, Arial;
 150                         font-size: 13px;
 151                         font-weight: 400;
 152                         list-style-type: none;
 153                         padding-bottom: 28px;
 154                         border-bottom: 1px solid #2A85B3;
 155                         margin:0 30px 12px 30px;
 156                         z-index: 1;
 157                 }
 158                 #Tabs li.Tab {
 159                         float: right;
 160                         height: 23px;
 161                         background-color: #deedfb;
 162                         margin: 3px 0px 0px 5px;
 163                         border: 2px solid #2A85B3;
 164                         -webkit-border-top-left-radius: 10px;
 165                         -webkit-border-top-right-radius: 10px;
 166                         -moz-border-radius-topleft: 10px;
 167                         -moz-border-radius-topright: 10px;
 168                         border-top-left-radius: 10px;
 169                         border-top-right-radius: 10px;
 170                 }
 171                 #Tabs li.Tab a {
 172                         float: left;
 173                         display: block;
 174                         color: #666666;
 175                         text-decoration: none;
 176                         padding: 3px 5px;
 177                 }
 178                 #Tabs li.Tab a:hover {
 179                         background-color: #bfe0fe;
 180                         -webkit-border-top-left-radius: 10px;
 181                         -webkit-border-top-right-radius: 10px;
 182                         -moz-border-radius-topleft: 10px;
 183                         -moz-border-radius-topright: 10px;
 184                         border-top-left-radius: 10px;
 185                         border-top-right-radius: 10px;
 186                 }
 187                 /* Selected Tab */
 188                 #Tabs li.SelectedTab {
 189                         float: right;
 190                         height: 24px;
 191                         background-color: #fff;
 192                         margin: 0px 0px 0px 5px;
 193                         border-top: 2px solid #2A85B3;
 194                         border-right: 2px solid #2A85B3;
 195                         border-left: 2px solid #2A85B3;
 196                         border-bottom: 6px solid #fff;
 197                         -webkit-border-top-left-radius: 10px;
 198                         -webkit-border-top-right-radius: 10px;
 199                         -moz-border-radius-topleft: 10px;
 200                         -moz-border-radius-topright: 10px;
 201                         border-top-left-radius: 10px;
 202                         border-top-right-radius: 10px;
 203                 }
 204                 #Tabs li.SelectedTab a {
 205                         float: left;
 206                         display: block;
 207                         color: #666666;
 208                         text-decoration: none;
 209                         padding: 5px;
 210                         cursor: default;
 211                 }
 212                 /* Copyright */
 213                 #Copyright {
 214                         text-align:center;
 215                         margin-top:20px;
 216                 }
 217                 #Copyright p {
 218                         padding:10px;
 219                         background:white;
 220                         margin:0 auto;
 221                         width:750px;
 222                         border:1px solid #2A85B3;
 223                         -webkit-border-radius: 10px;
 224                         -webkit-border-bottom-right-radius: 25px;
 225                         -webkit-border-bottom-left-radius: 25px;
 226                         -moz-border-radius: 10px;
 227                         -moz-border-radius-bottomright: 30px;
 228                         -moz-border-radius-bottomleft: 30px;
 229                         border-radius: 10px;
 230                         border-bottom-right-radius: 30px;
 231                         border-bottom-left-radius: 30px;
 232                 }
 233                 #Copyright p a {
 234                         background:#fff url(https://yourls.org/images/favicon.gif) 2px center no-repeat;
 235                         padding-left:20px;
 236                 }
 237         </style>
 238         <!--[if IE]> <style>#fade{display:none}</style> <![endif]-->
 239 </head>
 240 <body>
 241 <div id="fb-root"></div>
 242 <div id="Container">
 243
 244         <!-- Title -->
 245         <header role="banner">
 246         <h1><a href="http://yourls.org/">YOURLS: <span>Y</span>our <span>O</span>wn <span>URL</span> <span>S</span>hortener</a></h1>
 247         </header>
 248
 249         <main role="main">
 250         <!-- Tabs -->
 251         <ul id="Tabs">
 252                 <li id="MoreTab" class="Tab"><a href="#More" onclick="toggle(this);">More</a></li>
 253                 <li id="FAQTab" class="Tab"><a href="#FAQ" onclick="toggle(this);">FAQ</a></li>
 254                 <li id="APITab" class="Tab"><a href="#API" onclick="toggle(this);">API</a></li>
 255                 <li id="PluginsTab" class="Tab"><a href="#Plugins" onclick="toggle(this);">YOURLS plugins</a></li>
 256                 <li id="ConfigTab" class="Tab"><a href="#Config" onclick="toggle(this);">Config</a></li>
 257                 <li id="InstallTab" class="Tab"><a href="#Install" onclick="toggle(this);">Install/Upgrade</a></li>
 258                 <li id="AboutTab" class="SelectedTab"><a href="#About" onclick="toggle(this);">About</a></li>
 259         </ul>
 260
 261         <!-- Content -->
 262         <div id="Content">
 263
 264                 <div id="buttons">
 265                         <div id="fb">
 266                         <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>
 267
 268 <script>(function(d, s, id) {
 269   var js, fjs = d.getElementsByTagName(s)[0];
 270   if (d.getElementById(id)) return;
 271   js = d.createElement(s); js.id = id;
 272   js.src = "https://connect.facebook.net/en_US/all.js#xfbml=1&appId=125474947598196";
 273   fjs.parentNode.insertBefore(js, fjs);
 274 }(document, 'script', 'facebook-jssdk'));</script>
 275                         </div>
 276                         <div id="g1">
 277                         <div class="g-plusone" data-size="tall" data-href="http://yourls.org/"></div>
 278                         <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>
 279                         </div>
 280                         <div id="tw">
 281                         <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>
 282                         <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>
 283                         </div>
 284                 </div>
 285
 286                 <!-- Index -->
 287                 <div id="AboutDiv">
 288                         <h2 class='first'>About YOURLS</h2>
 289
 290                         <h3 id="what">What is YOURLS</h3>
 291                         <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>
 292
 293                         <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>
 294
 295                         <h3 id="features">YOURLS Features</h3>
 296                         <ul>
 297                                 <li><tt>Free</tt> and <tt>Open Source</tt> software.</li>
 298                                 <li><tt>Private</tt> (your links only) or <tt>Public</tt> (everybody can create short links, fine for an intranet)</li>
 299                                 <li>Sequential or custom URL keyword</li>
 300                                 <li>Handy <tt>bookmarklets</tt> to easily shorten and share links</li>
 301                                 <li>Awesome <tt>stats</tt>: historical click reports, referrers tracking, visitors geo-location</li>
 302                                 <li>Neat <tt>Ajaxed</tt> interface</li>
 303                                 <li>Terrific <tt>Plugin</tt> architecture to easily implement new features</li>
 304                                 <li>Cool developer <tt>API</tt></li>
 305                                 <li>Full <tt>jsonp</tt> support</li>
 306                                 <li>Friendly <tt>installer</tt></li>
 307                                 <li><tt>Sample files</tt> to create your own public interface and more</li>
 308                         </ul>
 309
 310                         <h3 id="screenshots">Screenshots</h3>
 311
 312                         <div class="sshot">
 313                                 <p>Main admin dashboard</p>
 314                                 <img src="https://yourls.org/yourls-org-images/admin-dashboard.gif" />
 315
 316                                 <p>Stats for each short URL</p>
 317                                 <img src="https://yourls.org/yourls-org-images/stats-anim.gif" />
 318
 319                                 <p>See a live example of YOURLS stats on <a href="http://yourls.org/cookie+">http://yourls.org/cookie+</a></p>
 320                         </div>
 321
 322                         <h2 id="download">Download</h2>
 323
 324                         <p><a href="http://yourls.org/download">Download YOURLS</a> from Github</p>
 325                         <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>
 326
 327                         <h2 id="credits">Credits</h2>
 328
 329                         <p>YOURLS is made by <a href="https://github.com/YOURLS/YOURLS/graphs/contributors">awesome people</a>.</p>
 330
 331                         <p>Keep up to date: follow <a href="http://twitter.com/yourls">@yourls</a>, <a href="http://twitter.com/ozh">@ozh</a> (lead developper)and read the official <a href="http://blog.yourls.org/">YOURLS Blog</a></p>
 332                 </div>
 333
 334                 <!-- Installation Instructions -->
 335                 <div id="InstallDiv" style="display: none;">
 336                         <h2 class='first' id="fresh">Fresh Install</h2>
 337                         <ol>
 338                                 <li>Unzip the YOURLS archive</li>
 339                                 <li>Copy <code>user/config-sample.php</code> to <code>user/config.php</code></li>
 340                                 <li>Open <code>user/config.php</code> with a raw text editor (like Notepad) and fill in the required settings</li>
 341                                 <li>Upload the unzipped files to your domain <code>public_html</code> or <code>www</code> folder</li>
 342                                 <li>Create a new database (see <a href="#Config" onclick="toggle(this);">Configuration</a> &ndash; you can also use an existing one)</li>
 343                                 <li>Point your browser to <code>http://your-own-domain-here.com/admin/</code></li>
 344                         </ol>
 345
 346                         <h2 id="upgrade">Upgrade</h2>
 347                         <ol>
 348                                 <li><strong>Backup the database!</strong></li>
 349                                 <li>Unzip the YOURLS archive</li>
 350                                 <li>Upload files to your server, overwriting your existing install</li>
 351                                 <li>Point your browser to <code>http://your-own-domain-here.com/admin/</code></li>
 352                                 <li>Tip: you can now move your <code>config.php</code> file to the <code>/user</code> directory</li>
 353                         </ol>
 354
 355                         <h2 id="upgrade13">Upgrade from YOURLS 1.3 or earlier</h2>
 356                         <ol>
 357                                 <li><strong>Backup the database!</strong></li>
 358                                 <li>Make a copy of your <code>config.php</code></li>
 359                                 <li>Delete all files including <code>.htaccess</code> in YOURLS root directory</li>
 360                                 <li>Unzip the YOURLS archive, upload the files</li>
 361                                 <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>
 362                                 <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
 363                                 <li>Point your browser to <code>http://your-own-domain-here.com/admin/</code> and follow instructions</li>
 364                                 <li>After upgrade is well and over, remove the define <code>YOURLS_DB_TABLE_NEXTDEC</code> from your config file</li>
 365                         </ol>
 366
 367                 </div>
 368
 369                 <!-- Configuration Instructions -->
 370                 <div id="ConfigDiv" style="display: none;">
 371                         <h2 class='first'>Configuration (in <code>user/config.php</code>)</h2>
 372                         <h3 id="mysql">MySQL settings</h3>
 373                         <ul>
 374                                 <li><code>YOURLS_DB_USER</code><br/>
 375                                 your MySQL username<br/>
 376                                 <em>Example:</em> <tt>define( 'YOURLS_DB_USER', 'joe' );</tt></li>
 377                                 <li><code>YOURLS_DB_PASS</code><br/>
 378                                 your MySQL password<br/>
 379                                 <em>Example:</em> <tt>define( 'YOURLS_DB_PASS', 'MySeCreTPaSsW0rd' );</tt></li>
 380                                 <li><code>YOURLS_DB_NAME</code>:
 381                                 The database name<br/>
 382                                 <em>Example:</em> <tt>define( 'YOURLS_DB_NAME', 'yourls' );</tt></li>
 383                                 <li><code>YOURLS_DB_HOST</code><br/>
 384                                 The database host<br/>
 385                                 <em>Example:</em> <tt>define( 'YOURLS_DB_HOST', 'localhost' );</tt></li>
 386                                 <li><code>YOURLS_DB_PREFIX</code><br/>
 387                                 The name prefix for all the tables YOURLS will need<br/>
 388                                 <em>Example:</em> <tt>define( 'YOURLS_DB_PREFIX', 'yourls_' );</tt></li>
 389                         </ul>
 390
 391                         <h3 id="site">Site options</h3>
 392                         <ul>
 393                                 <li><code>YOURLS_SITE</code><br/>
 394                                 Your (hopefully 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/>
 395                                 <em>Example:</em> <tt>define( 'YOURLS_SITE', 'http://ozh.in' );</tt></li>
 396                                 <li><code>YOURLS_HOURS_OFFSET</code><br/>
 397                                 Timezone GMT offset<br/>
 398                                 <em>Example:</em> <tt>define( 'YOURLS_HOURS_OFFSET', '-5' );</tt></li>
 399                                 <li><code>YOURLS_PRIVATE</code><br/>
 400                                 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/>
 401                                 <em>Example:</em> <tt>define( 'YOURLS_PRIVATE', 'true' );</tt></li>
 402                                 <li><code>YOURLS_UNIQUE_URLS</code><br/>
 403                                 Allow multiple short URLs for a same long URL<br/>
 404                                 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/>
 405                                 <em>Example:</em> <tt>define( 'YOURLS_UNIQUE_URLS', 'true' );</tt></li>
 406                                 <li><code>YOURLS_COOKIEKEY</code><br/>
 407                                 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/>
 408                                 <em>Example:</em> <tt>define( 'YOURLS_COOKIEKEY', 'qQ4KhL_pu|s@Zm7n#%:b^{A[vhm' );</tt></li>
 409                                 <li><code>yourls_user_passwords</code><br/>
 410                                 A list of username(s) and password(s) allowed to access the site if private<br/>
 411                                 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/>
 412                                 <em>Example:</em> <tt>'joe' => 'mypassword'</tt></li>
 413                         </ul>
 414
 415                         <h3 id="urlsettings">URL Shortening settings</h3>
 416                         <ul>
 417                                 <li><code>YOURLS_URL_CONVERT</code><br/>
 418                                 URL shortening method: base <tt>36</tt> or <tt>62</tt>. See <a onclick="toggle(this);" href="#FAQ">FAQ</a> for more explanations</li>
 419                                 <li><code>yourls_reserved_URL</code><br/>
 420                                 A list of reserved keywords that won't be used as short URLs. Define here negative, unwanted or potentially misleading keywords<br/>
 421                                 <em>Example:</em> <tt>'porn', 'faggot', 'sex', 'nigger', 'fuck', 'cunt', 'dick'</tt></li>
 422                         </ul>
 423
 424                         <h3 id="optional">Optional settings</h3>
 425                         <ul>
 426                                 <li><code>YOURLS_PRIVATE_INFOS</code><br/>
 427                                 If <code>YOURLS_PRIVATE</code> is set to <tt>true</tt>, you can still make stat pages public. To do so, define with:<br/>
 428                                 <tt>define('YOURLS_PRIVATE_INFOS', false);</tt>
 429                                 </li>
 430                                 <li><code>YOURLS_PRIVATE_API</code><br/>
 431                                 If <code>YOURLS_PRIVATE</code> is set to <tt>true</tt>, you can still make your API public. To do so, define with:<br/>
 432                                 <tt>define('YOURLS_PRIVATE_API', false);</tt>
 433                                 <li><code>YOURLS_NOSTATS</code><br/>
 434                                 If <code>YOURLS_NOSTATS</code> is set to <tt>true</tt>, redirects won't be logged and there will be not stats available.<br/>
 435                                 </li>
 436                         </ul>
 437
 438                         <h3 id="advanced">Advanced settings</h3>
 439             <ul>
 440                 <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/>
 441                 <tt>define( 'YOURLS_DB_DRIVER', 'mysqli' );</tt></li>
 442                 <li>You can install YOURLS behind a firewall or a proxy: see <a href="http://yourls.org/proxy">Proxy Support</a></li>
 443                 <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>
 444             </ul>
 445                 </div>
 446
 447                 <!-- YOURLS plugins -->
 448                 <div id="PluginsDiv" style="display:none">
 449                         <h2 class='first'>Plugins for YOURLS</h2>
 450
 451                         <h3 id="plugins">Plugins?</h3>
 452                         <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>
 453                         <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>
 454                         <p>There's a growing number of plugins available: check the <a href="http://yourls.org/pluginlist">Plugin list</a>.</p>
 455
 456                         <h3 id="documentation">Documentation</h3>
 457                         <p>Several sample plugins are included in the archive. Read the source and learn the concept. It's easy and fun!</p>
 458                         <p>Check the <a href="http://yourls.org/pluginapi">plugin API documentation</a> to learn more</p>
 459
 460                 </div>
 461
 462                 <!-- API -->
 463                 <div id="APIDiv" style="display:none">
 464                         <h2 class='first'>YOURLS' API</h2>
 465
 466                         <h3 id="apifeatures">Features</h3>
 467                         <ul>
 468                                 <li>Generate or get existing short URLs, with sequential or custom keyword</li>
 469                                 <li>Get some statistics about your links: top clicked links, least clicked links, newest links</li>
 470                                 <li>Output format: JSON, XML, or simple raw text</li>
 471                                 <li>Authentify either with login/password or using a secure passwordless mechanism</li>
 472                         </ul>
 473
 474                         <h3 id="apiusage">Usage</h3>
 475                         <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>
 476                         <ul>
 477                                 <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>
 478                                 <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>
 479                                 <li>With <tt>action = "shorturl"</tt> :
 480                                         <ul>
 481                                                 <li>the <code>url</code> to shorten</li>
 482                                                 <li>optional <code>keyword</code> and <code>title</code> for custom short URLs</li>
 483                                                 <li>output <code>format</code>: either <tt>"jsonp"</tt>, <tt>"json"</tt>, <tt>"xml"</tt> or <tt>"simple"</tt></li>
 484                                         </ul>
 485                                 </li>
 486                                 <li>With <tt>action = "expand"</tt> :
 487                                         <ul>
 488                                                 <li>the <code>shorturl</code> to expand (can be either 'abc' or 'http://site/abc')</li>
 489                                                 <li>output <code>format</code>: either <tt>"jsonp"</tt>, <tt>"json"</tt>, <tt>"xml"</tt> or <tt>"simple"</tt></li>
 490                                         </ul>
 491                                 </li>
 492                                 <li>With <tt>action = "url-stats"</tt> :
 493                                         <ul>
 494                                                 <li>the <code>shorturl</code> for which to get stats (can be either 'abc' or 'http://site/abc')</li>
 495                                                 <li>output <code>format</code>: either <tt>"jsonp"</tt>, <tt>"json"</tt> or <tt>"xml"</tt></li>
 496                                         </ul>
 497                                 </li>
 498                                 <li>With <tt>action = "stats"</tt> :
 499                                         <ul>
 500                                                 <li>the <code>filter</code>: either <tt>"top"</tt>, <tt>"bottom"</tt> , <tt>"rand"</tt> or <tt>"last"</tt></li>
 501                                                 <li>the <code>limit</code> (maximum number of links to return)</li>
 502                                                 <li>output <code>format</code>: either <tt>"jsonp"</tt>, <tt>"json"</tt> or <tt>"xml"</tt></li>
 503                                         </ul>
 504                                 </li>
 505                                 <li>With <tt>action = "db-stats"</tt> :
 506                                         <ul>
 507                                                 <li>output <code>format</code>: either <tt>"jsonp"</tt>, <tt>"json"</tt> or <tt>"xml"</tt></li>
 508                                         </ul>
 509                                 </li>
 510                         </ul>
 511
 512             <h3 id="apiexample">Sample requests</h3>
 513             <p>Example of a <tt>GET</tt> request with Javascript (using jQuery) to shorten a URL</p>
 514             <pre><tt>var api_url  = 'http://sho.rt/yourls-api.php';
 515 var response = $.get( api_url, {
 516     username: "your_username",
 517     password: "your_password",
 518     action:   "shorturl",
 519     format:   "json",
 520     url:      "http://ozh.org/"
 521     },
 522     // callback function that will deal with the server response
 523     function( data) {
 524         // for instance, return short URL
 525         return data.shorturl;
 526     }
 527 );</tt></pre>
 528
 529             <p>Example of a <tt>POST</tt> request with PHP to expand a short URL</p>
 530             <pre><tt>&lt?php
 531 $username = 'your_username';
 532 $password = 'your_password';
 533 $api_url =  'http://sho.rt/yourls-api.php';
 534
 535 // Init the CURL session
 536 $ch = curl_init();
 537 curl_setopt($ch, CURLOPT_URL, $api_url);
 538 curl_setopt($ch, CURLOPT_HEADER, 0);            // No header in the result
 539 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // Return, do not echo result
 540 curl_setopt($ch, CURLOPT_POST, 1);              // This is a POST request
 541 curl_setopt($ch, CURLOPT_POSTFIELDS, array(     // Data to POST
 542         'shorturl' => 'ozh',
 543         'format'   => 'json',
 544         'action'   => 'expand',
 545         'username' => $username,
 546         'password' => $password
 547     ));
 548
 549 // Fetch and return content
 550 $data = curl_exec($ch);
 551 curl_close($ch);
 552
 553 // Do something with the result. Here, we echo the long URL
 554 $data = json_decode( $data );
 555 echo $data->longurl;</tt></pre>
 556
 557                         <h3 id="apireturn">Sample returns</h3>
 558             <p>Sample return in JSON format for the <code>shorturl</code> action</p>
 559             <pre><tt>{
 560   "url": {
 561     "keyword": "ozh",
 562     "url": "http:\/\/ozh.org",
 563     "title": "Ozh RICHARD \u00ab ozh.org",
 564     "date": "2014-10-24 16:01:39",
 565     "ip": "127.0.0.1"
 566   },
 567   "status": "success",
 568   "message": "http:\/\/ozh.org added to database",
 569   "title": "Ozh RICHARD \u00ab ozh.org",
 570   "shorturl": "http:\/\/sho.rt\/1f",
 571   "statusCode": 200
 572 }</tt></pre>
 573
 574             <p>Sample return in XML format for the <code>expand</code> action</p>
 575                         <pre><tt>&lt;result&gt;
 576     &lt;keyword&gt;ozh&lt;/keyword&gt;
 577     &lt;shorturl&gt;http://sho.rt/ozh&lt;/shorturl&gt;
 578     &lt;longurl&gt;http://ozh.org/&lt;/longurl&gt;
 579     &lt;message&gt;success&lt;/message&gt;
 580     &lt;statusCode&gt;200&lt;/statusCode&gt;
 581 &lt;/result&gt;</tt></pre>
 582
 583                         <h3 id="apisample">Sample file</h3>
 584                         <p>There's a sample PHP file included that serves as an example on how to play with the API</p>
 585
 586                         <h3 id="expand_api">Expand the API</h3>
 587                         <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>
 588
 589                 </div>
 590
 591
 592                 <!-- FAQ Instructions -->
 593                 <div id="FAQDiv" style="display: none;">
 594                         <h2 class='first'>FAQ</h2>
 595
 596                         <h3 id="requirement">Server requirements</h3>
 597                         <ol>
 598                                 <li>A server with <strong>mod_rewrite</strong> enabled</li>
 599                                 <li>At least <strong>PHP 5.2</strong></li>
 600                                 <li>At least <strong>MYSQL 4.1</strong></li>
 601                                 <li><em>Note</em>: YOURLS can also run on <a href="https://github.com/YOURLS/YOURLS/wiki/Nginx-configuration">Nginx</a> and <a href="http://www.ututech.com/2010/10/configuring-yourls-to-work-with-cherokee-web-server/">Cherokee</a></li>
 602                         </ol>
 603
 604                         <h3 id="recommendation">Server recommendations</h3>
 605                         <ul>
 606                                 <li>PHP <a href="http://www.php.net/curl">CURL extension</a> installed if you plan on playing with the API</li>
 607                         </ul>
 608
 609                         <h3 id="limitations">Limitations</h3>
 610                         <ul>
 611                                 <li>Maximum length of custom keyword is <strong>200 characters</strong></li>
 612                                 <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>
 613                         </ul>
 614
 615                         <h3 id="base3662">Difference Between Base 36 And Base 62 Encoding</h3>
 616                         <ul>
 617                                 <li>Base 36 encoding uses <code>0123456789abcdefghijklmnopqrstuvwxyz</code> for short URLs</li>
 618                                 <li>Base 62 encoding uses <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz</code></li>
 619                                 <li>Stick to one setting, don't change after you've created links as it will change all your short URLs!</li>
 620                                 <li>Base 36 is the default and should be picked if you're not sure.</li>
 621                         </ul>
 622
 623                         <h3 id="shortdomain">Getting a short domain name for your YOURLS install</h3>
 624                         <ul>
 625                                 <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>
 626                                 <li><a href="http://domai.nr/">Domainr</a> is a fun search tool that might inspire and help you</li>
 627                                 <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>
 628                         </ul>
 629
 630                         <h3 id="htaccess">YOURLS needs its own .htaccess</h3>
 631                         <ul>
 632                                 <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>
 633                                 <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>
 634                         </ul>
 635
 636                         <h3 id="does404">If YOURLS generates 404 for your short URLs</h3>
 637                         <ul>
 638                                 <li>Make sure <strong>mod_rewrite</strong> is enabled with your Apache server</li>
 639                                 <li>Make sure your .htaccess file looks like <a href="http://yourls.org/htaccess">this one</a></li>
 640                                 <li>Eventually, check your server Apache configuration allows use of .htaccess (<tt>AllowOverride All</tt> directive, ask your server admin)</li>
 641                         </ul>
 642
 643                         <h3 id="noindex">There is no index page at the root of the install</h3>
 644                         <ul>
 645                                 <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>
 646                                 <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>
 647                         </ul>
 648
 649                         <h3 id="lowercase">Uppercase letters in short URLs are eaten up, eg "<code>OmgOzh</code>" becomes "<code>mgzh</code>" !</h3>
 650                         <ul>
 651                                 <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>
 652                                 <li>If you want to force lowercase, you'll need a <a href="http://yourls.org/pluginlist">plugin</a>.</li>
 653                         </ul>
 654
 655                         <h3 id="feedback">Feedback, feature requests and bug reporting</h3>
 656                         <ol>
 657                                 <li>Please don't get in touch directly by mail or Twitter. <a href="http://yourls.org/support">Please</a>.</li>
 658                                 <li>Check the <a href="http://yourls.org/roadmap">Road Map</a> for future features.</li>
 659                                 <li>Read all the <a href="http://yourls.org/wiki">wiki documents</a>.</li>
 660                                 <li>Search in all the <a href="http://yourls.org/issues">issues</a>, open and closed.</li>
 661                                 <li>Eventually raise a new issue. To do so, please read the <a href="http://yourls.org/contribute">contribute guidelines</a>. Thanks!</li>
 662                         </ol>
 663
 664                 </div>
 665
 666
 667                 <!-- More -->
 668                 <div id="MoreDiv" style="display: none;">
 669
 670                         <h2 class='first'>Community</h2>
 671
 672                         <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>
 673
 674                         <h3 id="ressources">Resources</h3>
 675                         <ul>
 676                                 <li>The official <a href="http://blog.yourls.org">YOURLS blog</a>, for news, hints and showcase.</li>
 677                                 <li>The <a href="http://yourls.org/wiki">wiki</a>: advanced documentation, plugins, tips and more</li>
 678                                 <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>
 679                         </ul>
 680
 681                         <h2 id="showcase">Showcase</h2>
 682
 683                         <h3>Here are a few examples of sites running YOURLS with a unique design or concept</h3>
 684                         <ul>
 685                                 <li><a href="http://oe.cd/">http://oe.cd/</a><br/>
 686                                 OECD's internal URL shortener with a neat interface and private features</li>
 687
 688                                 <li><a href="http://tini.link/">http://tini.link/</a><br/>
 689                                 A fun top level domain and a very nicely designed YOURLS public interface</li>
 690
 691                                 <li><a href="http://xib.me/">http://xib.me/</a></br/>
 692                                 A nicely styled YOURLS public interface</li>
 693
 694                                 <li><a href="http://vt802.us/">http://vt802.us/</a><br/>
 695                                 Defined as "The World's First Vermont-centric URL Shortener"</li>
 696
 697                                 <li><a href="http://yourwish.es/">http://yourwish.es/</a><br/>
 698                                 Easily share an Amazon wishlist</li>
 699
 700                                 <li><a href="http://vbly.us">http://vbly.us</a><br/>
 701                                 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>
 702                         </ul>
 703
 704                         <h2 id="frameworks">YOURLS and other platforms or frameworks</h2>
 705                         <ul>
 706                                 <li id="wordpress"><a href="http://wordpress.org/extend/plugins/search.php?q=yourls">WordPress</a><br/>
 707                                 There are numerous WordPress plugin with YOURLS support. <a href="http://wordpress.org/extend/plugins/yourls-link-creator/">YOURLS Link Creator</a> is recommended.</li>
 708
 709                                 <li id="drupal"><a href="http://drupal.org/project/yourls">Drupal</a><br/>
 710                                 Allows for the automatic creation of short urls using a YOURLS installation</li>
 711
 712                                 <li id="perl"><a href="http://github.com/pjain/WWW-Shorten-Yourls">Perl</a><br/>
 713                                 WWW-Shorten-Yourls is a Perl module to shorten URLs using YOURLS</li>
 714
 715                                 <li id="ruby"><a href="https://github.com/threestage/yourls">Ruby</a><br/>
 716                                 A Ruby wrapper for the YOURLS API</li>
 717
 718                                 <li id="python"><a href="http://tflink.github.com/python-yourls/">Python</a><br/>
 719                                 A Python client for YOURLS</li>
 720
 721                                 <li id="vbnet"><a href="http://www.nugardt.com/open-source/yourls-api/">VB .Net</a><br/>
 722                                 A VB .Net 4.0 wrapper for the YOURLS API</li>
 723
 724                                 <li id="javascript"><a href="http://neocotic.com/yourls-api/">Javascript</a><br/>
 725                                 JavaScript bindings for the YOURLS API to leverage JSONP support</li>
 726
 727                                 <li id="cake"><a href="https://github.com/driflash/CakePHP-YOURLS-Plugin">CakePHP</a><br/>
 728                                 Plugin which integrates CakePHP with Yourls</li>
 729
 730                                 <li id="statusnet"><a href="https://github.com/rthees/yourls-status-net">status.net</a><br/>
 731                                 A plugin for status.net to use YOURLS</li>
 732
 733                                 <li id="sharetronix"><a href="http://developer.sharetronix.com/mpview/12/tag:yourls">Sharetronix</a><br/>
 734                                 A YOURLS addon for Sharetronix</li>
 735
 736                         </ul>
 737
 738                         <h2>YOURLS works with your favorite sofware or device</h2>
 739                         <ul>
 740                                 <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/>
 741                                 How to set up Tweetie2 so it uses your own service</li>
 742
 743                                 <li id="tweetbot"><a href="http://2fatdads.com/2012/02/how-to-make-yourls-org-work-in-tweetbot/">Tweetbot</a><br/>
 744                                 Make Tweetbot run with YOURLS</li>
 745
 746                                 <li id="twitterfeed"><a href="http://blog.yourls.org/2011/09/how-to-use-twitterfeed-with-your-custom-yourls-url-shortener/">Twitterfeed</a><br/>
 747                                 Use Twitterfeed with YOURLS</li>
 748
 749                                 <li id="mac"><a href="http://timi.im/app/">Mac Client</a><br/>
 750                                 Simple app to have a global keyboard shortcut send a link to YOURLS</li>
 751
 752                                 <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/>
 753                                 Android apps that plays nice with YOURLS</li>
 754
 755                                 <li id="iphone">iOS: <a href="http://shorttailapp.com/">ShortTail for YOURLS</a>, <a href="http://itunes.apple.com/us/app/clicklytics-track-clicks-on/id444008024?mt=8">Clicklytics</a> and <a href="https://itunes.apple.com/us/app/myyourls/id661934890?mt=8">myYOURLS</a><br/>
 756                                 Apps to use YOURLS on iPhones and iPads</li>
 757
 758                                 <li id="chrome"><a href="https://github.com/ukoms/Chrourls">Chrourls</a><br/>
 759                                 Google Chrome quick link shortening addon for YOURLS</li>
 760
 761                                 <li id="firefox"><a href="https://addons.mozilla.org/en-us/firefox/addon/yourls-shortener/">Firefox Addon</a><br/>
 762                                 Firefox Addon for YOURLS</li>
 763
 764                                 <li id="textexpander"><a href="http://www.chrismarquardt.com/blog.php?id=7952283233607249761">Textexpander and YOURLS</a><br/>
 765                                 Making YOURLS and Textexpander on the Mac play together</li>
 766                         </ul>
 767
 768                         <h2 id="morestuff">More stuff to do with YOURLS</h2>
 769                         <ul>
 770
 771                                 <li><a href="https://github.com/tomslominski/infinity-squared">Infinity Squared</a><br/>
 772                                 &#8734;&sup2; is a public page theme for YOURLS to help you design your own public interface</li>
 773
 774                                 <li><a href="https://github.com/Flynntes/Sleeky">Sleeky</a><br/>
 775                                 Sleeky is another public page theme for YOURLS></li>
 776
 777                                 <li><a href="https://github.com/johngirvin/yourls-index-page">John Girvin's page</a><br/>
 778                                 Example index page listing all the URLs held in a YOURLS database</li>
 779
 780                                 <li><a href="http://screenr.com/nTs">http://screenr.com/nTs</a><br/>
 781                                 A screencast explaining how to setup YOURLS</li>
 782
 783                                 <li><a href="http://v007.me/836">YOURLS: Short URL Widget</a><br/>
 784                                 Creates a fully configurable widget that outputs the short URL to the current post or page</li>
 785
 786                                 <li><a href="http://foolrulez.org/blog/2009/09/yourls-widget-released">YOURLS Widget for WordPress</a><br/>
 787                                 This widget adds a convenient short URL service into your sidebar. Check the above link for a live example</li>
 788
 789                                 <li><a href="http://www.stewartallen.org/2010/08/yourls-twitter-tools-wordpress-plugin/">Twitter Tools & YOURLS</a><br/>
 790                                 Companion plugin for Alex King's Twitter Tool for WordPress, that enables YOURLS support</li>
 791
 792                                 <li><a href="http://code.google.com/p/yourls/issues/detail?id=137">Export URLS as text list</a><br/>
 793                                 A simple script to list all URLs, one per line, in plain text (for using as an indexer config file, for example)</li>
 794
 795                                 <li>YOURLS featured on <a href="http://lifehacker.com/5335216/make-your-own-url-shortening-service">Lifehacker</a></li>
 796                         </ul>
 797
 798                         <h2>"Celebrity endorsements", sort of.</h2>
 799                         <ul>
 800
 801                                 <li><a href="http://smashed.by/">http://smashed.by/</a> by <a href="http://smashingmagazine.com/">Smashing Magazine</a></li>
 802
 803                                 <li><a href="http://oe.cd/">http://oe.cd/</a> by <a href="http://www.oecd.org/">the OECD</a></li>
 804
 805                                 <li><a href="http://cuny.is/">http://cuny.is/</a> by <a href="http://www.cuny.edu/">the City University of New York</a></li>
 806
 807                                 <li><a href="http://virg.in/">http://virg.in/</a> for the <a href="http://www.virgin.com/">Virgin Group companies</a></li>
 808
 809                                 <li><a href="http://dhurl.org/">http://dhurl.org/</a> by <a href="http://yourls.org/dreamhost">Dreamhost</a></li>
 810
 811                                 <li><a href="http://ithem.es/">http://ithem.es/</a> by <a href="http://www.ithemes.com/">iThemes</a></li>
 812
 813                         </ul>
 814
 815
 816                 </div>
 817         </div> <!-- content -->
 818         </main>
 819 </div> <!-- container -->
 820
 821 <div id="fade"></div>
 822
 823         <script type="text/javascript">
 824         /* <![CDATA[*/
 825         // Dynamically get tabs
 826         function getTabs() {
 827                 var d = document.getElementById('Tabs');
 828                 var matches = d.innerHTML.match(/<li.* id="(.+?)Tab"/g);
 829                 var tabs = []
 830                 for (i in matches) {
 831                   tabs[i]= matches[i].replace(/<li.* id="/,'').replace('Tab"', '');
 832                 }
 833                 tabs = tabs.reverse();
 834                 return (tabs)
 835         }
 836         // Scroll to ?anchor
 837         // window.location.hash
 838
 839         // Toggle tab display
 840         function toggle(el) {
 841                 var hashes = el.toString().replace(/^.*?#/, '').split('#');
 842                 var target = hashes[0];
 843                 var anchor = hashes[1];
 844                 // If tab doesn't exist, exit
 845                 if( tabs.indexOf( target ) == -1 )
 846                         return;
 847                 for (var tab in tabs) {
 848                         // reinit tabs
 849                         document.getElementById(tabs[tab]+'Tab').className = 'Tab';
 850                         // reinit divs
 851                         document.getElementById(tabs[tab]+'Div').style.display= 'none';
 852                 }
 853                 // highlight & display target
 854                 document.getElementById(target+'Div').style.display = 'block';
 855                 document.getElementById(target+'Tab').className = 'SelectedTab';
 856                 randbg();
 857                 try { el.blur(); } catch(err) {}
 858                 // Try scrolling to anchor
 859                 try {
 860                         window.scroll(0,findPos(document.getElementById(anchor)));
 861                 } catch(err) { window.location.hash = target; }
 862         }
 863         // Get tab list
 864         var tabs = getTabs();
 865         // On page load/refresh display required tab
 866         if (location.hash) {
 867                 toggle(location.hash);
 868         }
 869         // Background fancyness
 870         function randbg(){
 871                 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' ];
 872                 var bg = rndbg[ Math.floor( Math.random() * rndbg.length ) ];
 873                 document.body.style.background='#E3F3FF url(user/plugins/random-bg/img/'+bg+')';
 874         };
 875         randbg();
 876         //Finds y value of given object
 877         function findPos(obj) {
 878                 var curtop = 0;
 879                 if (obj.offsetParent) {
 880                         do {
 881                                 curtop += obj.offsetTop;
 882                         } while (obj = obj.offsetParent);
 883                 curtop = curtop - 30;
 884                 return [curtop];
 885                 }
 886         }
 887         /* ]]> */
 888         </script>
 889
 890
 891 </body>
 892 </html>