README.md

   1 ![Shaarli logo](doc/images/doc-logo.png)
   2
   3 Shaarli, the personal, minimalist, super-fast, no-database delicious clone.
   4
   5 You want to share the links you discover ? Shaarli is a minimalist delicious clone you can install on your own website.
   6 It is designed to be personal (single-user), fast and handy.
   7
   8 [![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli) [![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues) [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli)
   9
  10 ## Features:
  11
  12  * Minimalist design (simple is beautiful)
  13  * **FAST**
  14  * Dead-simple installation: Drop the files, open the page. No database required.
  15  * Easy to use: Single button in your browser to bookmark a page (**bookmarklet**)
  16  * Save **URL, title, description** (unlimited size).
  17  * Classify, search and filter links with **tags**.
  18   * Tag autocompletion, renaming, merging and deletion.
  19  * Save links as **public or private**
  20  * Browse links by page, filter by tag or use the **full text search engine**
  21  * **Tag cloud**
  22  * **Picture wall** (which can be filtered by tag or text search)
  23  * **“Daily”** Newspaper-like digest, browsable by day.
  24  * **Permalinks** (with QR-Code) for easy reference
  25  * **RSS** and ATOM feeds
  26   * Can be filtered by tag or text search!
  27   * “Daily” RSS feed: Get each day a digest of all new links.
  28  * Can **import/export** Netscape bookmarks (for import/export from/to Firefox, Opera, Chrome, Delicious…)
  29  * Automatic **image/video thumbnails** for various services (imgur, imageshack.us, flickr, youtube, vimeo, dailymotion…)
  30  * Support for http/ftp/file/apt/magnet protocol links
  31   * URLs in descriptions are automatically converted to clickable links in descriptions
  32  * Easy backup (Data stored in a single file)
  33  * 1-click access to your private links/notes
  34  * Compact storage (1315 links stored in 150 kb)
  35  * Mobile browsers support
  36  * Also works with javascript disabled
  37  * Brute force protected login form
  38  * [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
  39  * Automatic removal of annoying FeedBurner/Google FeedProxy parameters in URL (?utm_source…)
  40  * Pages are easy to customize (using CSS and simple RainTPL templates)
  41  * Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery), session cookie hijacking.
  42  * You will be automatically notified by a discreet popup if a new version is available
  43  * **Shaarli is a bookmarking application, but you can use it for micro-blogging (like Twitter), a pastebin, an online notepad, a snippet repository, etc. See [Usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)**
  44
  45 ## Demo
  46 You can use this [public demo instance of Shaarli](http://shaarlidemo.tuxfamily.org/Shaarli). This demo runs the latest _development version_ of Shaarli and is updated/reset every day.
  47
  48 Login: `demo`
  49 Password: `demo`
  50
  51
  52 ## Links
  53
  54  * **[Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)**
  55  * [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
  56
  57
  58 ## Installing
  59
  60 Shaarli requires php 5.1. `php-gd` is optional and provides thumbnail resizing.
  61
  62  * Download the latest stable release from https://github.com/shaarli/Shaarli/releases
  63  * Unpack the archive in a directory on your web server
  64  * Visit this directory from a web browser.
  65  * Choose login, password, timezone and page title. Save.
  66
  67 _To get the development version, download https://github.com/shaarli/Shaarli/archive/master.zip or `git clone https://github.com/shaarli/Shaarli`_
  68
  69
  70 ## Upgrading
  71
  72  * **If you installed from the zip:** Delete all files and directories except the `data` directory, then unzip the new version of Shaarli.  You will not lose your links and you will not have to reconfigure it.
  73  * **If you installed using `git clone`**: run `git pull` in your Shaarli directory.
  74
  75
  76 ## About
  77
  78 This friendly fork is maintained by the community at https://github.com/shaarli/Shaarli
  79
  80 This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [sebsauvage](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. If you'd like to help, have a look at the current [issues](https://github.com/shaarli/Shaarli/issues) and [pull requests](https://github.com/shaarli/Shaarli/pulls) and feel free to report bugs and feature requests, propose solutions to existing problems and send us pull requests.
  81
  82
  83 ## License
  84
  85 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.
  86