]>
Commit | Line | Data |
---|---|---|
1acc87ee | 1 | ![Shaarli logo](doc/images/doc-logo.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 | 7 | |
ae630270 | 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) |
fdc4c6a1 | 9 | |
cffa853a | 10 | ## Features: |
fdc4c6a1 SS |
11 | |
12 | * Minimalist design (simple is beautiful) | |
2d20481e | 13 | * **FAST** |
fdc4c6a1 | 14 | * Dead-simple installation: Drop the files, open the page. No database required. |
cffa853a | 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 | |
fdc4c6a1 | 32 | * Easy backup (Data stored in a single file) |
cffa853a | 33 | * 1-click access to your private links/notes |
fdc4c6a1 SS |
34 | * Compact storage (1315 links stored in 150 kb) |
35 | * Mobile browsers support | |
2d20481e | 36 | * Also works with javascript disabled |
2d20481e | 37 | * Brute force protected login form |
cffa853a | 38 | * [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support |
fdc4c6a1 | 39 | * Automatic removal of annoying FeedBurner/Google FeedProxy parameters in URL (?utm_source…) |
2d20481e | 40 | * Pages are easy to customize (using CSS and simple RainTPL templates) |
cffa853a | 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 | ||
569ffb59 | 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 | ||
e6ea0f96 | 51 | |
cffa853a | 52 | ## Links |
e6ea0f96 | 53 | |
cffa853a | 54 | * **[Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)** |
55 | * [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/) | |
56 | ||
fdc4c6a1 | 57 | |
cffa853a | 58 | ## Installing |
e6ea0f96 | 59 | |
d1e2f8e5 | 60 | Shaarli requires PHP 5.3. `php-gd` is optional and provides thumbnail resizing. |
fdc4c6a1 | 61 | |
cffa853a | 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. | |
fdc4c6a1 | 66 | |
cffa853a | 67 | _To get the development version, download https://github.com/shaarli/Shaarli/archive/master.zip or `git clone https://github.com/shaarli/Shaarli`_ |
fdc4c6a1 | 68 | |
e6ea0f96 | 69 | |
cffa853a | 70 | ## Upgrading |
e6ea0f96 | 71 | |
473f37a2 | 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. | |
fdc4c6a1 | 74 | |
fdc4c6a1 | 75 | |
cffa853a | 76 | ## About |
fdc4c6a1 | 77 | |
e6ea0f96 | 78 | This friendly fork is maintained by the community at https://github.com/shaarli/Shaarli |
fdc4c6a1 | 79 | |
e6ea0f96 | 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. |
fdc4c6a1 | 81 | |
e6ea0f96 | 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. | |
fdc4c6a1 | 86 |