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