FAQ.html 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="generator" content="pandoc">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
  7. <title>Shaarli - FAQ</title>
  8. <style type="text/css">code{white-space: pre;}</style>
  9. <!--[if lt IE 9]>
  10. <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
  11. <![endif]-->
  12. <link rel="stylesheet" href="github-markdown.css">
  13. </head>
  14. <body>
  15. <div id="local-sidebar">
  16. <ul>
  17. <li><a href="Home.html">Home</a></li>
  18. <li>Installation
  19. <ul>
  20. <li><a href="Download.html">Download</a></li>
  21. <li><a href="Server-requirements.html">Server requirements</a></li>
  22. <li><a href="Server-configuration.html">Server configuration</a></li>
  23. <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
  24. </ul></li>
  25. <li><a href="Usage.html">Usage</a>
  26. <ul>
  27. <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
  28. <li><a href="Firefox-share.html">Firefox share</a></li>
  29. <li><a href="RSS-feeds.html">RSS feeds</a></li>
  30. </ul></li>
  31. <li>How To
  32. <ul>
  33. <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
  34. <li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
  35. <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
  36. <li><a href="Datastore-hacks.html">Datastore hacks</a></li>
  37. </ul></li>
  38. <li><a href="Troubleshooting.html">Troubleshooting</a></li>
  39. <li><a href="Development.html">Development</a>
  40. <ul>
  41. <li><a href="GnuPG-signature.html">GnuPG signature</a></li>
  42. <li><a href="Coding-guidelines.html">Coding guidelines</a></li>
  43. <li><a href="Directory-structure.html">Directory structure</a></li>
  44. <li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
  45. <li><a href="Plugin-System.html">Plugin System</a></li>
  46. <li><a href="Security.html">Security</a></li>
  47. <li><a href="Static-analysis.html">Static analysis</a></li>
  48. <li><a href="Theming.html">Theming</a></li>
  49. <li><a href="Unit-tests.html">Unit tests</a></li>
  50. </ul></li>
  51. <li>About
  52. <ul>
  53. <li><a href="FAQ.html">FAQ</a></li>
  54. <li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
  55. <li><a href="TODO.html">TODO</a></li>
  56. </ul></li>
  57. </ul>
  58. </div>
  59. <h1 id="faq">FAQ</h1>
  60. <h3 id="why-did-you-create-shaarli">Why did you create Shaarli ?</h3>
  61. <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).<a href=".html"></a></p>
  62. <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>
  63. <h3 id="why-use-shaarli-and-not-deliciousdiigo">Why use Shaarli and not Delicious/Diigo ?</h3>
  64. <p>With Shaarli:</p>
  65. <ul>
  66. <li>The data is yours: It's hosted on your server.</li>
  67. <li>Never fear of having your data locked-in.</li>
  68. <li>Never fear to have your data sold to third party.</li>
  69. <li>Your private links are not hosted on a third party server.</li>
  70. <li>You are not tracked by browser addons (like Diigo does)</li>
  71. <li>You can change the look and feel of the pages if you want.</li>
  72. <li>You can change the behaviour of the program.</li>
  73. <li>It's magnitude faster than most bookmarking services.</li>
  74. </ul>
  75. <h3 id="what-does-shaarli-mean">What does Shaarli mean?</h3>
  76. <p>Shaarli is for shaaring your links.</p>
  77. <h3 id="my-shaarli-is-broken">My Shaarli is broken!</h3>
  78. <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>.<a href=".html"></a></p>
  79. <p>If everything looks right but the issue(s) remain(s), please:</p>
  80. <ul>
  81. <li>take a look at the <a href="Troubleshooting">troubleshooting</a> section<a href=".html"></a></li>
  82. <li>come <a href="https://gitter.im/shaarli/Shaarli">chat with us</a> on Gitter, we'll be happy to help ;-)<a href=".html"></a></li>
  83. <li>browse active <a href="https://github.com/shaarli/Shaarli/issues">issues</a> and <a href="https://github.com/shaarli/Shaarli/pulls">Pull Requests</a><a href=".html"></a>
  84. <ul>
  85. <li>if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup)</li>
  86. <li>else, <a href="https://github.com/shaarli/Shaarli/issues/new">open a new issue</a>, and provide information about the problem:<a href=".html"></a>
  87. <ul>
  88. <li><em>what happens?</em> - display glitches, invalid data, security flaws...</li>
  89. <li><em>what is your configuration?</em> - OS, server version, activated extensions, web browser...</li>
  90. <li><em>is it reproducible?</em></li>
  91. </ul></li>
  92. </ul></li>
  93. </ul>
  94. <h3 id="why-not-use-a-real-database-files-are-slow">Why not use a real database? Files are slow!</h3>
  95. <p>Does browsing <a href="http://sebsauvage.net/links/">this page</a> feel slow? Try browsing older pages, too.<a href=".html"></a></p>
  96. <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>
  97. <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>
  98. </body>
  99. </html>