]>
Commit | Line | Data |
---|---|---|
02c70f62 | 1 | # <img src="images/icon.png" width="20px" height="20px"> Shaarli |
1acc87ee | 2 | |
bdfb967c | 3 | The personal, minimalist, super-fast, database free, bookmarking service. |
4 | ||
91a21c27 | 5 | Do you want to share the links you discover? Shaarli is a minimalist bookmark manager and link sharing service that you can install on your own server. It is designed to be personal (single-user), fast and handy. |
1acc87ee | 6 | |
b817fb0d | 7 | Visit the pages in the sidebar to find information on how to setup, use, configure, tweak and troubleshoot Shaarli. |
1acc87ee | 8 | |
bdfb967c | 9 | * [GitHub project page](https://github.com/shaarli/Shaarli) |
91a21c27 | 10 | * [Documentation](https://shaarli.readthedocs.io/) |
bdfb967c | 11 | * [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md) |
12e18779 | 12 | |
12e18779 | 13 | |
91a21c27 | 14 | [![](https://i.imgur.com/8wEBRSG.png)](https://i.imgur.com/WWPfSj0.png) [![](https://i.imgur.com/93PpLLs.png)](https://i.imgur.com/V09kAQt.png) [![](https://i.imgur.com/rrsjWYy.png)](https://i.imgur.com/TZzGHMs.png) [![](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/uICDOle.png)](https://i.imgur.com/27wYsbC.png) [![](https://i.imgur.com/tVvD3gH.png)](https://i.imgur.com/zGF4d6L.jpg) |
15 | ||
16 | ||
17 | ||
424ae4b0 | 18 | ## Demo |
12e18779 | 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 | ||
424ae4b0 | 25 | |
91a21c27 | 26 | ## Getting started |
27 | ||
28 | - [Configure your server](Server-configuration.md) | |
29 | - [Install Shaarli](Installation.md) | |
30 | - Or install Shaarli using [Docker](Docker.md) | |
31 | ||
32 | ||
12e18779 | 33 | ## Features |
34 | ||
4ada0d31 | 35 | Shaarli can be used: |
36 | ||
91a21c27 | 37 | - to share, comment and save interesting links |
b817fb0d | 38 | - to bookmark useful/frequent links and share them between computers |
39 | - as a minimal blog/microblog/writing platform | |
91a21c27 | 40 | - as a read-it-later/todo list |
41 | - as a notepad to draft and save articles/posts/ideas | |
42 | - as a knowledge base to keep notes, documentation and code snippets | |
43 | - as a shared clipboard/notepad/pastebin between computers | |
44 | - as playlist manager for online media | |
45 | - to feed other blogs, aggregators, social networks... | |
4ada0d31 | 46 | |
b817fb0d | 47 | ### Edit, view and search your links |
bdfb967c | 48 | |
91a21c27 | 49 | - Editable URL, title, description, tags, private/public status for all your [Shaares](Usage.md) |
50 | - [Tags](Usage.md#tags) to organize your Shaares | |
51 | - [Search](Usage.md#search) in all fields | |
52 | - Unique [permalinks](Usage.md#permalinks) for easy reference | |
53 | - Paginated Shaares list view (with image and video thumbnails) | |
54 | - [Tag cloud/list](Usage#tag-cloud) views | |
55 | - [Picture wall](Usage#picture-wall)/thumbnails view (with lazy loading) | |
56 | - [ATOM and RSS feeds](Usage.md#rss-feeds) (can also be filtered using tags or text search) | |
57 | - [Daily](Usage.md#daily): newspaper-like daily digest (and daily RSS feed) | |
58 | - URL cleanup: automatic removal of `?utm_source=...`, `fb=...` tracking parameters | |
59 | - Extensible through [plugins](Plugins.md) | |
60 | - Easily extensible by any client using the [REST API](REST-API.md) exposed by Shaarli | |
61 | - Bookmarklet and [other tools](Community-and-related-software.md) to share links in one click | |
62 | - Responsive/support for mobile browsers, degrades gracefully with Javascript disabled | |
bdfb967c | 63 | |
12e18779 | 64 | |
91a21c27 | 65 | ### Easy setup |
12e18779 | 66 | |
91a21c27 | 67 | - Dead-simple [installation](Installation.md): drop the files on your server, open the page |
68 | - Shaares are stored in a file (no database required, easy [backup](Backup-and-restore.md)) | |
69 | - [Configurable](Shaarli-configuration.md) from dialog and configuration file | |
70 | - Extensible through third-party [plugins and themes](Community-and-related-software.md) | |
424ae4b0 | 71 | |
72 | ||
91a21c27 | 73 | ### Fast |
424ae4b0 | 74 | |
91a21c27 | 75 | - Fast! Small datastore file, write-once/read-many, served most of the time from OS disk caches (no disk I/O) |
76 | - Stays fast with even tens of thousands shaares! | |
424ae4b0 | 77 | |
78 | ||
91a21c27 | 79 | ### Self-hosted |
424ae4b0 | 80 | |
91a21c27 | 81 | - Shaarli is an alternative to commercial services such as StumbleUpon, Delicio.us, Diigo... |
82 | - The data is yours, [import and export](Usage#import-export) it to HTML bookmarksformat compatible with most web browser, and from a variety of formats | |
83 | - Shaarli does not send any telemetry/metrics/private information to developers | |
84 | - Shaarli is Free and Open-Source software, inspect and change how the program works in the [source code](https://github.com/shaarli/Shaarli) | |
85 | - Built-in [Security](dev/Development.md#security) features to help you protect your Shaarli instance | |
424ae4b0 | 86 | |
87 | ||
12e18779 | 88 | ## About |
bdfb967c | 89 | |
91a21c27 | 90 | This [community fork](https://github.com/shaarli/Shaarli) of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/) (now [unmaintained](https://github.com/sebsauvage/Shaarli/issues/191)) 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. |
bdfb967c | 91 | |
91a21c27 | 92 | The original Shaarli instance is still available [here](https://sebsauvage.net/links/) (+25000 shaares!) |
bdfb967c | 93 | |
12e18779 | 94 | |
b817fb0d | 95 | ### Contributing and getting help |
bdfb967c | 96 | |
91a21c27 | 97 | Feedback is very appreciated! Feel free to propose solutions to existing problems, help us improve the documentation and translations, and submit pull requests :-) |
87f14312 | 98 | |
91a21c27 | 99 | See [Support](Troubleshooting.md#support) to get in touch with the Shaarli community. |
12e18779 | 100 | |
101 | ||
102 | ### License | |
bdfb967c | 103 | |
87f14312 V |
104 | Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See |
105 | [COPYING](https://github.com/shaarli/Shaarli/blob/master/COPYING) for a detail | |
106 | of the contributors and licenses for each individual component. A list of | |
107 | contributors is available | |
108 | [here](https://github.com/shaarli/Shaarli/blob/master/AUTHORS). | |
12e18779 | 109 |