index.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376
  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. <link rel="shortcut icon" href="../img/favicon.ico">
  9. <title>FAQ - Shaarli Documentation</title>
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
  11. <link rel="stylesheet" href="../css/theme.css" type="text/css" />
  12. <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
  13. <link rel="stylesheet" href="../css/highlight.css">
  14. <link href="../github-markdown.css" rel="stylesheet">
  15. <script>
  16. // Current page data
  17. var mkdocs_page_name = "FAQ";
  18. var mkdocs_page_input_path = "FAQ.md";
  19. var mkdocs_page_url = "/FAQ/";
  20. </script>
  21. <script src="../js/jquery-2.1.1.min.js"></script>
  22. <script src="../js/modernizr-2.8.3.min.js"></script>
  23. <script type="text/javascript" src="../js/highlight.pack.js"></script>
  24. </head>
  25. <body class="wy-body-for-nav" role="document">
  26. <div class="wy-grid-for-nav">
  27. <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
  28. <div class="wy-side-nav-search">
  29. <a href=".." class="icon icon-home"> Shaarli Documentation</a>
  30. <div role="search">
  31. <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
  32. <input type="text" name="q" placeholder="Search docs" />
  33. </form>
  34. </div>
  35. </div>
  36. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  37. <ul class="current">
  38. <li class="toctree-l1">
  39. <a class="" href="..">Home</a>
  40. </li>
  41. <li class="toctree-l1">
  42. <span class="caption-text">Setup</span>
  43. <ul class="subnav">
  44. <li class="">
  45. <a class="" href="../Download-and-Installation/">Download and Installation</a>
  46. </li>
  47. <li class="">
  48. <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
  49. </li>
  50. <li class="">
  51. <a class="" href="../Server-requirements/">Server requirements</a>
  52. </li>
  53. <li class="">
  54. <a class="" href="../Server-configuration/">Server configuration</a>
  55. </li>
  56. <li class="">
  57. <a class="" href="../Server-security/">Server security</a>
  58. </li>
  59. <li class="">
  60. <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
  61. </li>
  62. <li class="">
  63. <a class="" href="../Plugins/">Plugins</a>
  64. </li>
  65. </ul>
  66. </li>
  67. <li class="toctree-l1">
  68. <span class="caption-text">Docker</span>
  69. <ul class="subnav">
  70. <li class="">
  71. <a class="" href="../docker/docker-101/">Docker 101</a>
  72. </li>
  73. <li class="">
  74. <a class="" href="../docker/shaarli-images/">Shaarli images</a>
  75. </li>
  76. <li class="">
  77. <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
  78. </li>
  79. <li class="">
  80. <a class="" href="../docker/resources/">Docker resources</a>
  81. </li>
  82. </ul>
  83. </li>
  84. <li class="toctree-l1">
  85. <span class="caption-text">Usage</span>
  86. <ul class="subnav">
  87. <li class="">
  88. <a class="" href="../Features/">Features</a>
  89. </li>
  90. <li class="">
  91. <a class="" href="../Bookmarklet/">Bookmarklet</a>
  92. </li>
  93. <li class="">
  94. <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
  95. </li>
  96. <li class="">
  97. <a class="" href="../Firefox-share/">Firefox share</a>
  98. </li>
  99. <li class="">
  100. <a class="" href="../RSS-feeds/">RSS feeds</a>
  101. </li>
  102. <li class="">
  103. <a class="" href="../REST-API/">REST API</a>
  104. </li>
  105. </ul>
  106. </li>
  107. <li class="toctree-l1">
  108. <span class="caption-text">How To</span>
  109. <ul class="subnav">
  110. <li class="">
  111. <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
  112. </li>
  113. <li class="">
  114. <a class="" href="../Various-hacks/">Various hacks</a>
  115. </li>
  116. </ul>
  117. </li>
  118. <li class="toctree-l1">
  119. <a class="" href="../Troubleshooting/">Troubleshooting</a>
  120. </li>
  121. <li class="toctree-l1">
  122. <span class="caption-text">Development</span>
  123. <ul class="subnav">
  124. <li class="">
  125. <a class="" href="../Development-guidelines/">Development guidelines</a>
  126. </li>
  127. <li class="">
  128. <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
  129. </li>
  130. <li class="">
  131. <a class="" href="../GnuPG-signature/">GnuPG signature</a>
  132. </li>
  133. <li class="">
  134. <a class="" href="../Coding-guidelines/">Coding guidelines</a>
  135. </li>
  136. <li class="">
  137. <a class="" href="../Directory-structure/">Directory structure</a>
  138. </li>
  139. <li class="">
  140. <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
  141. </li>
  142. <li class="">
  143. <a class="" href="../Plugin-System/">Plugin System</a>
  144. </li>
  145. <li class="">
  146. <a class="" href="../Release-Shaarli/">Release Shaarli</a>
  147. </li>
  148. <li class="">
  149. <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
  150. </li>
  151. <li class="">
  152. <a class="" href="../Security/">Security</a>
  153. </li>
  154. <li class="">
  155. <a class="" href="../Static-analysis/">Static analysis</a>
  156. </li>
  157. <li class="">
  158. <a class="" href="../Theming/">Theming</a>
  159. </li>
  160. <li class="">
  161. <a class="" href="../Unit-tests/">Unit tests</a>
  162. </li>
  163. </ul>
  164. </li>
  165. <li class="toctree-l1">
  166. <span class="caption-text">About</span>
  167. <ul class="subnav">
  168. <li class=" current">
  169. <a class="current" href="./">FAQ</a>
  170. <ul class="subnav">
  171. <li class="toctree-l3"><a href="#why-did-you-create-shaarli">Why did you create Shaarli ?</a></li>
  172. <li class="toctree-l3"><a href="#why-use-shaarli-and-not-deliciousdiigo">Why use Shaarli and not Delicious/Diigo ?</a></li>
  173. <li class="toctree-l3"><a href="#what-does-shaarli-mean">What does Shaarli mean?</a></li>
  174. <li class="toctree-l3"><a href="#my-shaarli-is-broken">My Shaarli is broken!</a></li>
  175. <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>
  176. </ul>
  177. </li>
  178. <li class="">
  179. <a class="" href="../Community-&-Related-software/">Community & Related software</a>
  180. </li>
  181. </ul>
  182. </li>
  183. </ul>
  184. </div>
  185. &nbsp;
  186. </nav>
  187. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  188. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  189. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  190. <a href="..">Shaarli Documentation</a>
  191. </nav>
  192. <div class="wy-nav-content">
  193. <div class="rst-content">
  194. <div role="navigation" aria-label="breadcrumbs navigation">
  195. <ul class="wy-breadcrumbs">
  196. <li><a href="..">Docs</a> &raquo;</li>
  197. <li>About &raquo;</li>
  198. <li>FAQ</li>
  199. <li class="wy-breadcrumbs-aside">
  200. <a href="https://github.com/shaarli/Shaarli/edit/master/docs/FAQ.md"
  201. class="icon icon-github"> Edit on GitHub</a>
  202. </li>
  203. </ul>
  204. <hr/>
  205. </div>
  206. <div role="main">
  207. <div class="section">
  208. <h3 id="why-did-you-create-shaarli">Why did you create Shaarli ?</h3>
  209. <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>
  210. <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>
  211. <h3 id="why-use-shaarli-and-not-deliciousdiigo">Why use Shaarli and not Delicious/Diigo ?</h3>
  212. <p>With Shaarli:</p>
  213. <ul>
  214. <li>The data is yours: It's hosted on your server.</li>
  215. <li>Never fear of having your data locked-in.</li>
  216. <li>Never fear to have your data sold to third party.</li>
  217. <li>Your private links are not hosted on a third party server.</li>
  218. <li>You are not tracked by browser addons (like Diigo does)</li>
  219. <li>You can change the look and feel of the pages if you want.</li>
  220. <li>You can change the behaviour of the program.</li>
  221. <li>It's magnitude faster than most bookmarking services.</li>
  222. </ul>
  223. <h3 id="what-does-shaarli-mean">What does Shaarli mean?</h3>
  224. <p>Shaarli is for shaaring your links.</p>
  225. <h3 id="my-shaarli-is-broken">My Shaarli is broken!</h3>
  226. <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>
  227. <p>If everything looks right but the issue(s) remain(s), please:
  228. - take a look at the <a href="../Troubleshooting">troubleshooting</a> section
  229. - come <a href="https://gitter.im/shaarli/Shaarli">chat with us</a> on Gitter, we'll be happy to help ;-)
  230. - browse active <a href="https://github.com/shaarli/Shaarli/issues">issues</a> and <a href="https://github.com/shaarli/Shaarli/pulls">Pull Requests</a>
  231. - if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup)
  232. - else, <a href="https://github.com/shaarli/Shaarli/issues/new">open a new issue</a>, and provide information about the problem:
  233. - <em>what happens?</em> - display glitches, invalid data, security flaws...
  234. - <em>what is your configuration?</em> - OS, server version, activated extensions, web browser...
  235. - <em>is it reproducible?</em></p>
  236. <h3 id="why-not-use-a-real-database-files-are-slow">Why not use a real database? Files are slow!</h3>
  237. <p>Does browsing <a href="http://sebsauvage.net/links/">this page</a> feel slow? Try browsing older pages, too.</p>
  238. <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>
  239. <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>
  240. </div>
  241. </div>
  242. <footer>
  243. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  244. <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>
  245. <a href="../Unit-tests/" class="btn btn-neutral" title="Unit tests"><span class="icon icon-circle-arrow-left"></span> Previous</a>
  246. </div>
  247. <hr/>
  248. <div role="contentinfo">
  249. <!-- Copyright etc -->
  250. </div>
  251. 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>.
  252. </footer>
  253. </div>
  254. </div>
  255. </section>
  256. </div>
  257. <div class="rst-versions" role="note" style="cursor: pointer">
  258. <span class="rst-current-version" data-toggle="rst-current-version">
  259. <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
  260. <span><a href="../Unit-tests/" style="color: #fcfcfc;">&laquo; Previous</a></span>
  261. <span style="margin-left: 15px"><a href="../Community-&-Related-software/" style="color: #fcfcfc">Next &raquo;</a></span>
  262. </span>
  263. </div>
  264. <script src="../js/theme.js"></script>
  265. </body>
  266. </html>