[github/shaarli/Shaarli.git] / doc / html / index.html

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta name="description" content="The personal, minimalist, super-fast, database free, bookmarking service">
  
  <link rel="shortcut icon" href="./img/favicon.ico">
  <title>Home - Shaarli Documentation</title>
  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>

  <link rel="stylesheet" href="./css/theme.css" type="text/css" />
  <link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />
  <link rel="stylesheet" href="./css/highlight.css">
  <link href="./github-markdown.css" rel="stylesheet">
  
  <script>
    // Current page data
    var mkdocs_page_name = "Home";
    var mkdocs_page_input_path = "index.md";
    var mkdocs_page_url = "/";
  </script>
  
  <script src="./js/jquery-2.1.1.min.js"></script>
  <script src="./js/modernizr-2.8.3.min.js"></script>
  <script type="text/javascript" src="./js/highlight.pack.js"></script> 
  
</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
      <div class="wy-side-nav-search">
        <a href="." class="icon icon-home"> Shaarli Documentation</a>
        <div role="search">
  <form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
	<ul class="current">
	  
          
            <li class="toctree-l1 current">
		
    <a class="current" href=".">Home</a>
    <ul class="subnav">
            
    <li class="toctree-l2"><a href="#shaarli-documentation">Shaarli documentation</a></li>
    
        <ul>
        
            <li><a class="toctree-l3" href="#demo">Demo</a></li>
        
            <li><a class="toctree-l3" href="#features">Features</a></li>
        
            <li><a class="toctree-l3" href="#about">About</a></li>
        
        </ul>
    

    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Setup</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="Download-and-Installation/">Download and Installation</a>
                </li>
                <li class="">
                    
    <a class="" href="Upgrade-and-migration/">Upgrade and migration</a>
                </li>
                <li class="">
                    
    <a class="" href="Server-requirements/">Server requirements</a>
                </li>
                <li class="">
                    
    <a class="" href="Server-configuration/">Server configuration</a>
                </li>
                <li class="">
                    
    <a class="" href="Server-security/">Server security</a>
                </li>
                <li class="">
                    
    <a class="" href="Shaarli-configuration/">Shaarli configuration</a>
                </li>
                <li class="">
                    
    <a class="" href="Plugins/">Plugins</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Docker</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="docker/docker-101/">Docker 101</a>
                </li>
                <li class="">
                    
    <a class="" href="docker/shaarli-images/">Shaarli images</a>
                </li>
                <li class="">
                    
    <a class="" href="docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
                </li>
                <li class="">
                    
    <a class="" href="docker/resources/">Docker resources</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Usage</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="Features/">Features</a>
                </li>
                <li class="">
                    
    <a class="" href="Bookmarklet/">Bookmarklet</a>
                </li>
                <li class="">
                    
    <a class="" href="Browsing-and-searching/">Browsing and searching</a>
                </li>
                <li class="">
                    
    <a class="" href="Firefox-share/">Firefox share</a>
                </li>
                <li class="">
                    
    <a class="" href="RSS-feeds/">RSS feeds</a>
                </li>
                <li class="">
                    
    <a class="" href="REST-API/">REST API</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">How To</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
                </li>
                <li class="">
                    
    <a class="" href="Various-hacks/">Various hacks</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <a class="" href="Troubleshooting/">Troubleshooting</a>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">Development</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="Development-guidelines/">Development guidelines</a>
                </li>
                <li class="">
                    
    <a class="" href="Continuous-integration-tools/">Continuous integration tools</a>
                </li>
                <li class="">
                    
    <a class="" href="GnuPG-signature/">GnuPG signature</a>
                </li>
                <li class="">
                    
    <a class="" href="Coding-guidelines/">Coding guidelines</a>
                </li>
                <li class="">
                    
    <a class="" href="Directory-structure/">Directory structure</a>
                </li>
                <li class="">
                    
    <a class="" href="3rd-party-libraries/">3rd party libraries</a>
                </li>
                <li class="">
                    
    <a class="" href="Plugin-System/">Plugin System</a>
                </li>
                <li class="">
                    
    <a class="" href="Release-Shaarli/">Release Shaarli</a>
                </li>
                <li class="">
                    
    <a class="" href="Versioning-and-Branches/">Versioning and Branches</a>
                </li>
                <li class="">
                    
    <a class="" href="Security/">Security</a>
                </li>
                <li class="">
                    
    <a class="" href="Static-analysis/">Static analysis</a>
                </li>
                <li class="">
                    
    <a class="" href="Theming/">Theming</a>
                </li>
                <li class="">
                    
    <a class="" href="Unit-tests/">Unit tests</a>
                </li>
    </ul>
	    </li>
          
            <li class="toctree-l1">
		
    <span class="caption-text">About</span>
    <ul class="subnav">
                <li class="">
                    
    <a class="" href="FAQ/">FAQ</a>
                </li>
                <li class="">
                    
    <a class="" href="Community-&-Related-software/">Community & Related software</a>
                </li>
    </ul>
	    </li>
          
        </ul>
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href=".">Shaarli Documentation</a>
      </nav>

      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href=".">Docs</a> &raquo;</li>
    
      
    
    <li>Home</li>
    <li class="wy-breadcrumbs-aside">
      
        <a href="https://github.com/shaarli/Shaarli/edit/master/docs/index.md"
          class="icon icon-github"> Edit on GitHub</a>
      
    </li>
  </ul>
  <hr/>
