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>
59 <li class=
"toctree-l1">
61 <span class=
"caption-text">Setup
</span>
65 <a class=
"" href=
"Download-and-Installation/">Download and Installation
</a>
69 <a class=
"" href=
"Upgrade-and-migration/">Upgrade and migration
</a>
73 <a class=
"" href=
"Server-requirements/">Server requirements
</a>
77 <a class=
"" href=
"Server-configuration/">Server configuration
</a>
81 <a class=
"" href=
"Server-security/">Server security
</a>
85 <a class=
"" href=
"Shaarli-configuration/">Shaarli configuration
</a>
89 <a class=
"" href=
"Plugins/">Plugins
</a>
94 <li class=
"toctree-l1">
96 <span class=
"caption-text">Docker
</span>
100 <a class=
"" href=
"Docker-101/">Docker
101</a>
104 <a class=
"" href=
"Shaarli-images/">Shaarli images
</a>
108 <a class=
"" href=
"Reverse-proxy-configuration/">Reverse proxy configuration
</a>
112 <a class=
"" href=
"Docker-resources/">Docker resources
</a>
117 <li class=
"toctree-l1">
119 <span class=
"caption-text">Usage
</span>
123 <a class=
"" href=
"Features/">Features
</a>
127 <a class=
"" href=
"Bookmarklet/">Bookmarklet
</a>
131 <a class=
"" href=
"Browsing-and-searching/">Browsing and searching
</a>
135 <a class=
"" href=
"Firefox-share/">Firefox share
</a>
139 <a class=
"" href=
"RSS-feeds/">RSS feeds
</a>
143 <a class=
"" href=
"REST-API/">REST API
</a>
148 <li class=
"toctree-l1">
150 <span class=
"caption-text">How To
</span>
154 <a class=
"" href=
"Backup,-restore,-import-and-export/">Backup, restore, import and export
</a>
158 <a class=
"" href=
"Various-hacks/">Various hacks
</a>
163 <li class=
"toctree-l1">
165 <a class=
"" href=
"Troubleshooting/">Troubleshooting
</a>
168 <li class=
"toctree-l1">
170 <span class=
"caption-text">Development
</span>
174 <a class=
"" href=
"Development-guidelines/">Development guidelines
</a>
178 <a class=
"" href=
"Continuous-integration-tools/">Continuous integration tools
</a>
182 <a class=
"" href=
"GnuPG-signature/">GnuPG signature
</a>
186 <a class=
"" href=
"Coding-guidelines/">Coding guidelines
</a>
190 <a class=
"" href=
"Directory-structure/">Directory structure
</a>
194 <a class=
"" href=
"3rd-party-libraries/">3rd party libraries
</a>
198 <a class=
"" href=
"Plugin-System/">Plugin System
</a>
202 <a class=
"" href=
"Release-Shaarli/">Release Shaarli
</a>
206 <a class=
"" href=
"Versioning-and-Branches/">Versioning and Branches
</a>
210 <a class=
"" href=
"Security/">Security
</a>
214 <a class=
"" href=
"Static-analysis/">Static analysis
</a>
218 <a class=
"" href=
"Theming/">Theming
</a>
222 <a class=
"" href=
"Unit-tests/">Unit tests
</a>
227 <li class=
"toctree-l1">
229 <span class=
"caption-text">About
</span>
233 <a class=
"" href=
"FAQ/">FAQ
</a>
237 <a class=
"" href=
"Community-&-Related-software/">Community & Related software
</a>
247 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
250 <nav class=
"wy-nav-top" role=
"navigation" aria-label=
"top navigation">
251 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
252 <a href=
".">Shaarli Documentation
</a>
256 <div class=
"wy-nav-content">
257 <div class=
"rst-content">
258 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
259 <ul class=
"wy-breadcrumbs">
260 <li><a href=
".">Docs
</a> »</li>
265 <li class=
"wy-breadcrumbs-aside">
267 <a href=
"https://github.com/shaarli/Shaarli/edit/master/docs/index.md"
268 class=
"icon icon-github"> Edit on GitHub
</a>
275 <div class=
"section">
277 <p>Welcome to the
<a href=
"https://github.com/shaarli/Shaarli/">Shaarli
</a> wiki!
</p>
278 <p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.
</p>
279 <p>For general info, read the
<a href=
"https://github.com/shaarli/Shaarli/blob/master/README.md">README
</a>.
</p>
280 <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> (
<a href=
"https://github.com/shaarli/Shaarli/issues/44">archive
</a>) or read the current
<a href=
"https://github.com/shaarli/Shaarli/issues">issues
</a>. If you've found a bug, please create a
<a href=
"https://github.com/shaarli/Shaarli/issues/new">new issue
</a>.
</p>
281 <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>
282 <p><em>Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the
<code>doc/
</code> directory of your Shaarli installation.
</em></p>
288 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
290 <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>
298 <div role=
"contentinfo">
299 <!-- Copyright etc -->
303 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>.
313 <div class=
"rst-versions" role=
"note" style=
"cursor: pointer">
314 <span class=
"rst-current-version" data-toggle=
"rst-current-version">
316 <a href=
"https://github.com/shaarli/Shaarli" class=
"fa fa-github" style=
"float: left; color: #fcfcfc"> GitHub
</a>
320 <span style=
"margin-left: 15px"><a href=
"Download-and-Installation/" style=
"color: #fcfcfc">Next
»</a></span>
324 <script src=
"./js/theme.js"></script>
330 MkDocs version : 0.16.3
331 Build Date UTC : 2017-06-18 04:31:25