]>
Commit | Line | Data |
---|---|---|
1 | # <img src="images/icon.png" width="20px" height="20px"> Shaarli | |
2 | ||
3 | The personal, minimalist, super-fast, database free, bookmarking service. | |
4 | ||
5 | Do you want to share the links you discover? | |
6 | Shaarli is a minimalist bookmark manager and link sharing service that you can install on your own server. | |
7 | It is designed to be personal (single-user), fast and handy. | |
8 | ||
9 | <!-- TODO screenshots --> | |
10 | ||
11 | Visit the pages in the sidebar to find information on how to setup, use, configure, tweak and troubleshoot Shaarli. | |
12 | ||
13 | ||
14 | * [GitHub project page](https://github.com/shaarli/Shaarli) | |
15 | * [Online documentation](https://shaarli.readthedocs.io/) | |
16 | * [Latest releases](https://github.com/shaarli/Shaarli/releases) | |
17 | * [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md) | |
18 | ||
19 | ||
20 | ## Demo | |
21 | ||
22 | You can use this [public demo instance of Shaarli](https://demo.shaarli.org). | |
23 | It runs the latest development version of Shaarli and is updated/reset daily. | |
24 | ||
25 | Login: `demo`; Password: `demo` | |
26 | ||
27 | ||
28 | ## Features | |
29 | ||
30 | Shaarli can be used: | |
31 | ||
32 | - to share, comment and save interesting links and news | |
33 | - to bookmark useful/frequent links and share them between computers | |
34 | - as a minimal blog/microblog/writing platform | |
35 | - as a read-it-later list | |
36 | - to draft and save articles/posts/ideas | |
37 | - to keep notes, documentation and code snippets | |
38 | - as a shared clipboard/notepad/pastebin between machines | |
39 | - as a todo list | |
40 | - to store media playlists | |
41 | - to keep extracts/comments from webpages that may disappear. | |
42 | - to keep track of ongoing discussions | |
43 | - to feed other blogs, aggregators, social networks... using RSS feeds | |
44 | ||
45 | ### Edit, view and search your links | |
46 | ||
47 | - Minimalist design | |
48 | - FAST | |
49 | - Customizable link titles and descriptions | |
50 | - Tags to organize your links (features tag autocompletion, renaming, merging and deletion) | |
51 | - Search by tag or using the full-text search | |
52 | - Public and private links (visible only to logged-in users) | |
53 | - Unique permalinks for easy reference | |
54 | - Paginated link list (with image and video thumbnails) | |
55 | - Tag cloud and list views | |
56 | - Picture wall: image and video thumbnails view (with lazy loading) | |
57 | - ATOM and RSS feeds (can also be filtered using tags or text search) | |
58 | - Daily: newspaper-like daily digest (and daily RSS feed) | |
59 | - URL cleanup: automatic removal of `?utm_source=...`, `fb=...` | |
60 | - Extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) | |
61 | ||
62 | ### Easy setup | |
63 | ||
64 | - Dead-simple installation: drop the files, open the page | |
65 | - Links are stored in a file (no database required, easy backup: simply copy the datastore file) | |
66 | - Import and export links as Netscape bookmarks compatible with most Web browsers | |
67 | ||
68 | ### Accessibility | |
69 | ||
70 | - Bookmarklet and other tools to share links in one click | |
71 | - Support for mobile browsers | |
72 | - Degrades gracefully with Javascript disabled | |
73 | - Easy page customization through HTML/CSS/RainTPL | |
74 | ||
75 | ### Security | |
76 | ||
77 | - Discreet pop-up notification when a new release is available | |
78 | - Bruteforce protection on the login form | |
79 | - Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) and session cookie hijacking | |
80 | ||
81 | <!-- TODO Limitations --> | |
82 | ||
83 | ### REST API | |
84 | ||
85 | - Easily extensible by any client using the REST API exposed by Shaarli ([API documentation](http://shaarli.github.io/api-documentation/)). | |
86 | ||
87 | ||
88 | ||
89 | ## Screenshots | |
90 | ||
91 | [![](https://i.imgur.com/8wEBRSG.png)](https://i.imgur.com/WWPfSj0.png) [![](https://i.imgur.com/rrsjWYy.png)](https://i.imgur.com/TZzGHMs.png) [![](https://i.imgur.com/uICDOle.png)](https://i.imgur.com/27wYsbC.png) [![](https://i.imgur.com/KNvFGVB.png)](https://i.imgur.com/0f5faqw.png) [![](https://i.imgur.com/tVvD3gH.png)](https://i.imgur.com/zGF4d6L.jpg) [![](https://i.imgur.com/8iRzHfe.png)](https://i.imgur.com/sfJJ6NT.png) [![](https://i.imgur.com/GjZGvIh.png)](https://i.imgur.com/QsedIuJ.png) [![](https://i.imgur.com/TFZ9PEq.png)](https://i.imgur.com/KdtF8Ll.png) [![](https://i.imgur.com/IvlqXXK.png)](https://i.imgur.com/boaaibC.png) [![](https://i.imgur.com/nlETouG.png)](https://i.imgur.com/Ib9O7n3.png) | |
92 | ||
93 | ||
94 | ||
95 | ||
96 | ||
97 | ## About | |
98 | ||
99 | ### Shaarli community fork | |
100 | ||
101 | This friendly fork is maintained by the Shaarli community at <https://github.com/shaarli/Shaarli> | |
102 | ||
103 | This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). | |
104 | ||
105 | 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. | |
106 | ||
107 | The Shaarli community has carried on the work to provide [many | |
108 | patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) for | |
109 | [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) | |
110 | in this repository, and will keep maintaining the project for the foreseeable | |
111 | future, while keeping Shaarli simple and efficient. | |
112 | ||
113 | ||
114 | ### Contributing and getting help | |
115 | ||
116 | Feedback is very appreciated! | |
117 | ||
118 | - If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) or read the current [issues](https://github.com/shaarli/Shaarli/issues). | |
119 | - Have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) and [pull requests](https://github.com/shaarli/Shaarli/pulls) | |
120 | - If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin). | |
121 | - If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). | |
122 | - Feel free to propose solutions to existing problems, help us improve the documentation and translations, and submit pull requests :-) | |
123 | ||
124 | ||
125 | ### License | |
126 | ||
127 | Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See | |
128 | [COPYING](https://github.com/shaarli/Shaarli/blob/master/COPYING) for a detail | |
129 | of the contributors and licenses for each individual component. A list of | |
130 | contributors is available | |
131 | [here](https://github.com/shaarli/Shaarli/blob/master/AUTHORS). | |
132 |