]>
Commit | Line | Data |
---|---|---|
12e18779 | 1 | # [Shaarli](https://github.com/shaarli/Shaarli/) documentation |
1acc87ee | 2 | |
bdfb967c | 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 link sharing service that you can install on your own server. | |
7 | It is designed to be personal (single-user), fast and handy. | |
8 | ||
87f14312 | 9 | <!-- TODO screenshots --> |
1acc87ee | 10 | |
bdfb967c | 11 | Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. |
12 | For general information, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). | |
1acc87ee | 13 | |
12e18779 | 14 | 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). |
bdfb967c | 15 | |
12e18779 | 16 | If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). |
1acc87ee | 17 | |
53ed6d7d | 18 | 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). |
1acc87ee | 19 | |
bdfb967c | 20 | * [GitHub project page](https://github.com/shaarli/Shaarli) |
21 | * [Online documentation](https://shaarli.readthedocs.io/) (this page) | |
22 | * [Latest Shaarli releases](https://github.com/shaarli/Shaarli/releases) | |
23 | * [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md) | |
12e18779 | 24 | |
12e18779 | 25 | |
26 | ### Demo | |
27 | ||
28 | You can use this [public demo instance of Shaarli](https://demo.shaarli.org). | |
29 | It runs the latest development version of Shaarli and is updated/reset daily. | |
30 | ||
31 | Login: `demo`; Password: `demo` | |
32 | ||
87f14312 | 33 | <!-- TODO review everything below this point --> |
bdfb967c | 34 | |
35 | ||
12e18779 | 36 | ## Features |
37 | ||
4ada0d31 | 38 | Shaarli can be used: |
39 | ||
40 | - to share, comment and save interesting links and news. | |
41 | - to bookmark useful/frequent personal links (as private links) and share them between computers. | |
42 | - as a minimal blog/microblog/writing platform (no character limit). | |
43 | - as a read-it-later list (for example items tagged `readlater`). | |
44 | - to draft and save articles/posts/ideas. | |
45 | - to keep code snippets. | |
46 | - to keep notes and documentation. | |
47 | - as a shared clipboard/notepad/pastebin between machines. | |
48 | - as a todo list. | |
49 | - to store playlists (e.g. with the `music` or `video` tags). | |
50 | - to keep extracts/comments from webpages that may disappear. | |
51 | - to keep track of ongoing discussions (for example items tagged `discussion`). | |
52 | - [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags. | |
53 | - to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...). | |
54 | ||
12e18779 | 55 | ### Interface |
bdfb967c | 56 | |
12e18779 | 57 | - minimalist design (simple is beautiful) |
58 | - FAST | |
59 | - ATOM and RSS feeds | |
60 | - views: | |
bdfb967c | 61 | - paginated link list (with image and video thumbnails) |
12e18779 | 62 | - tag cloud |
bdfb967c | 63 | - picture wall: image and video thumbnails (with lazy loading) |
12e18779 | 64 | - daily: newspaper-like daily digest |
65 | - daily RSS feed | |
66 | - permalinks for easy reference | |
67 | - links can be public or private | |
bdfb967c | 68 | - thumbnail generation for images and video services |
69 | - URL cleanup: automatic removal of `?utm_source=...`, `fb=...` | |
cc8f572b | 70 | - extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) |
12e18779 | 71 | |
bdfb967c | 72 | ### Tag, view and search your links |
73 | ||
12e18779 | 74 | - add a custom title and description to archived links |
75 | - add tags to classify and search links | |
bdfb967c | 76 | - features tag autocompletion, renaming, merging and deletion |
12e18779 | 77 | - full-text and tag search |
78 | ||
79 | ### Easy setup | |
bdfb967c | 80 | |
12e18779 | 81 | - dead-simple installation: drop the files, open the page |
82 | - links are stored in a file | |
83 | - compact storage | |
84 | - no database required | |
85 | - easy backup: simply copy the datastore file | |
86 | - import and export links as Netscape bookmarks | |
87 | ||
88 | ### Accessibility | |
bdfb967c | 89 | |
90 | - bookmarlet to share links in one click | |
12e18779 | 91 | - support for mobile browsers |
bdfb967c | 92 | - degrades gracefully with Javascript disabled |
12e18779 | 93 | - easy page customization through HTML/CSS/RainTPL |
94 | ||
95 | ### Security | |
bdfb967c | 96 | |
12e18779 | 97 | - discreet pop-up notification when a new release is available |
bdfb967c | 98 | - bruteforce protection on the login form |
99 | - protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) and session cookie hijacking | |
100 | ||
87f14312 | 101 | <!-- TODO Limitations --> |
12e18779 | 102 | |
103 | ### REST API | |
104 | ||
105 | Easily extensible by any client using the REST API exposed by Shaarli. | |
106 | ||
107 | See the [API documentation](http://shaarli.github.io/api-documentation/). | |
108 | ||
12e18779 | 109 | ## About |
bdfb967c | 110 | |
12e18779 | 111 | ### Shaarli community fork |
bdfb967c | 112 | |
12e18779 | 113 | This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli |
114 | ||
115 | This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). | |
116 | ||
bdfb967c | 117 | 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. |
118 | ||
87f14312 V |
119 | The Shaarli community has carried on the work to provide [many |
120 | patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) for | |
121 | [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) | |
122 | in this repository, and will keep maintaining the project for the foreseeable | |
123 | future, while keeping Shaarli simple and efficient. | |
bdfb967c | 124 | |
12e18779 | 125 | |
126 | ### Contributing | |
bdfb967c | 127 | |
12e18779 | 128 | If you'd like to help, please: |
87f14312 | 129 | |
12e18779 | 130 | - have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) |
131 | and [pull requests](https://github.com/shaarli/Shaarli/pulls) | |
132 | - feel free to report bugs (feedback is much appreciated) | |
bdfb967c | 133 | - suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/tree/master/doc/md/) |
12e18779 | 134 | - propose solutions to existing problems |
135 | - submit pull requests :-) | |
136 | ||
137 | ||
138 | ### License | |
bdfb967c | 139 | |
87f14312 V |
140 | Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See |
141 | [COPYING](https://github.com/shaarli/Shaarli/blob/master/COPYING) for a detail | |
142 | of the contributors and licenses for each individual component. A list of | |
143 | contributors is available | |
144 | [here](https://github.com/shaarli/Shaarli/blob/master/AUTHORS). | |
12e18779 | 145 |