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