</div>
          <div role="main">
            <div class="section">
              
                <h1 id="shaarli-documentation"><a href="https://github.com/shaarli/Shaarli/">Shaarli</a> documentation</h1>
<p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.</p>
<p>For general info, read the <a href="https://github.com/shaarli/Shaarli/blob/master/README.md">README</a>.</p>
<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>.
If you've found a bug, please create a <a href="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.</p>
<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>
<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>
<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>
<a href="https://www.bountysource.com/teams/shaarli/issues"><img alt="Bountysource" src="https://www.bountysource.com/badge/team?team_id=19583&amp;style=bounties_received" /></a>
<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>
<h3 id="demo">Demo</h3>
<p>You can use this <a href="https://demo.shaarli.org">public demo instance of Shaarli</a>.
It runs the latest development version of Shaarli and is updated/reset daily.</p>
<p>Login: <code>demo</code>; Password: <code>demo</code></p>
<h2 id="features">Features</h2>
<h3 id="interface">Interface</h3>
<ul>
<li>minimalist design (simple is beautiful)</li>
<li>FAST</li>
<li>ATOM and RSS feeds</li>
<li>views:<ul>
<li>paginated link list</li>
<li>tag cloud</li>
<li>picture wall: image and video thumbnails</li>
<li>daily: newspaper-like daily digest</li>
<li>daily RSS feed</li>
</ul>
</li>
<li>permalinks for easy reference</li>
<li>links can be public or private</li>
<li>extensible through <a href="https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage">plugins</a></li>
</ul>
<h3 id="tag-view-and-search-your-links">Tag, view and search your links!</h3>
<ul>
<li>add a custom title and description to archived links</li>
<li>add tags to classify and search links<ul>
<li>features tag autocompletion, renaming, merging and deletion</li>
</ul>
</li>
<li>full-text and tag search</li>
</ul>
<h3 id="easy-setup">Easy setup</h3>
<ul>
<li>dead-simple installation: drop the files, open the page</li>
<li>links are stored in a file<ul>
<li>compact storage</li>
<li>no database required</li>
<li>easy backup: simply copy the datastore file</li>
</ul>
</li>
<li>import and export links as Netscape bookmarks</li>
</ul>
<h3 id="accessibility">Accessibility</h3>
<ul>
<li>Firefox bookmarlet to share links in one click</li>
<li>support for mobile browsers</li>
<li>works with Javascript disabled</li>
<li>easy page customization through HTML/CSS/RainTPL</li>
</ul>
<h3 id="security">Security</h3>
<ul>
<li>bruteforce-proof login form</li>
<li>protected against <a href="http://en.wikipedia.org/wiki/Cross-site_request_forgery">XSRF</a>
and session cookie hijacking</li>
</ul>
<h3 id="goodies">Goodies</h3>
<ul>
<li>thumbnail generation for images and video services:
dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...<ul>
<li>lazy-loading with <a href="http://dinbror.dk/blazy/">bLazy</a></li>
</ul>
</li>
<li><a href="https://code.google.com/p/pubsubhubbub/">PubSubHubbub</a> protocol support</li>
<li>URL cleanup: automatic removal of <code>?utm_source=...</code>, <code>fb=...</code></li>
<li>discreet pop-up notification when a new release is available</li>
</ul>
<h3 id="rest-api">REST API</h3>
<p>Easily extensible by any client using the REST API exposed by Shaarli.</p>
<p>See the <a href="http://shaarli.github.io/api-documentation/">API documentation</a>.</p>
<h3 id="other-usages">Other usages</h3>
<p>Though Shaarli is primarily a bookmarking application, it can serve other purposes
(see <a href="https://github.com/shaarli/Shaarli/wiki#usage-examples">usage examples</a>):
- micro-blogging
- pastebin
- online notepad
- snippet archive</p>
<h2 id="about">About</h2>
<h3 id="shaarli-community-fork">Shaarli community fork</h3>
<p>This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli</p>
<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>
<p>The original project is currently unmaintained, and the developer <a href="https://github.com/sebsauvage/Shaarli/issues/191">has informed us</a>
that he would have no time to work on Shaarli in the near future.
The Shaarli community has carried on the work to provide
<a href="https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master">many patches</a>
for <a href="https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+">bug fixes and enhancements</a>
in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.</p>
<h3 id="contributing">Contributing</h3>
<p>If you'd like to help, please:
- have a look at the open <a href="https://github.com/shaarli/Shaarli/issues">issues</a>
and <a href="https://github.com/shaarli/Shaarli/pulls">pull requests</a>
- feel free to report bugs (feedback is much appreciated)
- suggest new features and improvements to both code and <a href="https://github.com/shaarli/Shaarli/wiki">documentation</a>
- propose solutions to existing problems
- submit pull requests :-)</p>
<h3 id="license">License</h3>
<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>
              
            </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <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>
      
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <!-- Copyright etc -->
    
  </div>

  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>.
