README.md

   1 ![Shaarli logo](doc/images/doc-logo.png)
   2
   3 Shaarli, the personal, minimalist, super-fast, no-database delicious clone.
   4
   5 Do 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)
   9 [![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)
  10 [![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/)
  11
  12 ## Features
  13
  14  * Minimalist design (simple is beautiful)
  15  * **FAST**
  16  * Dead-simple installation: Drop the files, open the page. No database required.
  17  * Easy to use: Single button in your browser to bookmark a page (**bookmarklet**)
  18  * Save **URL, title, description** (unlimited size).
  19  * Classify, search and filter links with **tags**.
  20   * Tag autocompletion, renaming, merging and deletion.
  21  * Save links as **public or private**
  22  * Browse links by page, filter by tag or use the **full text search engine**
  23  * **Tag cloud**
  24  * **Picture wall** (which can be filtered by tag or text search)
  25  * **“Daily”** Newspaper-like digest, browsable by day.
  26  * **Permalinks** (with QR-Code) for easy reference
  27  * **RSS** and ATOM feeds
  28   * Can be filtered by tag or text search!
  29   * “Daily” RSS feed: Get each day a digest of all new links.
  30  * Can **import/export** Netscape bookmarks (for import/export from/to Firefox, Opera, Chrome, Delicious…)
  31  * Automatic **image/video thumbnails** for various services (imgur, imageshack.us, flickr, youtube, vimeo, dailymotion…)
  32  * Support for http/ftp/file/apt/magnet protocol links
  33   * URLs in descriptions are automatically converted to clickable links in descriptions
  34  * Easy backup (Data stored in a single file)
  35  * 1-click access to your private links/notes
  36  * Compact storage (1315 links stored in 150 kb)
  37  * Mobile browsers support
  38  * Also works with javascript disabled
  39  * Brute force protected login form
  40  * [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
  41  * Automatic removal of annoying FeedBurner/Google FeedProxy parameters in URL (?utm_source…)
  42  * Pages are easy to customize (using CSS and simple RainTPL templates)
  43  * Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery), session cookie hijacking.
  44  * You will be automatically notified by a discreet popup if a new version is available
  45  * **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)**
  46
  47 ## Demo
  48 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.
  49
  50 Login: `demo`
  51 Password: `demo`
  52
  53
  54 ## Links
  55
  56  * **[Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)**
  57  * [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
  58
  59
  60 ## Requirements
  61
  62 Check the [Server requirements](https://github.com/shaarli/Shaarli/wiki/Server-requirements) wiki page.
  63
  64 ## Installing
  65
  66  * Download the latest stable release from https://github.com/shaarli/Shaarli/releases
  67  * Unpack the archive in a directory on your web server
  68  * Visit this directory from a web browser.
  69  * Choose login, password, timezone and page title. Save.
  70
  71 _To get the development version, download https://github.com/shaarli/Shaarli/archive/master.zip or `git clone https://github.com/shaarli/Shaarli`_
  72
  73
  74 ## Upgrading
  75
  76  * **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.
  77  * **If you installed using `git clone`**: run `git pull` in your Shaarli directory.
  78
  79
  80 ## About
  81
  82 This friendly fork is maintained by the community at https://github.com/shaarli/Shaarli
  83
  84 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.
  85
  86
  87 ## License
  88
  89 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.