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