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 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, and locally in the doc/html/ directory of your Shaarli installation.

Join the chat at Bountysource Docker repository


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


Shaarli can be used:


Tag, view and search your links!

Easy setup





Easily extensible by any client using the REST API exposed by Shaarli.

See the API documentation.

Using Shaarli as a blog, notepad, pastebin...


Shaarli community fork

This friendly fork is maintained by the Shaarli community at

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.


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 :-)


Shaarli is Free Software. See COPYING for a detail of the contributors and licenses for each individual component.