diff options
Diffstat (limited to 'doc/md/index.md')
-rw-r--r-- | doc/md/index.md | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/md/index.md b/doc/md/index.md index b10e3cf4..2b7d0f00 100644 --- a/doc/md/index.md +++ b/doc/md/index.md | |||
@@ -22,6 +22,17 @@ It runs the latest development version of Shaarli and is updated/reset daily. | |||
22 | 22 | ||
23 | Login: `demo`; Password: `demo` | 23 | Login: `demo`; Password: `demo` |
24 | 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. | ||
25 | 36 | ||
26 | ## Features | 37 | ## Features |
27 | 38 | ||
@@ -37,7 +48,7 @@ Login: `demo`; Password: `demo` | |||
37 | - daily RSS feed | 48 | - daily RSS feed |
38 | - permalinks for easy reference | 49 | - permalinks for easy reference |
39 | - links can be public or private | 50 | - links can be public or private |
40 | - extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage) | 51 | - extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) |
41 | 52 | ||
42 | ### Tag, view and search your links! | 53 | ### Tag, view and search your links! |
43 | - add a custom title and description to archived links | 54 | - add a custom title and description to archived links |