</footer>
	  
        </div>
      </div>

    </section>
    
  </div>

  <div class="rst-versions" role="note" style="cursor: pointer">
    <span class="rst-current-version" data-toggle="rst-current-version">
      
          <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
      
      
      
        <span style="margin-left: 15px"><a href="Download-and-Installation/" style="color: #fcfcfc">Next &raquo;</a></span>
      
    </span>
</div>
    <script src="./js/theme.js"></script>

</body>
</html>

<!--
MkDocs version : 0.16.3
Build Date UTC : 2017-07-29 13:33:00
-->
Commit	Line	Data
53ed6d7d	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	<meta name="description" content="The personal, minimalist, super-fast, database free, bookmarking service">
	9
	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'>
	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 = "Home";
	22	var mkdocs_page_input_path = "index.md";
	23	var mkdocs_page_url = "/";
	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 current">
	52
	53	<a class="current" href=".">Home</a>
	54	<ul class="subnav">
	55
366247c8	56	<li class="toctree-l2"><a href="#shaarli-documentation">Shaarli documentation</a></li>
	57
	58	<ul>
	59
	60	<li><a class="toctree-l3" href="#demo">Demo</a></li>
	61
	62	<li><a class="toctree-l3" href="#features">Features</a></li>
	63
	64	<li><a class="toctree-l3" href="#about">About</a></li>
	65
	66	</ul>
	67
	68
