]> CyberLeo.Net >> Repos - Github/YOURLS.git/blob - readme.html
Attempt number 666 at running desired PHPunit bin
[Github/YOURLS.git] / 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                         <a href="https://www.rosehosting.com/blog/how-to-install-yourls-on-ubuntu-14-04/">How to Install YOURLS on Ubuntu 14.04</a> (Unoficial guide)
346                         
347                         <h2 id="upgrade">Upgrade</h2>
348                         <ol>
349                                 <li><strong>Backup the database!</strong></li>
350                                 <li>Unzip the YOURLS archive</li>
351                                 <li>Upload files to your server, overwriting your existing install</li>
352                                 <li>Point your browser to <code>http://your-own-domain-here.com/admin/</code></li>
353                                 <li>Tip: you can now move your <code>config.php</code> file to the <code>/user</code> directory</li>
354                         </ol>
355                         
356                         <h2 id="upgrade13">Upgrade from YOURLS 1.3 or earlier</h2>
357                         <ol>
358                                 <li><strong>Backup the database!</strong></li>
359                                 <li>Make a copy of your <code>config.php</code></li>
360                                 <li>Delete all files including <code>.htaccess</code> in YOURLS root directory</li>
361                                 <li>Unzip the YOURLS archive, upload the files</li>
362                                 <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>
363                                 <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
364                                 <li>Point your browser to <code>http://your-own-domain-here.com/admin/</code> and follow instructions</li>
365                                 <li>After upgrade is well and over, remove the define <code>YOURLS_DB_TABLE_NEXTDEC</code> from your config file</li>
366                         </ol>
367                         
368                 </div>
369
370                 <!-- Configuration Instructions -->     
371                 <div id="ConfigDiv" style="display: none;">
372                         <h2 class='first'>Configuration (in <code>user/config.php</code>)</h2>
373                         <h3 id="mysql">MySQL settings</h3>
374                         <ul>
375                                 <li><code>YOURLS_DB_USER</code><br/>
376                                 your MySQL username<br/>
377                                 <em>Example:</em> <tt>define( 'YOURLS_DB_USER', 'joe' );</tt></li>
378                                 <li><code>YOURLS_DB_PASS</code><br/>
379                                 your MySQL password<br/>
380                                 <em>Example:</em> <tt>define( 'YOURLS_DB_PASS', 'MySeCreTPaSsW0rd' );</tt></li>
381                                 <li><code>YOURLS_DB_NAME</code>:
382                                 The database name<br/>
383                                 <em>Example:</em> <tt>define( 'YOURLS_DB_NAME', 'yourls' );</tt></li>
384                                 <li><code>YOURLS_DB_HOST</code><br/>
385                                 The database host<br/>
386                                 <em>Example:</em> <tt>define( 'YOURLS_DB_HOST', 'localhost' );</tt></li>
387                                 <li><code>YOURLS_DB_PREFIX</code><br/>
388                                 The name prefix for all the tables YOURLS will need<br/>
389                                 <em>Example:</em> <tt>define( 'YOURLS_DB_PREFIX', 'yourls_' );</tt></li>
390                         </ul>
391                         
392                         <h3 id="site">Site options</h3>
393                         <ul>
394                                 <li><code>YOURLS_SITE</code><br/>
395                                 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/>
396                                 <em>Example:</em> <tt>define( 'YOURLS_SITE', 'http://ozh.in' );</tt></li>
397                                 <li><code>YOURLS_HOURS_OFFSET</code><br/>
398                                 Timezone GMT offset<br/>
399                                 <em>Example:</em> <tt>define( 'YOURLS_HOURS_OFFSET', '-5' );</tt></li>
400                                 <li><code>YOURLS_PRIVATE</code><br/>
401                                 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/>
402                                 <em>Example:</em> <tt>define( 'YOURLS_PRIVATE', 'true' );</tt></li>
403                                 <li><code>YOURLS_UNIQUE_URLS</code><br/>
404                                 Allow multiple short URLs for a same long URL<br/>
405                                 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/>
406                                 <em>Example:</em> <tt>define( 'YOURLS_UNIQUE_URLS', 'true' );</tt></li>
407                                 <li><code>YOURLS_COOKIEKEY</code><br/>
408                                 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/>
409                                 <em>Example:</em> <tt>define( 'YOURLS_COOKIEKEY', 'qQ4KhL_pu|s@Zm7n#%:b^{A[vhm' );</tt></li>
410                                 <li><code>yourls_user_passwords</code><br/>
411                                 A list of username(s) and password(s) allowed to access the site if private<br/>
412                                 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/>
413                                 <em>Example:</em> <tt>'joe' => 'mypassword'</tt></li>
414                         </ul>
415                         
416                         <h3 id="urlsettings">URL Shortening settings</h3>
417                         <ul>
418                                 <li><code>YOURLS_URL_CONVERT</code><br/>
419                                 URL shortening method: base <tt>36</tt> or <tt>62</tt>. See <a onclick="toggle(this);" href="#FAQ">FAQ</a> for more explanations</li>
420                                 <li><code>yourls_reserved_URL</code><br/>
421                                 A list of reserved keywords that won't be used as short URLs. Define here negative, unwanted or potentially misleading keywords<br/>
422                                 <em>Example:</em> <tt>'porn', 'faggot', 'sex', 'nigger', 'fuck', 'cunt', 'dick'</tt></li>
423                         </ul>
424                         
425                         <h3 id="optional">Optional settings</h3>
426                         <ul>
427                                 <li><code>YOURLS_PRIVATE_INFOS</code><br/>
428                                 If <code>YOURLS_PRIVATE</code> is set to <tt>true</tt>, you can still make stat pages public. To do so, define with:<br/>
429                                 <tt>define('YOURLS_PRIVATE_INFOS', false);</tt>
430                                 </li>
431                                 <li><code>YOURLS_PRIVATE_API</code><br/>
432                                 If <code>YOURLS_PRIVATE</code> is set to <tt>true</tt>, you can still make your API public. To do so, define with:<br/>
433                                 <tt>define('YOURLS_PRIVATE_API', false);</tt>
434                                 <li><code>YOURLS_NOSTATS</code><br/>
435                                 If <code>YOURLS_NOSTATS</code> is set to <tt>true</tt>, redirects won't be logged and there will be not stats available.<br/>
436                                 </li>
437                         </ul>
438                         
439                         <h3 id="advanced">Advanced settings</h3>
440             <ul>
441                 <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/>
442                 <tt>define( 'YOURLS_DB_DRIVER', 'mysqli' );</tt></li>
443                 <li>You can install YOURLS behind a firewall or a proxy: see <a href="http://yourls.org/proxy">Proxy Support</a></li>
444                 <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>
445             </ul>
446                 </div>
447                 
448                 <!-- YOURLS plugins -->
449                 <div id="PluginsDiv" style="display:none">
450                         <h2 class='first'>Plugins for YOURLS</h2>
451                         
452                         <h3 id="plugins">Plugins?</h3>
453                         <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>
454                         <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>
455                         <p>There's a growing number of plugins available: check the <a href="http://yourls.org/pluginlist">Plugin list</a>.</p>
456
457                         <h3 id="documentation">Documentation</h3>
458                         <p>Several sample plugins are included in the archive. Read the source and learn the concept. It's easy and fun!</p>
459                         <p>Check the <a href="http://yourls.org/pluginapi">plugin API documentation</a> to learn more</p>
460                 
461                 </div>
462                 
463                 <!-- API -->
464                 <div id="APIDiv" style="display:none">
465                         <h2 class='first'>YOURLS' API</h2>
466                         
467                         <h3 id="apifeatures">Features</h3>
468                         <ul>
469                                 <li>Generate or get existing short URLs, with sequential or custom keyword</li>
470                                 <li>Get some statistics about your links: top clicked links, least clicked links, newest links</li>
471                                 <li>Output format: JSON, XML, or simple raw text</li>
472                                 <li>Authentify either with login/password or using a secure passwordless mechanism</li>
473                         </ul>
474                         
475                         <h3 id="apiusage">Usage</h3>
476                         <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>
477                         <ul>
478                                 <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>
479                                 <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>
480                                 <li>With <tt>action = "shorturl"</tt> :
481                                         <ul>
482                                                 <li>the <code>url</code> to shorten</li>
483                                                 <li>optional <code>keyword</code> and <code>title</code> for custom short URLs</li>
484                                                 <li>output <code>format</code>: either <tt>"jsonp"</tt>, <tt>"json"</tt>, <tt>"xml"</tt> or <tt>"simple"</tt></li>
485                                         </ul>
486                                 </li>
487                                 <li>With <tt>action = "expand"</tt> :
488                                         <ul>
489                                                 <li>the <code>shorturl</code> to expand (can be either 'abc' or 'http://site/abc')</li>
490                                                 <li>output <code>format</code>: either <tt>"jsonp"</tt>, <tt>"json"</tt>, <tt>"xml"</tt> or <tt>"simple"</tt></li>
491                                         </ul>
492                                 </li>
493                                 <li>With <tt>action = "url-stats"</tt> :
494                                         <ul>
495                                                 <li>the <code>shorturl</code> for which to get stats (can be either 'abc' or 'http://site/abc')</li>
496                                                 <li>output <code>format</code>: either <tt>"jsonp"</tt>, <tt>"json"</tt> or <tt>"xml"</tt></li>
497                                         </ul>
498                                 </li>
499                                 <li>With <tt>action = "stats"</tt> :
500                                         <ul>
501                                                 <li>the <code>filter</code>: either <tt>"top"</tt>, <tt>"bottom"</tt> , <tt>"rand"</tt> or <tt>"last"</tt></li>
502                                                 <li>the <code>limit</code> (maximum number of links to return)</li>
503                                                 <li>output <code>format</code>: either <tt>"jsonp"</tt>, <tt>"json"</tt> or <tt>"xml"</tt></li>
504                                         </ul>
505                                 </li>
506                                 <li>With <tt>action = "db-stats"</tt> :
507                                         <ul>
508                                                 <li>output <code>format</code>: either <tt>"jsonp"</tt>, <tt>"json"</tt> or <tt>"xml"</tt></li>
509                                         </ul>
510                                 </li>
511                         </ul>
512             
513             <h3 id="apiexample">Sample requests</h3>
514             <p>Example of a <tt>GET</tt> request with Javascript (using jQuery) to shorten a URL</p>
515             <pre><tt>var api_url  = 'http://sho.rt/yourls-api.php';
516 var response = $.get( api_url, {
517     username: "your_username",
518     password: "your_password",
519     action:   "shorturl",
520     format:   "json",
521     url:      "http://ozh.org/"
522     },
523     // callback function that will deal with the server response
524     function( data) {
525         // for instance, return short URL
526         return data.shorturl;
527     }
528 );</tt></pre>
529             
530             <p>Example of a <tt>POST</tt> request with PHP to expand a short URL</p>
531             <pre><tt>&lt?php
532 $username = 'your_username';
533 $password = 'your_password';
534 $api_url =  'http://sho.rt/yourls-api.php';
535
536 // Init the CURL session
537 $ch = curl_init();
538 curl_setopt($ch, CURLOPT_URL, $api_url);
539 curl_setopt($ch, CURLOPT_HEADER, 0);            // No header in the result
540 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // Return, do not echo result
541 curl_setopt($ch, CURLOPT_POST, 1);              // This is a POST request
542 curl_setopt($ch, CURLOPT_POSTFIELDS, array(     // Data to POST
543         'shorturl' => 'ozh',
544         'format'   => 'json',
545         'action'   => 'expand',
546         'username' => $username,
547         'password' => $password
548     ));
549
550 // Fetch and return content
551 $data = curl_exec($ch);
552 curl_close($ch);
553
554 // Do something with the result. Here, we echo the long URL
555 $data = json_decode( $data );
556 echo $data->longurl;</tt></pre>
557                         
558                         <h3 id="apireturn">Sample returns</h3>
559             <p>Sample return in JSON format for the <code>shorturl</code> action</p>
560             <pre><tt>{
561   "url": {
562     "keyword": "ozh",
563     "url": "http:\/\/ozh.org",
564     "title": "Ozh RICHARD \u00ab ozh.org",
565     "date": "2014-10-24 16:01:39",
566     "ip": "127.0.0.1"
567   },
568   "status": "success",
569   "message": "http:\/\/ozh.org added to database",
570   "title": "Ozh RICHARD \u00ab ozh.org",
571   "shorturl": "http:\/\/sho.rt\/1f",
572   "statusCode": 200
573 }</tt></pre>
574             
575             <p>Sample return in XML format for the <code>expand</code> action</p>
576                         <pre><tt>&lt;result&gt;
577     &lt;keyword&gt;ozh&lt;/keyword&gt;
578     &lt;shorturl&gt;http://sho.rt/ozh&lt;/shorturl&gt;
579     &lt;longurl&gt;http://ozh.org/&lt;/longurl&gt;
580     &lt;message&gt;success&lt;/message&gt;
581     &lt;statusCode&gt;200&lt;/statusCode&gt;
582 &lt;/result&gt;</tt></pre>
583
584                         <h3 id="apisample">Sample file</h3>
585                         <p>There's a sample PHP file included that serves as an example on how to play with the API</p>
586
587                         <h3 id="expand_api">Expand the API</h3>
588                         <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>
589
590                 </div>
591                 
592
593                 <!-- FAQ Instructions -->       
594                 <div id="FAQDiv" style="display: none;">
595                         <h2 class='first'>FAQ</h2>
596
597                         <h3 id="requirement">Server requirements</h3>
598                         <ol>
599                                 <li>A server with <strong>mod_rewrite</strong> enabled</li>
600                                 <li>At least <strong>PHP 5.2</strong></li>
601                                 <li>At least <strong>MYSQL 4.1</strong></li>
602                                 <li><em>Note</em>: YOURLS can also run on <a href="https://github.com/YOURLS/YOURLS/wiki/Nginx-configuration">Nginx</a> and <a href="https://github.com/lylebrown/YOURLS-Cherokee">Cherokee</a></li>
603                         </ol>
604
605                         <h3 id="recommendation">Server recommendations</h3>
606                         <ul>
607                                 <li>PHP <a href="http://www.php.net/curl">CURL extension</a> installed if you plan on playing with the API</li>
608                         </ul>
609                         
610                         <h3 id="limitations">Limitations</h3>
611                         <ul>
612                                 <li>Maximum length of custom keyword is <strong>200 characters</strong></li>
613                                 <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>
614                         </ul>
615                         
616                         <h3 id="base3662">Difference Between Base 36 And Base 62 Encoding</h3>
617                         <ul>
618                                 <li>Base 36 encoding uses <code>0123456789abcdefghijklmnopqrstuvwxyz</code> for short URLs</li>
619                                 <li>Base 62 encoding uses <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz</code></li>
620                                 <li>Stick to one setting, don't change after you've created links as it will change all your short URLs!</li>
621                                 <li>Base 36 is the default and should be picked if you're not sure.</li>
622                         </ul>
623                         
624                         <h3 id="shortdomain">Getting a short domain name for your YOURLS install</h3>
625                         <ul>
626                                 <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>
627                                 <li><a href="http://domai.nr/">Domainr</a> is a fun search tool that might inspire and help you</li>
628                                 <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>
629                         </ul>
630
631                         <h3 id="htaccess">YOURLS needs its own .htaccess</h3>
632                         <ul>
633                                 <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>
634                                 <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>
635                         </ul>
636                         
637                         <h3 id="does404">If YOURLS generates 404 for your short URLs</h3>
638                         <ul>
639                                 <li>Make sure <strong>mod_rewrite</strong> is enabled with your Apache server</li>
640                                 <li>Make sure your .htaccess file looks like <a href="http://yourls.org/htaccess">this one</a></li>
641                                 <li>Eventually, check your server Apache configuration allows use of .htaccess (<tt>AllowOverride All</tt> directive, ask your server admin)</li>
642                         </ul>
643                         
644                         <h3 id="sequential">Random versus sequential short URLs</h3>
645                         <ul>
646                                 <li>Out of the box, YOURLS generates sequential short URLS (ie <code>ab31</code>, then <code>ab32</code> and so on)</li>
647                                 <li>If you prefer random short URLs (ie <code>j3kz1</code> then <code>13hz7</code> like Bitly does), just activate the plugin that comes with YOURLS.</li>
648                         </ul>
649                         
650                         <h3 id="noindex">There is no index page at the root of the install</h3>
651                         <ul>
652                                 <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>
653                                 <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>
654                         </ul>
655                         
656                         <h3 id="lowercase">Uppercase letters in short URLs are eaten up, eg "<code>OmgOzh</code>" becomes "<code>mgzh</code>" !</h3>
657                         <ul>
658                                 <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>
659                                 <li>If you want to force lowercase, you'll need a <a href="http://yourls.org/pluginlist">plugin</a>.</li>
660                         </ul>
661                         
662                         <h3 id="feedback">Feedback, feature requests and bug reporting</h3>
663                         <ol>
664                                 <li>Please don't get in touch directly by mail or Twitter. <a href="http://yourls.org/support">Please</a>.</li>
665                                 <li>Check the <a href="http://yourls.org/roadmap">Road Map</a> for future features.</li>
666                                 <li>Read all the <a href="http://yourls.org/wiki">wiki documents</a>.</li>
667                                 <li>Search in all the <a href="http://yourls.org/issues">issues</a>, open and closed.</li>
668                                 <li>Eventually raise a new issue. To do so, please read the <a href="http://yourls.org/contribute">contribute guidelines</a>. Thanks!</li>
669                         </ol>
670
671                 </div>
672                 
673                 
674                 <!-- More -->   
675                 <div id="MoreDiv" style="display: none;">
676                 
677                         <h2 class='first'>Community</h2>
678                         
679                         <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>
680                         
681                         <h3 id="ressources">Resources</h3>
682                         <ul>
683                                 <li>The official <a href="http://blog.yourls.org">YOURLS blog</a>, for news, hints and showcase.</li>
684                                 <li>The <a href="http://yourls.org/wiki">wiki</a>: advanced documentation, plugins, tips and more</li>
685                                 <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>
686                         </ul>
687                 
688                         <h2 id="showcase">Showcase</h2>
689
690                         <h3>Here are a few examples of sites running YOURLS with a unique design or concept</h3>
691                         <ul>
692                                 <li><a href="http://oe.cd/">http://oe.cd/</a><br/>
693                                 OECD's internal URL shortener with a neat interface and private features</li>
694                                 
695                                 <li><a href="http://tini.link/">http://tini.link/</a><br/>
696                                 A fun top level domain and a very nicely designed YOURLS public interface</li>
697                                 
698                                 <li><a href="http://xib.me/">http://xib.me/</a></br/>
699                                 A nicely styled YOURLS public interface</li>
700                                 
701                                 <li><a href="http://vt802.us/">http://vt802.us/</a><br/>
702                                 Defined as "The World's First Vermont-centric URL Shortener"</li>
703                                 
704                                 <li><a href="http://yourwish.es/">http://yourwish.es/</a><br/>
705                                 Easily share an Amazon wishlist</li>
706                                 
707                                 <li><a href="http://vbly.us">http://vbly.us</a><br/>
708                                 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>
709                         </ul>
710                         
711                         <h2 id="frameworks">YOURLS and other platforms or frameworks</h2>
712                         <ul>            
713                                 <li id="wordpress"><a href="http://wordpress.org/extend/plugins/search.php?q=yourls">WordPress</a><br/>
714                                 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>
715                                 
716                                 <li id="drupal"><a href="http://drupal.org/project/yourls">Drupal</a><br/>
717                                 Allows for the automatic creation of short urls using a YOURLS installation</li>
718                                 
719                                 <li id="perl"><a href="http://github.com/pjain/WWW-Shorten-Yourls">Perl</a><br/>
720                                 WWW-Shorten-Yourls is a Perl module to shorten URLs using YOURLS</li>
721                                 
722                                 <li id="ruby"><a href="https://github.com/threestage/yourls">Ruby</a><br/>
723                                 A Ruby wrapper for the YOURLS API</li>
724                                 
725                                 <li id="python"><a href="http://tflink.github.com/python-yourls/">Python</a><br/>
726                                 A Python client for YOURLS</li>
727                                 
728                                 <li id="vbnet"><a href="http://www.nugardt.com/open-source/yourls-api/">VB .Net</a><br/>
729                                 A VB .Net 4.0 wrapper for the YOURLS API</li>
730                                 
731                                 <li id="javascript"><a href="http://neocotic.com/yourls-api/">Javascript</a><br/>
732                                 JavaScript bindings for the YOURLS API to leverage JSONP support</li>
733
734                                 <li id="cake"><a href="https://github.com/driflash/CakePHP-YOURLS-Plugin">CakePHP</a><br/>
735                                 Plugin which integrates CakePHP with Yourls</li>
736                                 
737                                 <li id="statusnet"><a href="https://github.com/rthees/yourls-status-net">status.net</a><br/>
738                                 A plugin for status.net to use YOURLS</li>
739                                 
740                                 <li id="sharetronix"><a href="http://developer.sharetronix.com/mpview/12/tag:yourls">Sharetronix</a><br/>
741                                 A YOURLS addon for Sharetronix</li>
742                                 
743                         </ul>
744                                 
745                         <h2>YOURLS works with your favorite sofware or device</h2>
746                         <ul>
747                                 <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/>
748                                 How to set up Tweetie2 so it uses your own service</li>
749                                 
750                                 <li id="tweetbot"><a href="http://2fatdads.com/2012/02/how-to-make-yourls-org-work-in-tweetbot/">Tweetbot</a><br/>
751                                 Make Tweetbot run with YOURLS</li>
752                                 
753                                 <li id="twitterfeed"><a href="http://blog.yourls.org/2011/09/how-to-use-twitterfeed-with-your-custom-yourls-url-shortener/">Twitterfeed</a><br/>
754                                 Use Twitterfeed with YOURLS</li>
755
756                                 <li id="mac"><a href="http://timi.im/app/">Mac Client</a><br/>
757                                 Simple app to have a global keyboard shortcut send a link to YOURLS</li>
758
759                                 <li id="android">Android: <a href="https://play.google.com/store/apps/details?id=de.mateware.ayourls">aYourls</a>, <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/>
760                                 Android apps that plays nice with YOURLS</li>
761
762                                 <li id="iphone">iOS: <a href="http://adamdehaven.com/blog/2015/05/shorttail-for-yourls-an-elegant-yourls-client-for-iphone/">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/>
763                                 Apps to use YOURLS on iPhones and iPads</li>
764
765                                 <li id="chrome"><a href="https://github.com/ukoms/Chrourls">Chrourls</a><br/>
766                                 Google Chrome quick link shortening addon for YOURLS</li>
767
768                                 <li id="firefox"><a href="https://addons.mozilla.org/en-us/firefox/addon/yourls-shortener/">Firefox Addon</a><br/>
769                                 Firefox Addon for YOURLS</li>
770
771                                 <li id="textexpander"><a href="http://www.chrismarquardt.com/blog.php?id=7952283233607249761">Textexpander and YOURLS</a><br/>
772                                 Making YOURLS and Textexpander on the Mac play together</li>
773                         </ul>
774
775                         <h2 id="morestuff">More stuff to do with YOURLS</h2>
776                         <ul>
777                                 
778                                 <li><a href="https://github.com/tomslominski/infinity-squared">Infinity Squared</a><br/>
779                                 &#8734;&sup2; is a public page theme for YOURLS to help you design your own public interface</li>
780                                 
781                                 <li><a href="https://github.com/Flynntes/Sleeky">Sleeky</a><br/>
782                                 Sleeky is another public page theme for YOURLS</li>
783                                 
784                                 <li><a href="https://github.com/ScottHelme/yourls-index-page">Scott Helme's page</a><br/>
785                                 Example index page listing all the URLs held in a YOURLS database</li>
786                                 
787                                 <li><a href="http://screenr.com/nTs">http://screenr.com/nTs</a><br/>
788                                 A screencast explaining how to setup YOURLS</li>
789                                 
790                                 <li><a href="http://v007.me/836">YOURLS: Short URL Widget</a><br/>
791                                 Creates a fully configurable widget that outputs the short URL to the current post or page</li>
792                                 
793                                 <li><a href="http://foolrulez.org/blog/2009/09/yourls-widget-released">YOURLS Widget for WordPress</a><br/>
794                                 This widget adds a convenient short URL service into your sidebar. Check the above link for a live example</li>
795                                 
796                                 <li><a href="http://www.stewartallen.org/2010/08/yourls-twitter-tools-wordpress-plugin/">Twitter Tools & YOURLS</a><br/>
797                                 Companion plugin for Alex King's Twitter Tool for WordPress, that enables YOURLS support</li>
798                                 
799                                 <li><a href="http://code.google.com/p/yourls/issues/detail?id=137">Export URLS as text list</a><br/>
800                                 A simple script to list all URLs, one per line, in plain text (for using as an indexer config file, for example)</li>
801                                 
802                                 <li>YOURLS featured on <a href="http://lifehacker.com/5335216/make-your-own-url-shortening-service">Lifehacker</a></li>
803                         </ul>
804
805                         <h2>"Celebrity endorsements", sort of.</h2>
806                         <ul>
807                                 
808                                 <li><a href="http://smashed.by/">http://smashed.by/</a> by <a href="http://smashingmagazine.com/">Smashing Magazine</a></li>
809                 
810                                 <li><a href="http://oe.cd/">http://oe.cd/</a> by <a href="http://www.oecd.org/">the OECD</a></li>
811
812                                 <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>
813
814                                 <li><a href="http://virg.in/">http://virg.in/</a> for the <a href="http://www.virgin.com/">Virgin Group companies</a></li>
815                 
816                                 <li><a href="http://dhurl.org/">http://dhurl.org/</a> by <a href="http://yourls.org/dreamhost">Dreamhost</a></li>
817
818                                 <li><a href="http://ithem.es/">http://ithem.es/</a> by <a href="http://www.ithemes.com/">iThemes</a></li>
819                                 
820                                 <li><a href="https://rho.st/">https://rho.st/</a> by <a href="https://www.rosehosting.com/">RoseHosting.com</a></li>
821                                 
822                         </ul>
823                                 
824                                 
825                 </div>
826         </div> <!-- content -->
827         </main>
828 </div> <!-- container -->
829
830 <div id="fade"></div>
831
832         <script type="text/javascript">
833         /* <![CDATA[*/
834         // Dynamically get tabs
835         function getTabs() {
836                 var d = document.getElementById('Tabs');
837                 var matches = d.innerHTML.match(/<li.* id="(.+?)Tab"/g);
838                 var tabs = []
839                 for (i in matches) {
840                   tabs[i]= matches[i].replace(/<li.* id="/,'').replace('Tab"', '');
841                 }
842                 tabs = tabs.reverse();
843                 return (tabs)
844         }
845         // Scroll to ?anchor
846         // window.location.hash
847         
848         // Toggle tab display
849         function toggle(el) {
850                 var hashes = el.toString().replace(/^.*?#/, '').split('#');
851                 var target = hashes[0];
852                 var anchor = hashes[1];
853                 // If tab doesn't exist, exit
854                 if( tabs.indexOf( target ) == -1 )
855                         return;
856                 for (var tab in tabs) {
857                         // reinit tabs
858                         document.getElementById(tabs[tab]+'Tab').className = 'Tab';
859                         // reinit divs
860                         document.getElementById(tabs[tab]+'Div').style.display= 'none';
861                 }
862                 // highlight & display target
863                 document.getElementById(target+'Div').style.display = 'block';
864                 document.getElementById(target+'Tab').className = 'SelectedTab';
865                 randbg();
866                 try { el.blur(); } catch(err) {}
867                 // Try scrolling to anchor
868                 try {
869                         window.scroll(0,findPos(document.getElementById(anchor)));
870                 } catch(err) { window.location.hash = target; }
871         }
872         // Get tab list
873         var tabs = getTabs();
874         // On page load/refresh display required tab
875         if (location.hash) {
876                 toggle(location.hash);
877         }
878         // Background fancyness
879         function randbg(){
880                 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' ];
881                 var bg = rndbg[ Math.floor( Math.random() * rndbg.length ) ];
882                 document.body.style.background='#E3F3FF url(user/plugins/random-bg/img/'+bg+')';
883         };
884         randbg();
885         //Finds y value of given object
886         function findPos(obj) {
887                 var curtop = 0;
888                 if (obj.offsetParent) {
889                         do {
890                                 curtop += obj.offsetTop;
891                         } while (obj = obj.offsetParent);
892                 curtop = curtop - 30;
893                 return [curtop];
894                 }
895         }
896         /* ]]> */
897         </script>
898
899
900 </body>
901 </html>