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 ### Interface
  40 - minimalist design (simple is beautiful)
  41 - FAST
  42 - ATOM and RSS feeds
  43 - views:
  44     - paginated link list
  45     - tag cloud
  46     - picture wall: image and video thumbnails
  47     - daily: newspaper-like daily digest
  48     - daily RSS feed
  49 - permalinks for easy reference
  50 - links can be public or private
  51 - extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage)
  52
  53 ### Tag, view and search your links!
  54 - add a custom title and description to archived links
  55 - add tags to classify and search links
  56     - features tag autocompletion, renaming, merging and deletion
  57 - full-text and tag search
  58
  59 ### Easy setup
  60 - dead-simple installation: drop the files, open the page
  61 - links are stored in a file
  62     - compact storage
  63     - no database required
  64     - easy backup: simply copy the datastore file
  65 - import and export links as Netscape bookmarks
  66
  67 ### Accessibility
  68 - Firefox bookmarlet to share links in one click
  69 - support for mobile browsers
  70 - works with Javascript disabled
  71 - easy page customization through HTML/CSS/RainTPL
  72
  73 ### Security
  74 - bruteforce-proof login form
  75 - protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
  76 and session cookie hijacking
  77
  78 ### Goodies
  79 - thumbnail generation for images and video services:
  80 dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
  81     - lazy-loading with [bLazy](http://dinbror.dk/blazy/)
  82 - [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
  83 - URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
  84 - discreet pop-up notification when a new release is available
  85
  86 ### REST API
  87
  88 Easily extensible by any client using the REST API exposed by Shaarli.
  89
  90 See the [API documentation](http://shaarli.github.io/api-documentation/).
  91
  92 ### Other usages
  93 Though Shaarli is primarily a bookmarking application, it can serve other purposes
  94 (see [Features](Features)):
  95
  96 - micro-blogging
  97 - pastebin
  98 - online notepad
  99 - snippet archive
 100
 101 ## About
 102 ### Shaarli community fork
 103 This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
 104
 105 This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
 106
 107 The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191)
 108 that he would have no time to work on Shaarli in the near future.
 109 The Shaarli community has carried on the work to provide
 110 [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master)
 111 for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+)
 112 in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.
 113
 114 ### Contributing
 115 If you'd like to help, please:
 116 - have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
 117 and [pull requests](https://github.com/shaarli/Shaarli/pulls)
 118 - feel free to report bugs (feedback is much appreciated)
 119 - suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki)
 120 - propose solutions to existing problems
 121 - submit pull requests :-)
 122
 123
 124 ### License
 125 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.
 126