1 # [Shaarli](https://github.com/shaarli/Shaarli/) documentation
3 The personal, minimalist, super-fast, database free, bookmarking service.
5 Do you want to share the links you discover?
6 Shaarli is a minimalist link sharing service that you can install on your own server.
7 It is designed to be personal (single-user), fast and handy.
9 <!--- TODO screenshots --->
11 Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.
12 For general information, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).
14 If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) or read the current [issues](https://github.com/shaarli/Shaarli/issues).
16 If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).
18 If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin).
20 * [GitHub project page](https://github.com/shaarli/Shaarli)
21 * [Online documentation](https://shaarli.readthedocs.io/) (this page)
22 * [Latest Shaarli releases](https://github.com/shaarli/Shaarli/releases)
23 * [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md)
28 You can use this [public demo instance of Shaarli](https://demo.shaarli.org).
29 It runs the latest development version of Shaarli and is updated/reset daily.
31 Login: `demo`; Password: `demo`
33 <!---- TODO review everything below this point --->
40 - to share, comment and save interesting links and news.
41 - to bookmark useful/frequent personal links (as private links) and share them between computers.
42 - as a minimal blog/microblog/writing platform (no character limit).
43 - as a read-it-later list (for example items tagged `readlater`).
44 - to draft and save articles/posts/ideas.
45 - to keep code snippets.
46 - to keep notes and documentation.
47 - as a shared clipboard/notepad/pastebin between machines.
49 - to store playlists (e.g. with the `music` or `video` tags).
50 - to keep extracts/comments from webpages that may disappear.
51 - to keep track of ongoing discussions (for example items tagged `discussion`).
52 - [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags.
53 - to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...).
57 - minimalist design (simple is beautiful)
61 - paginated link list (with image and video thumbnails)
63 - picture wall: image and video thumbnails (with lazy loading)
64 - daily: newspaper-like daily digest
66 - permalinks for easy reference
67 - links can be public or private
68 - thumbnail generation for images and video services
69 - URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
70 - extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage)
72 ### Tag, view and search your links
74 - add a custom title and description to archived links
75 - add tags to classify and search links
76 - features tag autocompletion, renaming, merging and deletion
77 - full-text and tag search
81 - dead-simple installation: drop the files, open the page
82 - links are stored in a file
84 - no database required
85 - easy backup: simply copy the datastore file
86 - import and export links as Netscape bookmarks
90 - bookmarlet to share links in one click
91 - support for mobile browsers
92 - degrades gracefully with Javascript disabled
93 - easy page customization through HTML/CSS/RainTPL
97 - discreet pop-up notification when a new release is available
98 - bruteforce protection on the login form
99 - protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) and session cookie hijacking
101 <!---- TODO Limitations --->
105 Easily extensible by any client using the REST API exposed by Shaarli.
107 See the [API documentation](http://shaarli.github.io/api-documentation/).
111 ### Shaarli community fork
113 This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
115 This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
117 The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) that he would have no time to work on Shaarli in the near future.
119 The Shaarli community has carried on the work to provide [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.
124 If you'd like to help, please:
125 - have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
126 and [pull requests](https://github.com/shaarli/Shaarli/pulls)
127 - feel free to report bugs (feedback is much appreciated)
128 - suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/tree/master/doc/md/)
129 - propose solutions to existing problems
130 - submit pull requests :-)
135 Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See [COPYING](https://github.com/shaarli/Shaarli/blob/master/COPYING) for a detail of the contributors and licenses for each individual component. A list of contributors is available [here](https://github.com/shaarli/Shaarli/blob/master/AUTHORS).