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]-->
6 <meta http-equiv=
"X-UA-Compatible" content=
"IE=edge">
7 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
8 <meta name=
"description" content=
"The personal, minimalist, super-fast, database free, bookmarking service">
10 <link rel=
"shortcut icon" href=
"./img/favicon.ico">
11 <title>Home - 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'
>
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">
21 var mkdocs_page_name = "Home";
22 var mkdocs_page_input_path = "index.md";
23 var mkdocs_page_url = "/";
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>
32 <body class=
"wy-body-for-nav" role=
"document">
34 <div class=
"wy-grid-for-nav">
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>
41 <form id =
"rtd-search-form" class=
"wy-form" action=
"./search.html" method=
"get">
42 <input type=
"text" name=
"q" placeholder=
"Search docs" />
47 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
51 <li class=
"toctree-l1 current">
53 <a class=
"current" href=
".">Home
</a>
56 <li class=
"toctree-l2"><a href=
"#shaarli-documentation">Shaarli documentation
</a></li>
60 <li><a class=
"toctree-l3" href=
"#demo">Demo
</a></li>
62 <li><a class=
"toctree-l3" href=
"#features">Features
</a></li>
64 <li><a class=
"toctree-l3" href=
"#about">About
</a></li>
72 <li class=
"toctree-l1">
74 <span class=
"caption-text">Setup
</span>
78 <a class=
"" href=
"Download-and-Installation/">Download and Installation
</a>
82 <a class=
"" href=
"Upgrade-and-migration/">Upgrade and migration
</a>
86 <a class=
"" href=
"Server-requirements/">Server requirements
</a>
90 <a class=
"" href=
"Server-configuration/">Server configuration
</a>
94 <a class=
"" href=
"Server-security/">Server security
</a>
98 <a class=
"" href=
"Shaarli-configuration/">Shaarli configuration
</a>
102 <a class=
"" href=
"Plugins/">Plugins
</a>
107 <li class=
"toctree-l1">
109 <span class=
"caption-text">Docker
</span>
113 <a class=
"" href=
"docker/docker-101/">Docker
101</a>
117 <a class=
"" href=
"docker/shaarli-images/">Shaarli images
</a>
121 <a class=
"" href=
"docker/reverse-proxy-configuration/">Reverse proxy configuration
</a>
125 <a class=
"" href=
"docker/resources/">Docker resources
</a>
130 <li class=
"toctree-l1">
132 <span class=
"caption-text">Usage
</span>
136 <a class=
"" href=
"Features/">Features
</a>
140 <a class=
"" href=
"Bookmarklet/">Bookmarklet
</a>
144 <a class=
"" href=
"Browsing-and-searching/">Browsing and searching
</a>
148 <a class=
"" href=
"Firefox-share/">Firefox share
</a>
152 <a class=
"" href=
"RSS-feeds/">RSS feeds
</a>
156 <a class=
"" href=
"REST-API/">REST API
</a>
161 <li class=
"toctree-l1">
163 <span class=
"caption-text">How To
</span>
167 <a class=
"" href=
"Backup,-restore,-import-and-export/">Backup, restore, import and export
</a>
171 <a class=
"" href=
"Various-hacks/">Various hacks
</a>
176 <li class=
"toctree-l1">
178 <a class=
"" href=
"Troubleshooting/">Troubleshooting
</a>
181 <li class=
"toctree-l1">
183 <span class=
"caption-text">Development
</span>
187 <a class=
"" href=
"Development-guidelines/">Development guidelines
</a>
191 <a class=
"" href=
"Continuous-integration-tools/">Continuous integration tools
</a>
195 <a class=
"" href=
"GnuPG-signature/">GnuPG signature
</a>
199 <a class=
"" href=
"Coding-guidelines/">Coding guidelines
</a>
203 <a class=
"" href=
"Directory-structure/">Directory structure
</a>
207 <a class=
"" href=
"3rd-party-libraries/">3rd party libraries
</a>
211 <a class=
"" href=
"Plugin-System/">Plugin System
</a>
215 <a class=
"" href=
"Release-Shaarli/">Release Shaarli
</a>
219 <a class=
"" href=
"Versioning-and-Branches/">Versioning and Branches
</a>
223 <a class=
"" href=
"Security/">Security
</a>
227 <a class=
"" href=
"Static-analysis/">Static analysis
</a>
231 <a class=
"" href=
"Theming/">Theming
</a>
235 <a class=
"" href=
"Unit-tests/">Unit tests
</a>
240 <li class=
"toctree-l1">
242 <span class=
"caption-text">About
</span>
246 <a class=
"" href=
"FAQ/">FAQ
</a>
250 <a class=
"" href=
"Community-&-Related-software/">Community & Related software
</a>
260 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
263 <nav class=
"wy-nav-top" role=
"navigation" aria-label=
"top navigation">
264 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
265 <a href=
".">Shaarli Documentation
</a>
269 <div class=
"wy-nav-content">
270 <div class=
"rst-content">
271 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
272 <ul class=
"wy-breadcrumbs">
273 <li><a href=
".">Docs
</a> »</li>
278 <li class=
"wy-breadcrumbs-aside">
280 <a href=
"https://github.com/shaarli/Shaarli/edit/master/docs/index.md"
281 class=
"icon icon-github"> Edit on GitHub
</a>
288 <div class=
"section">
290 <h1 id=
"shaarli-documentation"><a href=
"https://github.com/shaarli/Shaarli/">Shaarli
</a> documentation
</h1>
291 <p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.
</p>
292 <p>For general info, read the
<a href=
"https://github.com/shaarli/Shaarli/blob/master/README.md">README
</a>.
</p>
293 <p>If you have any questions or ideas, please join the
<a href=
"https://gitter.im/shaarli/Shaarli">chat
</a> (also reachable via
<a href=
"https://irc.gitter.im/">IRC
</a>), post them in our
<a href=
"https://github.com/shaarli/Shaarli/issues/308">general discussion
</a> or read the current
<a href=
"https://github.com/shaarli/Shaarli/issues">issues
</a>.
294 If you've found a bug, please create a
<a href=
"https://github.com/shaarli/Shaarli/issues/new">new issue
</a>.
</p>
295 <p>If you would like a feature added to Shaarli, check the issues labeled
<a href=
"https://github.com/shaarli/Shaarli/labels/feature"><code>feature
</code></a>,
<a href=
"https://github.com/shaarli/Shaarli/labels/enhancement"><code>enhancement
</code></a>, and
<a href=
"https://github.com/shaarli/Shaarli/labels/plugin"><code>plugin
</code></a>.
</p>
296 <p><em>Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the
<code>doc/html/
</code> directory of your Shaarli installation.
</em></p>
297 <p><a href=
"https://gitter.im/shaarli/Shaarli"><img alt=
"Join the chat at https://gitter.im/shaarli/Shaarli" src=
"https://badges.gitter.im/Join%20Chat.svg" /></a>
298 <a href=
"https://www.bountysource.com/teams/shaarli/issues"><img alt=
"Bountysource" src=
"https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received" /></a>
299 <a href=
"https://hub.docker.com/r/shaarli/shaarli/"><img alt=
"Docker repository" src=
"https://img.shields.io/docker/pulls/shaarli/shaarli.svg" /></a></p>
300 <h3 id=
"demo">Demo
</h3>
301 <p>You can use this
<a href=
"https://demo.shaarli.org">public demo instance of Shaarli
</a>.
302 It runs the latest development version of Shaarli and is updated/reset daily.
</p>
303 <p>Login:
<code>demo
</code>; Password:
<code>demo
</code></p>
304 <h2 id=
"features">Features
</h2>
305 <h3 id=
"interface">Interface
</h3>
307 <li>minimalist design (simple is beautiful)
</li>
309 <li>ATOM and RSS feeds
</li>
311 <li>paginated link list
</li>
313 <li>picture wall: image and video thumbnails
</li>
314 <li>daily: newspaper-like daily digest
</li>
315 <li>daily RSS feed
</li>
318 <li>permalinks for easy reference
</li>
319 <li>links can be public or private
</li>
320 <li>extensible through
<a href=
"https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage">plugins
</a></li>
322 <h3 id=
"tag-view-and-search-your-links">Tag, view and search your links!
</h3>
324 <li>add a custom title and description to archived links
</li>
325 <li>add tags to classify and search links
<ul>
326 <li>features tag autocompletion, renaming, merging and deletion
</li>
329 <li>full-text and tag search
</li>
331 <h3 id=
"easy-setup">Easy setup
</h3>
333 <li>dead-simple installation: drop the files, open the page
</li>
334 <li>links are stored in a file
<ul>
335 <li>compact storage
</li>
336 <li>no database required
</li>
337 <li>easy backup: simply copy the datastore file
</li>
340 <li>import and export links as Netscape bookmarks
</li>
342 <h3 id=
"accessibility">Accessibility
</h3>
344 <li>Firefox bookmarlet to share links in one click
</li>
345 <li>support for mobile browsers
</li>
346 <li>works with Javascript disabled
</li>
347 <li>easy page customization through HTML/CSS/RainTPL
</li>
349 <h3 id=
"security">Security
</h3>
351 <li>bruteforce-proof login form
</li>
352 <li>protected against
<a href=
"http://en.wikipedia.org/wiki/Cross-site_request_forgery">XSRF
</a>
353 and session cookie hijacking
</li>
355 <h3 id=
"goodies">Goodies
</h3>
357 <li>thumbnail generation for images and video services:
358 dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
<ul>
359 <li>lazy-loading with
<a href=
"http://dinbror.dk/blazy/">bLazy
</a></li>
362 <li><a href=
"https://code.google.com/p/pubsubhubbub/">PubSubHubbub
</a> protocol support
</li>
363 <li>URL cleanup: automatic removal of
<code>?utm_source=...
</code>,
<code>fb=...
</code></li>
364 <li>discreet pop-up notification when a new release is available
</li>
366 <h3 id=
"rest-api">REST API
</h3>
367 <p>Easily extensible by any client using the REST API exposed by Shaarli.
</p>
368 <p>See the
<a href=
"http://shaarli.github.io/api-documentation/">API documentation
</a>.
</p>
369 <h3 id=
"other-usages">Other usages
</h3>
370 <p>Though Shaarli is primarily a bookmarking application, it can serve other purposes
371 (see
<a href=
"https://github.com/shaarli/Shaarli/wiki#usage-examples">usage examples
</a>):
375 - snippet archive
</p>
376 <h2 id=
"about">About
</h2>
377 <h3 id=
"shaarli-community-fork">Shaarli community fork
</h3>
378 <p>This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
</p>
379 <p>This is a community fork of the original
<a href=
"https://github.com/sebsauvage/Shaarli/">Shaarli
</a> project by
<a href=
"http://sebsauvage.net/">Sébastien Sauvage
</a>.
</p>
380 <p>The original project is currently unmaintained, and the developer
<a href=
"https://github.com/sebsauvage/Shaarli/issues/191">has informed us
</a>
381 that he would have no time to work on Shaarli in the near future.
382 The Shaarli community has carried on the work to provide
383 <a href=
"https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master">many patches
</a>
384 for
<a href=
"https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+">bug fixes and enhancements
</a>
385 in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.
</p>
386 <h3 id=
"contributing">Contributing
</h3>
387 <p>If you'd like to help, please:
388 - have a look at the open
<a href=
"https://github.com/shaarli/Shaarli/issues">issues
</a>
389 and
<a href=
"https://github.com/shaarli/Shaarli/pulls">pull requests
</a>
390 - feel free to report bugs (feedback is much appreciated)
391 - suggest new features and improvements to both code and
<a href=
"https://github.com/shaarli/Shaarli/wiki">documentation
</a>
392 - propose solutions to existing problems
393 - submit pull requests :-)
</p>
394 <h3 id=
"license">License
</h3>
395 <p>Shaarli is
<a href=
"http://en.wikipedia.org/wiki/Free_software">Free Software
</a>. See
<a href=
"./COPYING">COPYING
</a> for a detail of the contributors and licenses for each individual component.
</p>
401 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
403 <a href=
"Download-and-Installation/" class=
"btn btn-neutral float-right" title=
"Download and Installation">Next
<span class=
"icon icon-circle-arrow-right"></span></a>
411 <div role=
"contentinfo">
412 <!-- Copyright etc -->
416 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>.
426 <div class=
"rst-versions" role=
"note" style=
"cursor: pointer">
427 <span class=
"rst-current-version" data-toggle=
"rst-current-version">
429 <a href=
"https://github.com/shaarli/Shaarli" class=
"fa fa-github" style=
"float: left; color: #fcfcfc"> GitHub
</a>
433 <span style=
"margin-left: 15px"><a href=
"Download-and-Installation/" style=
"color: #fcfcfc">Next
»</a></span>
437 <script src=
"./js/theme.js"></script>
443 MkDocs version : 0.16.3
444 Build Date UTC : 2017-07-29 13:33:00