doc/md/index.md

   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 Docker users can start a personal instance from an [autobuild image](https://hub.docker.com/r/shaarli/shaarli/). For example to start a temporary Shaarli at ``localhost:8000``, and keep session data (config, storage):
  26 ```
  27 MY_SHAARLI_VOLUME=$(cd /path/to/shaarli/data/ && pwd -P)
  28 docker run -ti --rm \
  29          -p 8000:80 \
  30          -v $MY_SHAARLI_VOLUME:/var/www/shaarli/data \
  31          shaarli/shaarli
  32 ```
  33
  34 A brief guide on getting starting using docker is given in [Docker 101](docker/docker-101).
  35 To learn more about user data and how to keep it across versions, please see [Upgrade and Migration](Upgrade-and-migration) documentation.
  36
  37 ## Features
  38
  39 Shaarli can be used:
  40
  41 - to share, comment and save interesting links and news.
  42 - to bookmark useful/frequent personal links (as private links) and share them between computers.
  43 - as a minimal blog/microblog/writing platform (no character limit).
  44 - as a read-it-later list (for example items tagged `readlater`).
  45 - to draft and save articles/posts/ideas.
  46 - to keep code snippets.
  47 - to keep notes and documentation.
  48 - as a shared clipboard/notepad/pastebin between machines.
  49 - as a todo list.
  50 - to store playlists (e.g. with the `music` or `video` tags).
  51 - to keep extracts/comments from webpages that may disappear.
  52 - to keep track of ongoing discussions (for example items tagged `discussion`).
  53 - [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags.
  54 - to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...).
  55
  56 ### Interface
  57 - minimalist design (simple is beautiful)
  58 - FAST
  59 - ATOM and RSS feeds
  60 - views:
  61     - paginated link list
  62     - tag cloud
  63     - picture wall: image and video thumbnails
  64     - daily: newspaper-like daily digest
  65     - daily RSS feed
  66 - permalinks for easy reference
  67 - links can be public or private
  68 - extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage)
  69
  70 ### Tag, view and search your links!
  71 - add a custom title and description to archived links
  72 - add tags to classify and search links
  73     - features tag autocompletion, renaming, merging and deletion
  74 - full-text and tag search
  75
  76 ### Easy setup
  77 - dead-simple installation: drop the files, open the page
  78 - links are stored in a file
  79     - compact storage
  80     - no database required
  81     - easy backup: simply copy the datastore file
  82 - import and export links as Netscape bookmarks
  83
  84 ### Accessibility
  85 - Firefox bookmarlet to share links in one click
  86 - support for mobile browsers
  87 - works with Javascript disabled
  88 - easy page customization through HTML/CSS/RainTPL
  89
  90 ### Security
  91 - bruteforce-proof login form
  92 - protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
  93 and session cookie hijacking
  94
  95 ### Goodies
  96 - thumbnail generation for images and video services:
  97 dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
  98     - lazy-loading with [bLazy](http://dinbror.dk/blazy/)
  99 - [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
 100 - URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
 101 - discreet pop-up notification when a new release is available
 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
 109 ### Using Shaarli as a blog, notepad, pastebin...
 110 - Go to your Shaarli setup and log in
 111 - Click the `Add Link` button
 112 - To share text only, do not enter any URL in the corresponding input field and click `Add Link`
 113 - Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save`
 114 - Voilà!  Your article is now published (privately if you selected that option) and accessible using its permalink.
 115
 116 ## About
 117 ### Shaarli community fork
 118 This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
 119
 120 This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
 121
 122 The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191)
 123 that he would have no time to work on Shaarli in the near future.
 124 The Shaarli community has carried on the work to provide
 125 [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master)
 126 for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+)
 127 in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.
 128
 129 ### Contributing
 130 If you'd like to help, please:
 131 - have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
 132 and [pull requests](https://github.com/shaarli/Shaarli/pulls)
 133 - feel free to report bugs (feedback is much appreciated)
 134 - suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki)
 135 - propose solutions to existing problems
 136 - submit pull requests :-)
 137
 138
 139 ### License
 140 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.
 141