Welcome to the Shaarli wiki!
+Shaarli documentation
Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.
For general info, read the README.
-If you have any questions or ideas, please join the chat (also reachable via IRC), post them in our general discussion (archive) or read the current issues. If you've found a bug, please create a new issue.
+If you have any questions or ideas, please join the chat (also reachable via IRC), post them in our general discussion or read the current issues. +If you've found a bug, please create a new issue.
If you would like a feature added to Shaarli, check the issues labeled feature
, enhancement
, and plugin
.
Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the doc/
directory of your Shaarli installation.
Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the doc/html/
directory of your Shaarli installation.
Demo
+You can use this public demo instance of Shaarli. +It runs the latest development version of Shaarli and is updated/reset daily.
+Login: demo
; Password: demo
Features
+Interface
+-
+
- minimalist design (simple is beautiful) +
- FAST +
- ATOM and RSS feeds +
- views:
-
+
- paginated link list +
- tag cloud +
- picture wall: image and video thumbnails +
- daily: newspaper-like daily digest +
- daily RSS feed +
+ - permalinks for easy reference +
- links can be public or private +
- extensible through plugins +
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 +and session cookie hijacking +
Goodies
+-
+
- thumbnail generation for images and video services:
+dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
-
+
- lazy-loading with bLazy +
+ - PubSubHubbub protocol support +
- URL cleanup: automatic removal of
?utm_source=...
,fb=...
+ - discreet pop-up notification when a new release is available +
REST API
+Easily extensible by any client using the REST API exposed by Shaarli.
+See the API documentation.
+Other usages
+Though Shaarli is primarily a bookmarking application, it can serve other purposes +(see usage examples): +- micro-blogging +- pastebin +- online notepad +- snippet archive
+About
+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 project by Sébastien Sauvage.
+The original project is currently unmaintained, and the developer has informed us +that he would have no time to work on Shaarli in the near future. +The Shaarli community has carried on the work to provide +many patches +for bug fixes and enhancements +in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.
+Contributing
+If you'd like to help, please: +- have a look at the open issues +and pull requests +- feel free to report bugs (feedback is much appreciated) +- suggest new features and improvements to both code and documentation +- propose solutions to existing problems +- submit pull requests :-)
+License
+Shaarli is Free Software. See COPYING for a detail of the contributors and licenses for each individual component.