X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2Findex.md;h=1ffe682400b4f4ff790edeb33a7d3ba66f044c85;hb=4ada0d313a37f12ef407060d5774e9f623c4abbd;hp=1106334b46ff99957fb95090ef6efb0da7023256;hpb=57ee53d6c6be4b641764b0a635b2998c6cdc8197;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/index.md b/doc/md/index.md index 1106334b..1ffe6824 100644 --- a/doc/md/index.md +++ b/doc/md/index.md @@ -22,9 +22,37 @@ It runs the latest development version of Shaarli and is updated/reset daily. Login: `demo`; Password: `demo` +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): +``` +MY_SHAARLI_VOLUME=$(cd /path/to/shaarli/data/ && pwd -P) +docker run -ti --rm \ + -p 8000:80 \ + -v $MY_SHAARLI_VOLUME:/var/www/shaarli/data \ + shaarli/shaarli +``` + +A brief guide on getting starting using docker is given in [Docker 101](docker/docker-101). +To learn more about user data and how to keep it across versions, please see [Upgrade and Migration](Upgrade-and-migration) documentation. ## 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 @@ -37,7 +65,7 @@ Login: `demo`; Password: `demo` - daily RSS feed - permalinks for easy reference - links can be public or private -- extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage) +- 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 @@ -78,13 +106,12 @@ Easily extensible by any client using the REST API exposed by Shaarli. See the [API documentation](http://shaarli.github.io/api-documentation/). -### Other usages -Though Shaarli is primarily a bookmarking application, it can serve other purposes -(see [usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)): -- micro-blogging -- pastebin -- online notepad -- snippet archive +### 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. ## About ### Shaarli community fork