1 ![Shaarli logo](doc/images/doc-logo.png)
3 The personal, minimalist, super-fast, no-database delicious clone.
5 _Do you want to share the links you discover?_
6 _Shaarli is a minimalist delicious clone that you can install on your own server._
7 _It is designed to be personal (single-user), fast and handy._
9 [![](https://img.shields.io/travis/shaarli/Shaarli.svg?label=master)](https://travis-ci.org/shaarli/Shaarli)
10 [![](https://img.shields.io/travis/shaarli/Shaarli/stable.svg?label=stable)](https://travis-ci.org/shaarli/Shaarli)
11 [![](https://img.shields.io/github/release/shaarli/shaarli.svg)](https://github.com/shaarli/Shaarli/releases/latest/)
12 [![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/)
14 [![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli)
15 [![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues)
18 - [Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)
19 - [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
22 You can use this [public demo instance of Shaarli](http://shaarlidemo.tuxfamily.org/Shaarli).
23 It runs the latest development version of Shaarli and is updated/reset daily.
25 Login: `demo`; Password: `demo`
27 ### Installation & upgrade
28 - [Download](https://github.com/shaarli/Shaarli/wiki/Download)
29 - [Server requirements](https://github.com/shaarli/Shaarli/wiki/Server-requirements)
30 - [Server configuration](https://github.com/shaarli/Shaarli/wiki/Server-configuration)
31 - [Shaarli configuration](https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration)
35 - minimalist design (simple is beautiful)
41 - picture wall: image and video thumbnails
42 - daily: newspaper-like daily digest
44 - permalinks for easy reference
45 - links can be public or private
47 ### Tag, view and search your links!
48 - add a custom title and description to archived links
49 - add tags to classify and search links
50 - features tag autocompletion, renaming, merging and deletion
51 - full-text and tag search
54 - dead-simple installation: drop the files, open the page
55 - links are stored in a file
57 - no database required
58 - easy backup: simply copy the datastore file
59 - import and export links as Netscape bookmarks
62 - Firefox bookmarlet to share links in one click
63 - support for mobile browsers
64 - works with Javascript disabled
65 - easy page customization through HTML/CSS/RainTPL
68 - bruteforce-proof login form
69 - protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
70 and session cookie hijacking
73 - thumbnail generation for images and video services:
74 dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
75 - lazy-loading with [bLazy](http://dinbror.dk/blazy/)
76 - [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
77 - URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
78 - discreet pop-up notification when a new release is available
81 Though Shaarli is primarily a bookmarking application, it can serve other purposes
82 (see [usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)):
89 ### Shaarli community fork
90 This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
92 This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
94 The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191)
95 that he would have no time to work on Shaarli in the near future.
96 The Shaarli community has carried on the work to provide
97 [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master)
98 for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+)
99 in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.
102 If you'd like to help, please:
103 - have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
104 and [pull requests](https://github.com/shaarli/Shaarli/pulls)
105 - feel free to report bugs (feedback is much appreciated)
106 - suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki)
107 - propose solutions to existing problems
108 - submit pull requests :-)
112 Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See [COPYING](COPYING) for a detail of the contributors and licenses for each individual component.