]>
Commit | Line | Data |
---|---|---|
cffa853a | 1 | ![Shaarli logo](https://cdn.mediacru.sh/W2NGCIHB3quT.png) |
ab7ac187 | 2 | |
2d20481e | 3 | Shaarli, the personal, minimalist, super-fast, no-database delicious clone. |
fdc4c6a1 SS |
4 | |
5 | You want to share the links you discover ? Shaarli is a minimalist delicious clone you can install on your own website. | |
cffa853a | 6 | It 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 | ||
44 | ## Links | |
45 | * **[Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)** | |
46 | * [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/) | |
47 | ||
fdc4c6a1 | 48 | |
cffa853a | 49 | ## Installing |
50 | Shaarli requires php 5.1 | |
fdc4c6a1 | 51 | |
cffa853a | 52 | * Download the latest stable release from https://github.com/shaarli/Shaarli/releases |
53 | * Unpack the archive in a directory on your web server | |
54 | * Visit this directory from a web browser. | |
55 | * Choose login, password, timezone and page title. Save. | |
fdc4c6a1 | 56 | |
cffa853a | 57 | _To get the development version, download https://github.com/shaarli/Shaarli/archive/master.zip or `git clone https://github.com/shaarli/Shaarli`_ |
fdc4c6a1 | 58 | |
cffa853a | 59 | ## Upgrading |
60 | Delete all files and directories except the `data` directory, then unzip the new version of Shaarli. | |
61 | You will not lose your links and you will not have to reconfigure it. | |
fdc4c6a1 | 62 | |
fdc4c6a1 | 63 | |
cffa853a | 64 | ## Screenshots |
fdc4c6a1 | 65 | |
cffa853a | 66 | [![](https://cdn.mediacru.sh/AjZc6-emICeO.png)](https://cdn.mediacru.sh/kE8SyD-PvGuC.png) [![](https://cdn.mediacru.sh/MfC-DzklMYs2.png)](https://cdn.mediacru.sh/iqTvO1-yP9pU.png) [![](https://cdn.mediacru.sh/dxmXskaubYcg.png)](https://cdn.mediacru.sh/mMoi31f94wdL.png) [![](https://cdn.mediacru.sh/-ptB2veFivBp.png)](https://cdn.mediacru.sh/GcoZPZmCZ-DR.png) [![](https://cdn.mediacru.sh/QmRdTAr8x427.png)](https://cdn.mediacru.sh/TDDujpMWT31q.png) |
fdc4c6a1 | 67 | |
cffa853a | 68 | ## About |
fdc4c6a1 | 69 | |
cffa853a | 70 | Original Project page: http://sebsauvage.net/wiki/doku.php?id=php:shaarli |
71 | Shaarli is developed by [Sébastien SAUVAGE](http://sebsauvage.net) and [contributors](COPYING). | |
fdc4c6a1 | 72 | |
cffa853a | 73 | Shaarli is [Free Software](https://en.wikipedia.org/wiki/Free_software) distributed under the [zlib/libpng License](http://www.gzip.org/zlib/zlib_license.html) |
fdc4c6a1 | 74 | |
cffa853a | 75 | This friendly fork is maintained by the community at https://github.com/shaarli/Shaarli |
fdc4c6a1 | 76 |