53ed6d7d	69	</ul>
	70	</li>
	71
	72	<li class="toctree-l1">
	73
	74	<span class="caption-text">Setup</span>
	75	<ul class="subnav">
	76	<li class="">
	77
	78	<a class="" href="Download-and-Installation/">Download and Installation</a>
	79	</li>
	80	<li class="">
	81
	82	<a class="" href="Upgrade-and-migration/">Upgrade and migration</a>
	83	</li>
	84	<li class="">
	85
	86	<a class="" href="Server-requirements/">Server requirements</a>
	87	</li>
	88	<li class="">
	89
	90	<a class="" href="Server-configuration/">Server configuration</a>
	91	</li>
	92	<li class="">
	93
	94	<a class="" href="Server-security/">Server security</a>
	95	</li>
	96	<li class="">
	97
	98	<a class="" href="Shaarli-configuration/">Shaarli configuration</a>
	99	</li>
	100	<li class="">
	101
	102	<a class="" href="Plugins/">Plugins</a>
	103	</li>
	104	</ul>
	105	</li>
	106
	107	<li class="toctree-l1">
	108
	109	<span class="caption-text">Docker</span>
	110	<ul class="subnav">
	111	<li class="">
	112
3a6f91a9	113	<a class="" href="docker/docker-101/">Docker 101</a>
53ed6d7d	114	</li>
	115	<li class="">
	116
3a6f91a9	117	<a class="" href="docker/shaarli-images/">Shaarli images</a>
53ed6d7d	118	</li>
	119	<li class="">
	120
3a6f91a9	121	<a class="" href="docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
53ed6d7d	122	</li>
	123	<li class="">
	124
3a6f91a9	125	<a class="" href="docker/resources/">Docker resources</a>
53ed6d7d	126	</li>
	127	</ul>
	128	</li>
	129
	130	<li class="toctree-l1">
	131
	132	<span class="caption-text">Usage</span>
	133	<ul class="subnav">
	134	<li class="">
	135
	136	<a class="" href="Features/">Features</a>
	137	</li>
	138	<li class="">
	139
	140	<a class="" href="Bookmarklet/">Bookmarklet</a>
	141	</li>
	142	<li class="">
	143
	144	<a class="" href="Browsing-and-searching/">Browsing and searching</a>
	145	</li>
	146	<li class="">
	147
	148	<a class="" href="Firefox-share/">Firefox share</a>
	149	</li>
	150	<li class="">
	151
	152	<a class="" href="RSS-feeds/">RSS feeds</a>
	153	</li>
	154	<li class="">
	155
	156	<a class="" href="REST-API/">REST API</a>
	157	</li>
	158	</ul>
	159	</li>
	160
	161	<li class="toctree-l1">
	162
	163	<span class="caption-text">How To</span>
	164	<ul class="subnav">
	165	<li class="">
	166
	167	<a class="" href="Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
	168	</li>
	169	<li class="">
	170
0433c688	171	<a class="" href="Various-hacks/">Various hacks</a>
53ed6d7d	172	</li>
	173	</ul>
	174	</li>
	175
	176	<li class="toctree-l1">
	177
	178	<a class="" href="Troubleshooting/">Troubleshooting</a>
	179	</li>
	180
	181	<li class="toctree-l1">
	182
	183	<span class="caption-text">Development</span>
	184	<ul class="subnav">
	185	<li class="">
	186
	187	<a class="" href="Development-guidelines/">Development guidelines</a>
	188	</li>
	189	<li class="">
	190
	191	<a class="" href="Continuous-integration-tools/">Continuous integration tools</a>
	192	</li>
	193	<li class="">
	194
	195	<a class="" href="GnuPG-signature/">GnuPG signature</a>
	196	</li>
	197	<li class="">
	198
	199	<a class="" href="Coding-guidelines/">Coding guidelines</a>
	200	</li>
	201	<li class="">
	202
	203	<a class="" href="Directory-structure/">Directory structure</a>
	204	</li>
	205	<li class="">
	206
	207	<a class="" href="3rd-party-libraries/">3rd party libraries</a>
	208	</li>
	209	<li class="">
	210
	211	<a class="" href="Plugin-System/">Plugin System</a>
	212	</li>
	213	<li class="">
	214
	215	<a class="" href="Release-Shaarli/">Release Shaarli</a>
	216	</li>
	217	<li class="">
	218
	219	<a class="" href="Versioning-and-Branches/">Versioning and Branches</a>
	220	</li>
	221	<li class="">
	222
	223	<a class="" href="Security/">Security</a>
	224	</li>
	225	<li class="">
	226
	227	<a class="" href="Static-analysis/">Static analysis</a>
	228	</li>
	229	<li class="">
	230
	231	<a class="" href="Theming/">Theming</a>
	232	</li>
	233	<li class="">
	234
	235	<a class="" href="Unit-tests/">Unit tests</a>
