]>
Commit | Line | Data |
---|---|---|
1 | # [Shaarli](https://github.com/shaarli/Shaarli/) documentation | |
2 | ||
3 | Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. | |
4 | ||
5 | For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). | |
6 | ||
7 | 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). | |
8 | If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). | |
9 | ||
10 | 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). | |
11 | ||
12 | _Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the `doc/html/` directory of your Shaarli installation._ | |
13 | ||
14 | [![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli) | |
15 | [![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues) | |
16 | [![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/) | |
17 | ||
18 | ### Demo | |
19 | ||
20 | You can use this [public demo instance of Shaarli](https://demo.shaarli.org). | |
21 | It runs the latest development version of Shaarli and is updated/reset daily. | |
22 | ||
23 | Login: `demo`; Password: `demo` | |
24 | ||
25 | ||
26 | ## Features | |
27 | ||
28 | ### Interface | |
29 | - minimalist design (simple is beautiful) | |
30 | - FAST | |
31 | - ATOM and RSS feeds | |
32 | - views: | |
33 | - paginated link list | |
34 | - tag cloud | |
35 | - picture wall: image and video thumbnails | |
36 | - daily: newspaper-like daily digest | |
37 | - daily RSS feed | |
38 | - permalinks for easy reference | |
39 | - links can be public or private | |
40 | - extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) | |
41 | ||
42 | ### Tag, view and search your links! | |
43 | - add a custom title and description to archived links | |
44 | - add tags to classify and search links | |
45 | - features tag autocompletion, renaming, merging and deletion | |
46 | - full-text and tag search | |
47 | ||
48 | ### Easy setup | |
49 | - dead-simple installation: drop the files, open the page | |
50 | - links are stored in a file | |
51 | - compact storage | |
52 | - no database required | |
53 | - easy backup: simply copy the datastore file | |
54 | - import and export links as Netscape bookmarks | |
55 | ||
56 | ### Accessibility | |
57 | - Firefox bookmarlet to share links in one click | |
58 | - support for mobile browsers | |
59 | - works with Javascript disabled | |
60 | - easy page customization through HTML/CSS/RainTPL | |
61 | ||
62 | ### Security | |
63 | - bruteforce-proof login form | |
64 | - protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) | |
65 | and session cookie hijacking | |
66 | ||
67 | ### Goodies | |
68 | - thumbnail generation for images and video services: | |
69 | dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube... | |
70 | - lazy-loading with [bLazy](http://dinbror.dk/blazy/) | |
71 | - [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support | |
72 | - URL cleanup: automatic removal of `?utm_source=...`, `fb=...` | |
73 | - discreet pop-up notification when a new release is available | |
74 | ||
75 | ### REST API | |
76 | ||
77 | Easily extensible by any client using the REST API exposed by Shaarli. | |
78 | ||
79 | See the [API documentation](http://shaarli.github.io/api-documentation/). | |
80 | ||
81 | ### Other usages | |
82 | Though Shaarli is primarily a bookmarking application, it can serve other purposes | |
83 | (see [Features](Features)): | |
84 | ||
85 | - micro-blogging | |
86 | - pastebin | |
87 | - online notepad | |
88 | - snippet archive | |
89 | ||
90 | ## About | |
91 | ### Shaarli community fork | |
92 | This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli | |
93 | ||
94 | This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). | |
95 | ||
96 | The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) | |
97 | that he would have no time to work on Shaarli in the near future. | |
98 | The Shaarli community has carried on the work to provide | |
99 | [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) | |
100 | for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) | |
101 | in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient. | |
102 | ||
103 | ### Contributing | |
104 | If you'd like to help, please: | |
105 | - have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) | |
106 | and [pull requests](https://github.com/shaarli/Shaarli/pulls) | |
107 | - feel free to report bugs (feedback is much appreciated) | |
108 | - suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki) | |
109 | - propose solutions to existing problems | |
110 | - submit pull requests :-) | |
111 | ||
112 | ||
113 | ### License | |
114 | 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. | |
115 |