README.md

   1 ![Shaarli logo](doc/images/doc-logo.png)
   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 delicious clone that you can install on your own server._
   7 _It is designed to be personal (single-user), fast and handy._
   8
   9 [![](https://img.shields.io/badge/stable-v0.8.4-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.8.4)
  10 [![](https://img.shields.io/travis/shaarli/Shaarli/stable.svg?label=stable)](https://travis-ci.org/shaarli/Shaarli)
  11 &bull;
  12 [![](https://img.shields.io/badge/latest-v0.9.0-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.9.0)
  13 [![](https://img.shields.io/travis/shaarli/Shaarli/latest.svg?label=latest)](https://travis-ci.org/shaarli/Shaarli)
  14 &bull;
  15 [![](https://img.shields.io/badge/master-v0.9.x-blue.svg)](https://github.com/shaarli/Shaarli)
  16 [![](https://img.shields.io/travis/shaarli/Shaarli.svg?label=master)](https://travis-ci.org/shaarli/Shaarli)
  17
  18 [![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli)
  19 [![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues)
  20 [![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/)
  21
  22 ## Quickstart
  23 - [Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)
  24 - [Change log](CHANGELOG.md)
  25 - [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
  26
  27 ### Demo
  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.
  30
  31 Login: `demo`; Password: `demo`
  32
  33 ### Installation & upgrade
  34 - [Download and installation](https://github.com/shaarli/Shaarli/wiki/Download-and-Installation)
  35 - [Upgrade and migration](https://github.com/shaarli/Shaarli/wiki/Upgrade-and-migration)
  36 - [Server requirements](https://github.com/shaarli/Shaarli/wiki/Server-requirements)
  37 - [Server configuration](https://github.com/shaarli/Shaarli/wiki/Server-configuration)
  38 - [Shaarli configuration](https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration)
  39
  40 ## Features
  41 ### Interface
  42 - minimalist design (simple is beautiful)
  43 - FAST
  44 - ATOM and RSS feeds
  45 - views:
  46     - paginated link list
  47     - tag cloud
  48     - picture wall: image and video thumbnails
  49     - daily: newspaper-like daily digest
  50     - daily RSS feed
  51 - permalinks for easy reference
  52 - links can be public or private
  53 - extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage)
  54
  55 ### Tag, view and search your links!
  56 - add a custom title and description to archived links
  57 - add tags to classify and search links
  58     - features tag autocompletion, renaming, merging and deletion
  59 - full-text and tag search
  60
  61 ### Easy setup
  62 - dead-simple installation: drop the files, open the page
  63 - links are stored in a file
  64     - compact storage
  65     - no database required
  66     - easy backup: simply copy the datastore file
  67 - import and export links as Netscape bookmarks
  68
  69 ### Accessibility
  70 - Firefox bookmarlet to share links in one click
  71 - support for mobile browsers
  72 - works with Javascript disabled
  73 - easy page customization through HTML/CSS/RainTPL
  74
  75 ### Security
  76 - bruteforce-proof login form
  77 - protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
  78 and session cookie hijacking
  79
  80 ### Goodies
  81 - thumbnail generation for images and video services:
  82 dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
  83     - lazy-loading with [bLazy](http://dinbror.dk/blazy/)
  84 - [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
  85 - URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
  86 - discreet pop-up notification when a new release is available
  87
  88 ### REST API
  89
  90 Easily extensible by any client using the REST API exposed by Shaarli.
  91
  92 See the [API documentation](http://shaarli.github.io/api-documentation/).
  93
  94 ### Other usages
  95 Though Shaarli is primarily a bookmarking application, it can serve other purposes
  96 (see [usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)):
  97 - micro-blogging
  98 - pastebin
  99 - online notepad
 100 - snippet archive
 101
 102 ## About
 103 ### Shaarli community fork
 104 This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
 105
 106 This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
 107
 108 The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191)
 109 that he would have no time to work on Shaarli in the near future.
 110 The Shaarli community has carried on the work to provide
 111 [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master)
 112 for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+)
 113 in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.
 114
 115 ### Contributing
 116 If you'd like to help, please:
 117 - have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
 118 and [pull requests](https://github.com/shaarli/Shaarli/pulls)
 119 - feel free to report bugs (feedback is much appreciated)
 120 - suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki)
 121 - propose solutions to existing problems
 122 - submit pull requests :-)
 123
 124
 125 ### License
 126 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.