doc/html/FAQ/index.html

   1 <!DOCTYPE html>
   2 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
   3 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
   4 <head>
   5   <meta charset="utf-8">
   6   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   7   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   8
   9
  10   <link rel="shortcut icon" href="../img/favicon.ico">
  11   <title>FAQ - Shaarli Documentation</title>
  12   <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
  13
  14   <link rel="stylesheet" href="../css/theme.css" type="text/css" />
  15   <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
  16   <link rel="stylesheet" href="../css/highlight.css">
  17   <link href="../github-markdown.css" rel="stylesheet">
  18
  19   <script>
  20     // Current page data
  21     var mkdocs_page_name = "FAQ";
  22     var mkdocs_page_input_path = "FAQ.md";
  23     var mkdocs_page_url = "/FAQ/";
  24   </script>
  25
  26   <script src="../js/jquery-2.1.1.min.js"></script>
  27   <script src="../js/modernizr-2.8.3.min.js"></script>
  28   <script type="text/javascript" src="../js/highlight.pack.js"></script>
  29
  30 </head>
  31
  32 <body class="wy-body-for-nav" role="document">
  33
  34   <div class="wy-grid-for-nav">
  35
  36
  37     <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
  38       <div class="wy-side-nav-search">
  39         <a href=".." class="icon icon-home"> Shaarli Documentation</a>
  40         <div role="search">
  41   <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
  42     <input type="text" name="q" placeholder="Search docs" />
  43   </form>
  44 </div>
  45       </div>
  46
  47       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  48         <ul class="current">
  49
  50
  51             <li class="toctree-l1">
  52
  53     <a class="" href="..">Home</a>
  54             </li>
  55
  56             <li class="toctree-l1">
  57
  58     <span class="caption-text">Setup</span>
  59     <ul class="subnav">
  60                 <li class="">
  61
  62     <a class="" href="../Download-and-Installation/">Download and Installation</a>
  63                 </li>
  64                 <li class="">
  65
  66     <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
  67                 </li>
  68                 <li class="">
  69
  70     <a class="" href="../Server-requirements/">Server requirements</a>
  71                 </li>
  72                 <li class="">
  73
  74     <a class="" href="../Server-configuration/">Server configuration</a>
  75                 </li>
  76                 <li class="">
  77
  78     <a class="" href="../Server-security/">Server security</a>
  79                 </li>
  80                 <li class="">
  81
  82     <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
  83                 </li>
  84                 <li class="">
  85
  86     <a class="" href="../Plugins/">Plugins</a>
  87                 </li>
  88     </ul>
  89             </li>
  90
  91             <li class="toctree-l1">
  92
  93     <span class="caption-text">Docker</span>
  94     <ul class="subnav">
  95                 <li class="">
  96
  97     <a class="" href="../Docker-101/">Docker 101</a>
  98                 </li>
  99                 <li class="">
 100
 101     <a class="" href="../Shaarli-images/">Shaarli images</a>
 102                 </li>
 103                 <li class="">
 104
 105     <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
 106                 </li>
 107                 <li class="">
 108
 109     <a class="" href="../Docker-resources/">Docker resources</a>
 110                 </li>
 111     </ul>
 112             </li>
 113
 114             <li class="toctree-l1">
 115
 116     <span class="caption-text">Usage</span>
 117     <ul class="subnav">
 118                 <li class="">
 119
 120     <a class="" href="../Features/">Features</a>
 121                 </li>
 122                 <li class="">
 123
 124     <a class="" href="../Bookmarklet/">Bookmarklet</a>
 125                 </li>
 126                 <li class="">
 127
 128     <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
 129                 </li>
 130                 <li class="">
 131
 132     <a class="" href="../Firefox-share/">Firefox share</a>
 133                 </li>
 134                 <li class="">
 135
 136     <a class="" href="../RSS-feeds/">RSS feeds</a>
 137                 </li>
 138                 <li class="">
 139
 140     <a class="" href="../REST-API/">REST API</a>
 141                 </li>
 142     </ul>
 143             </li>
 144
 145             <li class="toctree-l1">
 146
 147     <span class="caption-text">How To</span>
 148     <ul class="subnav">
 149                 <li class="">
 150
 151     <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
 152                 </li>
 153                 <li class="">
 154
 155     <a class="" href="../Various-hacks/">Various hacks</a>
 156                 </li>
 157     </ul>
 158             </li>
 159
 160             <li class="toctree-l1">
 161
 162     <a class="" href="../Troubleshooting/">Troubleshooting</a>
 163             </li>
 164
 165             <li class="toctree-l1">
 166
 167     <span class="caption-text">Development</span>
 168     <ul class="subnav">
 169                 <li class="">
 170
 171     <a class="" href="../Development-guidelines/">Development guidelines</a>
 172                 </li>
 173                 <li class="">
 174
 175     <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
 176                 </li>
 177                 <li class="">
 178
 179     <a class="" href="../GnuPG-signature/">GnuPG signature</a>
 180                 </li>
 181                 <li class="">
 182
 183     <a class="" href="../Coding-guidelines/">Coding guidelines</a>
 184                 </li>
 185                 <li class="">
 186
 187     <a class="" href="../Directory-structure/">Directory structure</a>
 188                 </li>
 189                 <li class="">
 190
 191     <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
 192                 </li>
 193                 <li class="">
 194
 195     <a class="" href="../Plugin-System/">Plugin System</a>
 196                 </li>
 197                 <li class="">
 198
 199     <a class="" href="../Release-Shaarli/">Release Shaarli</a>
 200                 </li>
 201                 <li class="">
 202
 203     <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
 204                 </li>
 205                 <li class="">
 206
 207     <a class="" href="../Security/">Security</a>
 208                 </li>
 209                 <li class="">
 210
 211     <a class="" href="../Static-analysis/">Static analysis</a>
 212                 </li>
 213                 <li class="">
 214
 215     <a class="" href="../Theming/">Theming</a>
 216                 </li>
 217                 <li class="">
 218
 219     <a class="" href="../Unit-tests/">Unit tests</a>
 220                 </li>
 221     </ul>
 222             </li>
 223
 224             <li class="toctree-l1">
 225
 226     <span class="caption-text">About</span>
 227     <ul class="subnav">
 228                 <li class=" current">
 229
 230     <a class="current" href="./">FAQ</a>
 231     <ul class="subnav">
 232
 233     <li class="toctree-l3"><a href="#why-did-you-create-shaarli">Why did you create Shaarli ?</a></li>
 234
 235
 236     <li class="toctree-l3"><a href="#why-use-shaarli-and-not-deliciousdiigo">Why use Shaarli and not Delicious/Diigo ?</a></li>
 237
 238
 239     <li class="toctree-l3"><a href="#what-does-shaarli-mean">What does Shaarli mean?</a></li>
 240
 241
 242     <li class="toctree-l3"><a href="#my-shaarli-is-broken">My Shaarli is broken!</a></li>
 243
 244
 245     <li class="toctree-l3"><a href="#why-not-use-a-real-database-files-are-slow">Why not use a real database? Files are slow!</a></li>
 246
 247
 248     </ul>
 249                 </li>
 250                 <li class="">
 251
 252     <a class="" href="../Community-&-Related-software/">Community & Related software</a>
 253                 </li>
 254     </ul>
 255             </li>
 256
 257         </ul>
 258       </div>
 259       &nbsp;
 260     </nav>
 261
 262     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 263
 264
 265       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 266         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 267         <a href="..">Shaarli Documentation</a>
 268       </nav>
 269
 270
 271       <div class="wy-nav-content">
 272         <div class="rst-content">
 273           <div role="navigation" aria-label="breadcrumbs navigation">
 274   <ul class="wy-breadcrumbs">
 275     <li><a href="..">Docs</a> &raquo;</li>
 276
 277
 278
 279           <li>About &raquo;</li>
 280
 281
 282
 283     <li>FAQ</li>
 284     <li class="wy-breadcrumbs-aside">
 285
 286         <a href="https://github.com/shaarli/Shaarli/edit/master/docs/FAQ.md"
 287           class="icon icon-github"> Edit on GitHub</a>
 288
 289     </li>
 290   </ul>
 291   <hr/>
 292 </div>
 293           <div role="main">
 294             <div class="section">
 295
 296                 <h3 id="why-did-you-create-shaarli">Why did you create Shaarli ?</h3>
 297 <p>I was a StumbleUpon user. Then I got fed up with they big toolbar. I switched to delicious, which was lighter, faster and more beautiful. Until Yahoo bought it. Then the export API broke all the time, delicious became slow and was ditched by Yahoo. I switched to Diigo, which is not bad, but does too much. And Diigo is sslllooooowww and their Firefox extension a bit buggy. And… oh… <strong>their Firefox addon sends to Diigo every single URL you visit</strong> (Don't believe me ? Use <a href="https://addons.mozilla.org/en-US/firefox/addon/tamper-data/">Tamper Data</a> and open any page).</p>
 298 <p>Enough is enough. Saving simple links should not be a complicated heavy thing. I ditched them all and wrote my own: Shaarli. It's simple, but it does the job and does it well. And my data is not hosted on a foreign server, but on my server.</p>
 299 <h3 id="why-use-shaarli-and-not-deliciousdiigo">Why use Shaarli and not Delicious/Diigo ?</h3>
 300 <p>With Shaarli:</p>
 301 <ul>
 302 <li>The data is yours: It's hosted on your server.</li>
 303 <li>Never fear of having your data locked-in.</li>
 304 <li>Never fear to have your data sold to third party.</li>
 305 <li>Your private links are not hosted on a third party server.</li>
 306 <li>You are not tracked by browser addons (like Diigo does)</li>
 307 <li>You can change the look and feel of the pages if you want.</li>
 308 <li>You can change the behaviour of the program.</li>
 309 <li>It's magnitude faster than most bookmarking services.</li>
 310 </ul>
 311 <h3 id="what-does-shaarli-mean">What does Shaarli mean?</h3>
 312 <p>Shaarli is for shaaring your links.</p>
 313 <h3 id="my-shaarli-is-broken">My Shaarli is broken!</h3>
 314 <p>First of all, ensure that both the <a href="../Server-configuration">web server</a> and <a href="../Shaarli-configuration">Shaarli</a> are correctly configured, and that your installation is <a href="../Server-requirements">supported</a>.</p>
 315 <p>If everything looks right but the issue(s) remain(s), please:
 316 - take a look at the <a href="../Troubleshooting">troubleshooting</a> section
 317 - come <a href="https://gitter.im/shaarli/Shaarli">chat with us</a> on Gitter, we'll be happy to help ;-)
 318 - browse active <a href="https://github.com/shaarli/Shaarli/issues">issues</a> and <a href="https://github.com/shaarli/Shaarli/pulls">Pull Requests</a>
 319     - if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup)
 320     - else, <a href="https://github.com/shaarli/Shaarli/issues/new">open a new issue</a>, and provide information about the problem:
 321         - <em>what happens?</em> - display glitches, invalid data, security flaws...
 322         - <em>what is your configuration?</em>  - OS, server version, activated extensions, web browser...
 323         - <em>is it reproducible?</em></p>
 324 <h3 id="why-not-use-a-real-database-files-are-slow">Why not use a real database? Files are slow!</h3>
 325 <p>Does browsing <a href="http://sebsauvage.net/links/">this page</a> feel slow? Try browsing older pages, too.</p>
 326 <p>It's not slow at all, is it? And don't forget the database contains more than 16000 links, and it's on a shared host, with 32000 visitors/day for my website alone. And it's still damn fast. Why?</p>
 327 <p>The data file is only 3.7 Mb. It's read 99% of the time, and is probably already in the operation system disk cache. So generating a page involves no I/O at all most of the time.</p>
 328
 329             </div>
 330           </div>
 331           <footer>
 332
 333     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 334
 335         <a href="../Community-&-Related-software/" class="btn btn-neutral float-right" title="Community & Related software">Next <span class="icon icon-circle-arrow-right"></span></a>
 336
 337
 338         <a href="../Unit-tests/" class="btn btn-neutral" title="Unit tests"><span class="icon icon-circle-arrow-left"></span> Previous</a>
 339
 340     </div>
 341
 342
 343   <hr/>
 344
 345   <div role="contentinfo">
 346     <!-- Copyright etc -->
 347
 348   </div>
 349
 350   Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 351 </footer>
 352
 353         </div>
 354       </div>
 355
 356     </section>
 357
 358   </div>
 359
 360   <div class="rst-versions" role="note" style="cursor: pointer">
 361     <span class="rst-current-version" data-toggle="rst-current-version">
 362
 363           <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
 364
 365
 366         <span><a href="../Unit-tests/" style="color: #fcfcfc;">&laquo; Previous</a></span>
 367
 368
 369         <span style="margin-left: 15px"><a href="../Community-&-Related-software/" style="color: #fcfcfc">Next &raquo;</a></span>
 370
 371     </span>
 372 </div>
 373     <script src="../js/theme.js"></script>
 374
 375 </body>
 376 </html>