X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2Findex.md;h=2c4995f8acaa875aa1d13795c5818d441b471291;hb=91a21c272960889afd4eaa431a3d29b7785b6efc;hp=e77b4d3a18c59468663fbfbc0c783fb677222f03;hpb=12db590e8fe53c46ca2ee81c240f1d671881a139;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/index.md b/doc/md/index.md index e77b4d3a..2c4995f8 100644 --- a/doc/md/index.md +++ b/doc/md/index.md @@ -1,129 +1,109 @@ -# [Shaarli](https://github.com/shaarli/Shaarli/) documentation +# Shaarli -Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. +The personal, minimalist, super-fast, database free, bookmarking service. -For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). +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. -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). -If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). +Visit the pages in the sidebar to find information on how to setup, use, configure, tweak and troubleshoot Shaarli. -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). +* [GitHub project page](https://github.com/shaarli/Shaarli) +* [Documentation](https://shaarli.readthedocs.io/) +* [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md) -_Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the `doc/html/` directory of your Shaarli installation._ -[![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) -[![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/) +[![](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) -### Demo + + +## Demo You can use this [public demo instance of Shaarli](https://demo.shaarli.org). It runs the latest development version of Shaarli and is updated/reset daily. Login: `demo`; Password: `demo` + +## Getting started + +- [Configure your server](Server-configuration.md) +- [Install Shaarli](Installation.md) +- Or install Shaarli using [Docker](Docker.md) + + ## Features Shaarli can be used: -- to share, comment and save interesting links and news. -- to bookmark useful/frequent personal links (as private links) and share them between computers. -- as a minimal blog/microblog/writing platform (no character limit). -- as a read-it-later list (for example items tagged `readlater`). -- to draft and save articles/posts/ideas. -- to keep code snippets. -- to keep notes and documentation. -- as a shared clipboard/notepad/pastebin between machines. -- as a todo list. -- to store playlists (e.g. with the `music` or `video` tags). -- to keep extracts/comments from webpages that may disappear. -- to keep track of ongoing discussions (for example items tagged `discussion`). -- [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags. -- to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...). - -### Interface -- minimalist design (simple is beautiful) -- FAST -- ATOM and RSS feeds -- views: - - paginated link list - - tag cloud - - picture wall: image and video thumbnails - - daily: newspaper-like daily digest - - daily RSS feed -- permalinks for easy reference -- links can be public or private -- extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) - -### Tag, view and search your links! -- add a custom title and description to archived links -- add tags to classify and search links - - features tag autocompletion, renaming, merging and deletion -- full-text and tag search +- to share, comment and save interesting links +- to bookmark useful/frequent links and share them between computers +- as a minimal blog/microblog/writing platform +- as a read-it-later/todo list +- as a notepad to draft and save articles/posts/ideas +- as a knowledge base to keep notes, documentation and code snippets +- as a shared clipboard/notepad/pastebin between computers +- as playlist manager for online media +- to feed other blogs, aggregators, social networks... + +### Edit, view and search your links + +- Editable URL, title, description, tags, private/public status for all your [Shaares](Usage.md) +- [Tags](Usage.md#tags) to organize your Shaares +- [Search](Usage.md#search) in all fields +- Unique [permalinks](Usage.md#permalinks) for easy reference +- Paginated Shaares list view (with image and video thumbnails) +- [Tag cloud/list](Usage#tag-cloud) views +- [Picture wall](Usage#picture-wall)/thumbnails view (with lazy loading) +- [ATOM and RSS feeds](Usage.md#rss-feeds) (can also be filtered using tags or text search) +- [Daily](Usage.md#daily): newspaper-like daily digest (and daily RSS feed) +- URL cleanup: automatic removal of `?utm_source=...`, `fb=...` tracking parameters +- Extensible through [plugins](Plugins.md) +- Easily extensible by any client using the [REST API](REST-API.md) exposed by Shaarli +- Bookmarklet and [other tools](Community-and-related-software.md) to share links in one click +- Responsive/support for mobile browsers, degrades gracefully with Javascript disabled + ### Easy setup -- dead-simple installation: drop the files, open the page -- links are stored in a file - - compact storage - - no database required - - easy backup: simply copy the datastore file -- import and export links as Netscape bookmarks - -### Accessibility -- Firefox bookmarlet to share links in one click -- support for mobile browsers -- works with Javascript disabled -- easy page customization through HTML/CSS/RainTPL - -### Security -- bruteforce-proof login form -- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) -and session cookie hijacking - -### Goodies -- thumbnail generation for images and video services: -dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube... - - lazy-loading with [bLazy](http://dinbror.dk/blazy/) -- [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support -- URL cleanup: automatic removal of `?utm_source=...`, `fb=...` -- discreet pop-up notification when a new release is available - -### REST API - -Easily extensible by any client using the REST API exposed by Shaarli. - -See the [API documentation](http://shaarli.github.io/api-documentation/). - -### Using Shaarli as a blog, notepad, pastebin... -- Go to your Shaarli setup and log in -- Click the `Add Link` button -- To share text only, do not enter any URL in the corresponding input field and click `Add Link` -- Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` -- Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. + +- Dead-simple [installation](Installation.md): drop the files on your server, open the page +- Shaares are stored in a file (no database required, easy [backup](Backup-and-restore.md)) +- [Configurable](Shaarli-configuration.md) from dialog and configuration file +- Extensible through third-party [plugins and themes](Community-and-related-software.md) + + +### Fast + +- Fast! Small datastore file, write-once/read-many, served most of the time from OS disk caches (no disk I/O) +- Stays fast with even tens of thousands shaares! + + +### Self-hosted + +- Shaarli is an alternative to commercial services such as StumbleUpon, Delicio.us, Diigo... +- 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 +- Shaarli does not send any telemetry/metrics/private information to developers +- Shaarli is Free and Open-Source software, inspect and change how the program works in the [source code](https://github.com/shaarli/Shaarli) +- Built-in [Security](dev/Development.md#security) features to help you protect your Shaarli instance + ## About -### Shaarli community fork -This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli -This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). +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. -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. +The original Shaarli instance is still available [here](https://sebsauvage.net/links/) (+25000 shaares!) -### Contributing -If you'd like to help, please: -- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) -and [pull requests](https://github.com/shaarli/Shaarli/pulls) -- feel free to report bugs (feedback is much appreciated) -- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki) -- propose solutions to existing problems -- submit pull requests :-) + +### Contributing and getting help + +Feedback is very appreciated! Feel free to propose solutions to existing problems, help us improve the documentation and translations, and submit pull requests :-) + +See [Support](Troubleshooting.md#support) to get in touch with the Shaarli community. ### License -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. + +Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See +[COPYING](https://github.com/shaarli/Shaarli/blob/master/COPYING) for a detail +of the contributors and licenses for each individual component. A list of +contributors is available +[here](https://github.com/shaarli/Shaarli/blob/master/AUTHORS).