[github/shaarli/Shaarli.git] / doc / md / index.md

# <img src="images/icon.png" width="20px" height="20px"> Shaarli

The personal, minimalist, super-fast, database free, bookmarking service.

Do you want to share the links you discover?
Shaarli is a minimalist bookmark manager and link sharing service that you can install on your own server.
It is designed to be personal (single-user), fast and handy.

<!-- TODO screenshots -->

Visit the pages in the sidebar to find information on how to setup, use, configure, tweak and troubleshoot Shaarli.


* [GitHub project page](https://github.com/shaarli/Shaarli)
* [Online documentation](https://shaarli.readthedocs.io/)
* [Latest releases](https://github.com/shaarli/Shaarli/releases)
* [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md)


### Demo

You can use this [public demo instance of Shaarli](https://demo.shaarli.org).
It runs the latest development version of Shaarli and is updated/reset daily.

Login: `demo`; Password: `demo`

## Features

Shaarli can be used:

- to share, comment and save interesting links and news
- to bookmark useful/frequent links and share them between computers
- as a minimal blog/microblog/writing platform
- as a read-it-later list
- to draft and save articles/posts/ideas
- to keep notes, documentation and code snippets
- as a shared clipboard/notepad/pastebin between machines
- as a todo list
- to store media playlists
- to keep extracts/comments from webpages that may disappear.
- to keep track of ongoing discussions
- to feed other blogs, aggregators, social networks... using RSS feeds

### Edit, view and search your links

- Minimalist design
- FAST
- Customizable link titles and descriptions
- Tags to organize your links (features tag autocompletion, renaming, merging and deletion)
- Search by tag or using the full-text search
- Public and private links (visible only to logged-in users)
- Unique permalinks for easy reference
- Paginated link list (with image and video thumbnails)
- Tag cloud and list views
- Picture wall: image and video thumbnails view (with lazy loading)
- ATOM and RSS feeds (can also be filtered using tags or text search)
- Daily: newspaper-like daily digest (and daily RSS feed)
- URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
- Extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage)

### Easy setup

- Dead-simple installation: drop the files, open the page
- Links are stored in a file (no database required, easy backup: simply copy the datastore file)
- Import and export links as Netscape bookmarks compatible with most Web browsers

### Accessibility

- Bookmarklet and other tools to share links in one click
- Support for mobile browsers
- Degrades gracefully with Javascript disabled
- Easy page customization through HTML/CSS/RainTPL

### Security

- Discreet pop-up notification when a new release is available
- Bruteforce protection on the login form
- Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) and session cookie hijacking

<!-- TODO Limitations -->

### REST API

- Easily extensible by any client using the REST API exposed by Shaarli ([API documentation](http://shaarli.github.io/api-documentation/)).

## 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](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).

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.

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.


### Contributing and getting help

Feedback is very appreciated!

- 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).
- Have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) and [pull requests](https://github.com/shaarli/Shaarli/pulls)
- 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).
- If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).
- Feel free to propose solutions to existing problems, help us improve the documentation and translations, and submit pull requests :-)


### License

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).
Commit	Line	Data
	1	# <img src="images/icon.png" width="20px" height="20px"> Shaarli
	2
	3	The personal, minimalist, super-fast, database free, bookmarking service.
	4
	5	Do you want to share the links you discover?
	6	Shaarli is a minimalist bookmark manager and link sharing service that you can install on your own server.
	7	It is designed to be personal (single-user), fast and handy.
	8
	9	<!-- TODO screenshots -->
	10
	11	Visit the pages in the sidebar to find information on how to setup, use, configure, tweak and troubleshoot Shaarli.
	12
	13
	14	* [GitHub project page](https://github.com/shaarli/Shaarli)
	15	* [Online documentation](https://shaarli.readthedocs.io/)
	16	* [Latest releases](https://github.com/shaarli/Shaarli/releases)
	17	* [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md)
	18
	19
	20	### Demo
	21
	22	You can use this [public demo instance of Shaarli](https://demo.shaarli.org).
	23	It runs the latest development version of Shaarli and is updated/reset daily.
	24
	25	Login: `demo`; Password: `demo`
	26
	27	## Features
	28
	29	Shaarli can be used:
	30
	31	- to share, comment and save interesting links and news
	32	- to bookmark useful/frequent links and share them between computers
	33	- as a minimal blog/microblog/writing platform
	34	- as a read-it-later list
	35	- to draft and save articles/posts/ideas
	36	- to keep notes, documentation and code snippets
	37	- as a shared clipboard/notepad/pastebin between machines
	38	- as a todo list
	39	- to store media playlists
	40	- to keep extracts/comments from webpages that may disappear.
	41	- to keep track of ongoing discussions
	42	- to feed other blogs, aggregators, social networks... using RSS feeds
	43
	44	### Edit, view and search your links
	45
	46	- Minimalist design
	47	- FAST
	48	- Customizable link titles and descriptions
	49	- Tags to organize your links (features tag autocompletion, renaming, merging and deletion)
	50	- Search by tag or using the full-text search
	51	- Public and private links (visible only to logged-in users)
	52	- Unique permalinks for easy reference
	53	- Paginated link list (with image and video thumbnails)
	54	- Tag cloud and list views
	55	- Picture wall: image and video thumbnails view (with lazy loading)
	56	- ATOM and RSS feeds (can also be filtered using tags or text search)
	57	- Daily: newspaper-like daily digest (and daily RSS feed)
	58	- URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
	59	- Extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage)
	60
	61	### Easy setup
	62
	63	- Dead-simple installation: drop the files, open the page
	64	- Links are stored in a file (no database required, easy backup: simply copy the datastore file)
	65	- Import and export links as Netscape bookmarks compatible with most Web browsers
	66
	67	### Accessibility
	68
	69	- Bookmarklet and other tools to share links in one click
	70	- Support for mobile browsers
	71	- Degrades gracefully with Javascript disabled
	72	- Easy page customization through HTML/CSS/RainTPL
	73
	74	### Security
	75
	76	- Discreet pop-up notification when a new release is available
	77	- Bruteforce protection on the login form
	78	- Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) and session cookie hijacking
	79
	80	<!-- TODO Limitations -->
	81
	82	### REST API
	83
	84	- Easily extensible by any client using the REST API exposed by Shaarli ([API documentation](http://shaarli.github.io/api-documentation/)).
	85
	86	## About
	87
	88	### Shaarli community fork
	89
	90	This friendly fork is maintained by the Shaarli community at <https://github.com/shaarli/Shaarli>
	91
	92	This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
	93
	94	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.
	95
	96	The Shaarli community has carried on the work to provide [many
	97	patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) for
	98	[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
	100	future, while keeping Shaarli simple and efficient.
	101
	102
	103	### Contributing and getting help
	104
	105	Feedback is very appreciated!
	106
	107	- 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).
	108	- Have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) and [pull requests](https://github.com/shaarli/Shaarli/pulls)
	109	- 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).
	110	- If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).
	111	- Feel free to propose solutions to existing problems, help us improve the documentation and translations, and submit pull requests :-)
	112
	113
	114	### License
	115
	116	Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See
	117	[COPYING](https://github.com/shaarli/Shaarli/blob/master/COPYING) for a detail
	118	of the contributors and licenses for each individual component. A list of
	119	contributors is available
	120	[here](https://github.com/shaarli/Shaarli/blob/master/AUTHORS).
	121