2015-03-07 14:50:31 +01:00
2013-02-27 18:58:26 +01:00
2016-05-08 18:58:59 +02:00
The personal, minimalist, super-fast, database free, bookmarking service.
2013-02-26 14:30:28 +01:00
2015-09-06 01:56:37 +02:00
_Do you want to share the links you discover?_
_Shaarli is a minimalist delicious clone that you can install on your own server._
_It is designed to be personal (single-user), fast and handy._
2013-02-26 14:30:28 +01:00
2015-09-06 01:56:37 +02:00
[](https://travis-ci.org/shaarli/Shaarli)
[](https://travis-ci.org/shaarli/Shaarli)
[](https://github.com/shaarli/Shaarli/releases/latest/)
2015-08-16 14:50:16 +02:00
[](https://hub.docker.com/r/shaarli/shaarli/)
2013-02-26 14:30:28 +01:00
2015-09-06 01:56:37 +02:00
[](https://gitter.im/shaarli/Shaarli)
[](https://www.bountysource.com/teams/shaarli/issues)
2013-02-26 14:30:28 +01:00
2015-09-06 01:56:37 +02:00
## Quickstart
- [Wiki/documentation ](https://github.com/shaarli/Shaarli/wiki )
- [Bugs/Feature requests/Discussion ](https://github.com/shaarli/Shaarli/issues/ )
2013-02-26 14:30:28 +01:00
2015-09-06 01:56:37 +02:00
### Demo
You can use this [public demo instance of Shaarli ](http://shaarlidemo.tuxfamily.org/Shaarli ).
It runs the latest development version of Shaarli and is updated/reset daily.
2014-12-17 07:47:43 +01:00
2015-09-06 01:56:37 +02:00
Login: `demo` ; Password: `demo`
2014-12-17 07:47:43 +01:00
2015-09-06 01:56:37 +02:00
### Installation & upgrade
2016-08-20 16:42:35 +02:00
- [Download and installation ](https://github.com/shaarli/Shaarli/wiki/Download-and-Installation )
2016-05-20 22:01:54 +02:00
- [Upgrade and migration ](https://github.com/shaarli/Shaarli/wiki/Upgrade-and-migration )
2015-09-06 01:56:37 +02:00
- [Server requirements ](https://github.com/shaarli/Shaarli/wiki/Server-requirements )
- [Server configuration ](https://github.com/shaarli/Shaarli/wiki/Server-configuration )
- [Shaarli configuration ](https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration )
2013-02-26 14:30:28 +01:00
2015-09-06 01:56:37 +02:00
## Features
### Interface
- minimalist design (simple is beautiful)
- FAST
- ATOM and RSS feeds
- views:
- paginated link list
- tag cloud
2015-09-06 02:22:52 +02:00
- picture wall: image and video thumbnails
2015-09-06 01:56:37 +02:00
- daily: newspaper-like daily digest
- daily RSS feed
- permalinks for easy reference
- links can be public or private
2016-05-04 21:27:32 +02:00
- extensible through [plugins ](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage )
2015-09-06 01:56:37 +02:00
### Tag, view and search your links!
- add a custom title and description to archived links
- add tags to classify and search links
- features tag autocompletion, renaming, merging and deletion
- full-text and tag search
### Easy setup
- dead-simple installation: drop the files, open the page
- links are stored in a file
- compact storage
- no database required
- easy backup: simply copy the datastore file
- import and export links as Netscape bookmarks
### Accessibility
- Firefox bookmarlet to share links in one click
- support for mobile browsers
- works with Javascript disabled
- easy page customization through HTML/CSS/RainTPL
### Security
- bruteforce-proof login form
- protected against [XSRF ](http://en.wikipedia.org/wiki/Cross-site_request_forgery )
and session cookie hijacking
### Goodies
- thumbnail generation for images and video services:
dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
- lazy-loading with [bLazy ](http://dinbror.dk/blazy/ )
- [PubSubHubbub ](https://code.google.com/p/pubsubhubbub/ ) protocol support
- URL cleanup: automatic removal of `?utm_source=...` , `fb=...`
- discreet pop-up notification when a new release is available
### Other usages
Though Shaarli is primarily a bookmarking application, it can serve other purposes
(see [usage examples ](https://github.com/shaarli/Shaarli/wiki#usage-examples )):
- micro-blogging
- pastebin
- online notepad
- snippet archive
2013-02-26 14:30:28 +01:00
2014-10-09 15:45:23 +02:00
## About
2015-09-06 01:56:37 +02:00
### Shaarli community fork
This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
This is a community fork of the original [Shaarli ](https://github.com/sebsauvage/Shaarli/ ) project by [Sébastien Sauvage ](http://sebsauvage.net/ ).
2015-09-06 02:22:52 +02:00
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.
2015-09-06 01:56:37 +02:00
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+ )
2015-09-06 02:22:52 +02:00
in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.
2015-09-06 01:56:37 +02:00
### Contributing
If you'd like to help, please:
- have a look at the open [issues ](https://github.com/shaarli/Shaarli/issues )
and [pull requests ](https://github.com/shaarli/Shaarli/pulls )
- feel free to report bugs (feedback is much appreciated)
- suggest new features and improvements to both code and [documentation ](https://github.com/shaarli/Shaarli/wiki )
- propose solutions to existing problems
- submit pull requests :-)
### License
2014-12-17 07:47:43 +01:00
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.
