diff options
Diffstat (limited to 'doc/html/FAQ/index.html')
-rw-r--r-- | doc/html/FAQ/index.html | 388 |
1 files changed, 388 insertions, 0 deletions
diff --git a/doc/html/FAQ/index.html b/doc/html/FAQ/index.html new file mode 100644 index 00000000..c48e11f8 --- /dev/null +++ b/doc/html/FAQ/index.html | |||
@@ -0,0 +1,388 @@ | |||
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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a> | ||
156 | </li> | ||
157 | <li class=""> | ||
158 | |||
159 | <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a> | ||
160 | </li> | ||
161 | <li class=""> | ||
162 | |||
163 | <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a> | ||
164 | </li> | ||
165 | <li class=""> | ||
166 | |||
167 | <a class="" href="../Datastore-hacks/">Datastore hacks</a> | ||
168 | </li> | ||
169 | </ul> | ||
170 | </li> | ||
171 | |||
172 | <li class="toctree-l1"> | ||
173 | |||
174 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
175 | </li> | ||
176 | |||
177 | <li class="toctree-l1"> | ||
178 | |||
179 | <span class="caption-text">Development</span> | ||
180 | <ul class="subnav"> | ||
181 | <li class=""> | ||
182 | |||
183 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
184 | </li> | ||
185 | <li class=""> | ||
186 | |||
187 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
188 | </li> | ||
189 | <li class=""> | ||
190 | |||
191 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
192 | </li> | ||
193 | <li class=""> | ||
194 | |||
195 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
196 | </li> | ||
197 | <li class=""> | ||
198 | |||
199 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
200 | </li> | ||
201 | <li class=""> | ||
202 | |||
203 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
204 | </li> | ||
205 | <li class=""> | ||
206 | |||
207 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
208 | </li> | ||
209 | <li class=""> | ||
210 | |||
211 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
212 | </li> | ||
213 | <li class=""> | ||
214 | |||
215 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
216 | </li> | ||
217 | <li class=""> | ||
218 | |||
219 | <a class="" href="../Security/">Security</a> | ||
220 | </li> | ||
221 | <li class=""> | ||
222 | |||
223 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
224 | </li> | ||
225 | <li class=""> | ||
226 | |||
227 | <a class="" href="../Theming/">Theming</a> | ||
228 | </li> | ||
229 | <li class=""> | ||
230 | |||
231 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
232 | </li> | ||
233 | </ul> | ||
234 | </li> | ||
235 | |||
236 | <li class="toctree-l1"> | ||
237 | |||
238 | <span class="caption-text">About</span> | ||
239 | <ul class="subnav"> | ||
240 | <li class=" current"> | ||
241 | |||
242 | <a class="current" href="./">FAQ</a> | ||
243 | <ul class="subnav"> | ||
244 | |||
245 | <li class="toctree-l3"><a href="#why-did-you-create-shaarli">Why did you create Shaarli ?</a></li> | ||
246 | |||
247 | |||
248 | <li class="toctree-l3"><a href="#why-use-shaarli-and-not-deliciousdiigo">Why use Shaarli and not Delicious/Diigo ?</a></li> | ||
249 | |||
250 | |||
251 | <li class="toctree-l3"><a href="#what-does-shaarli-mean">What does Shaarli mean?</a></li> | ||
252 | |||
253 | |||
254 | <li class="toctree-l3"><a href="#my-shaarli-is-broken">My Shaarli is broken!</a></li> | ||
255 | |||
256 | |||
257 | <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> | ||
258 | |||
259 | |||
260 | </ul> | ||
261 | </li> | ||
262 | <li class=""> | ||
263 | |||
264 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
265 | </li> | ||
266 | </ul> | ||
267 | </li> | ||
268 | |||
269 | </ul> | ||
270 | </div> | ||
271 | | ||
272 | </nav> | ||
273 | |||
274 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
275 | |||
276 | |||
277 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
278 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
279 | <a href="..">Shaarli Documentation</a> | ||
280 | </nav> | ||
281 | |||
282 | |||
283 | <div class="wy-nav-content"> | ||
284 | <div class="rst-content"> | ||
285 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
286 | <ul class="wy-breadcrumbs"> | ||
287 | <li><a href="..">Docs</a> »</li> | ||
288 | |||
289 | |||
290 | |||
291 | <li>About »</li> | ||
292 | |||
293 | |||
294 | |||
295 | <li>FAQ</li> | ||
296 | <li class="wy-breadcrumbs-aside"> | ||
297 | |||
298 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/FAQ.md" | ||
299 | class="icon icon-github"> Edit on GitHub</a> | ||
300 | |||
301 | </li> | ||
302 | </ul> | ||
303 | <hr/> | ||
304 | </div> | ||
305 | <div role="main"> | ||
306 | <div class="section"> | ||
307 | |||
308 | <h3 id="why-did-you-create-shaarli">Why did you create Shaarli ?</h3> | ||
309 | <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> | ||
310 | <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> | ||
311 | <h3 id="why-use-shaarli-and-not-deliciousdiigo">Why use Shaarli and not Delicious/Diigo ?</h3> | ||
312 | <p>With Shaarli:</p> | ||
313 | <ul> | ||
314 | <li>The data is yours: It's hosted on your server.</li> | ||
315 | <li>Never fear of having your data locked-in.</li> | ||
316 | <li>Never fear to have your data sold to third party.</li> | ||
317 | <li>Your private links are not hosted on a third party server.</li> | ||
318 | <li>You are not tracked by browser addons (like Diigo does)</li> | ||
319 | <li>You can change the look and feel of the pages if you want.</li> | ||
320 | <li>You can change the behaviour of the program.</li> | ||
321 | <li>It's magnitude faster than most bookmarking services.</li> | ||
322 | </ul> | ||
323 | <h3 id="what-does-shaarli-mean">What does Shaarli mean?</h3> | ||
324 | <p>Shaarli is for shaaring your links.</p> | ||
325 | <h3 id="my-shaarli-is-broken">My Shaarli is broken!</h3> | ||
326 | <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> | ||
327 | <p>If everything looks right but the issue(s) remain(s), please: | ||
328 | - take a look at the <a href="../Troubleshooting">troubleshooting</a> section | ||
329 | - come <a href="https://gitter.im/shaarli/Shaarli">chat with us</a> on Gitter, we'll be happy to help ;-) | ||
330 | - browse active <a href="https://github.com/shaarli/Shaarli/issues">issues</a> and <a href="https://github.com/shaarli/Shaarli/pulls">Pull Requests</a> | ||
331 | - if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup) | ||
332 | - else, <a href="https://github.com/shaarli/Shaarli/issues/new">open a new issue</a>, and provide information about the problem: | ||
333 | - <em>what happens?</em> - display glitches, invalid data, security flaws... | ||
334 | - <em>what is your configuration?</em> - OS, server version, activated extensions, web browser... | ||
335 | - <em>is it reproducible?</em></p> | ||
336 | <h3 id="why-not-use-a-real-database-files-are-slow">Why not use a real database? Files are slow!</h3> | ||
337 | <p>Does browsing <a href="http://sebsauvage.net/links/">this page</a> feel slow? Try browsing older pages, too.</p> | ||
338 | <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> | ||
339 | <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> | ||
340 | |||
341 | </div> | ||
342 | </div> | ||
343 | <footer> | ||
344 | |||
345 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
346 | |||
347 | <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> | ||
348 | |||
349 | |||
350 | <a href="../Unit-tests/" class="btn btn-neutral" title="Unit tests"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
351 | |||
352 | </div> | ||
353 | |||
354 | |||
355 | <hr/> | ||
356 | |||
357 | <div role="contentinfo"> | ||
358 | <!-- Copyright etc --> | ||
359 | |||
360 | </div> | ||
361 | |||
362 | 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>. | ||
363 | </footer> | ||
364 | |||
365 | </div> | ||
366 | </div> | ||
367 | |||
368 | </section> | ||
369 | |||
370 | </div> | ||
371 | |||
372 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
373 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
374 | |||
375 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
376 | |||
377 | |||
378 | <span><a href="../Unit-tests/" style="color: #fcfcfc;">« Previous</a></span> | ||
379 | |||
380 | |||
381 | <span style="margin-left: 15px"><a href="../Community-&-Related-software/" style="color: #fcfcfc">Next »</a></span> | ||
382 | |||
383 | </span> | ||
384 | </div> | ||
385 | <script src="../js/theme.js"></script> | ||
386 | |||
387 | </body> | ||
388 | </html> | ||