236	</li>
237	</ul>
238	</li>
239
240	<li class="toctree-l1">
241
242	<span class="caption-text">About</span>
243	<ul class="subnav">
244	<li class="">
245
246	<a class="" href="FAQ/">FAQ</a>
247	</li>
248	<li class="">
249
250	<a class="" href="Community-&-Related-software/">Community & Related software</a>
251	</li>
252	</ul>
253	</li>
254
255	</ul>
256	</div>
257
258	</nav>
259
260	<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
261
262
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>
266	</nav>
267
268
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>
274
275
276
277	<li>Home</li>
278	<li class="wy-breadcrumbs-aside">
279
280	<a href="https://github.com/shaarli/Shaarli/edit/master/docs/index.md"
281	class="icon icon-github"> Edit on GitHub</a>
282
283	</li>
284	</ul>
285	<hr/>
286	</div>
287	<div role="main">
288	<div class="section">
289
366247c8	290	<h1 id="shaarli-documentation"><a href="https://github.com/shaarli/Shaarli/">Shaarli</a> documentation</h1>
53ed6d7d	291	<p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.</p>
53ed6d7d	292	<p>For general info, read the <a href="https://github.com/shaarli/Shaarli/blob/master/README.md">README</a>.</p>
366247c8	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>.
366247c8	294	If you've found a bug, please create a <a href="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.</p>
53ed6d7d	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>
366247c8	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>
	306	<ul>
	307	<li>minimalist design (simple is beautiful)</li>
	308	<li>FAST</li>
	309	<li>ATOM and RSS feeds</li>
	310	<li>views:<ul>
	311	<li>paginated link list</li>
	312	<li>tag cloud</li>
	313	<li>picture wall: image and video thumbnails</li>
	314	<li>daily: newspaper-like daily digest</li>
	315	<li>daily RSS feed</li>
	316	</ul>
	317	</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>
	321	</ul>
	322	<h3 id="tag-view-and-search-your-links">Tag, view and search your links!</h3>
	323	<ul>
	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>
	327	</ul>
	328	</li>
	329	<li>full-text and tag search</li>
	330	</ul>
	331	<h3 id="easy-setup">Easy setup</h3>
	332	<ul>
	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>
	338	</ul>
	339	</li>
	340	<li>import and export links as Netscape bookmarks</li>
	341	</ul>
	342	<h3 id="accessibility">Accessibility</h3>
	343	<ul>
	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>
	348	</ul>
	349	<h3 id="security">Security</h3>
	350	<ul>
	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>
	354	</ul>
	355	<h3 id="goodies">Goodies</h3>
	356	<ul>
	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>
360	</ul>
361	</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>
365	</ul>
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>):
372	- micro-blogging
373	- pastebin
374	- online notepad
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>
53ed6d7d	396
	397	</div>
	398	</div>
	399	<footer>
	400
	401	<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
	402
	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>
	404
	405
	406	</div>
	407
	408
	409	<hr/>
	410
	411	<div role="contentinfo">
	412	<!-- Copyright etc -->
	413
	414	</div>
	415
	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>.
	417	</footer>
	418
	419	</div>
	420	</div>
	421
	422	</section>
	423
	424	</div>
	425
	426	<div class="rst-versions" role="note" style="cursor: pointer">
	427	<span class="rst-current-version" data-toggle="rst-current-version">
	428
	429	<a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
	430
	431
	432
	433	<span style="margin-left: 15px"><a href="Download-and-Installation/" style="color: #fcfcfc">Next »</a></span>
	434
	435	</span>
	436	</div>
	437	<script src="./js/theme.js"></script>
	438
	439	</body>
	440	</html>
	441
	442	<!--
	443	MkDocs version : 0.16.3
3a6f91a9	444	Build Date UTC : 2017-07-29 13:33:00
53ed6d7d	445	-->