]> git.immae.eu Git - github/shaarli/Shaarli.git/commitdiff
Added docker quickstart example, with user-data volume
authorB. van Berkum <dev@dotmpe.com>
Mon, 2 Oct 2017 22:23:34 +0000 (00:23 +0200)
committerB. van Berkum <dev@dotmpe.com>
Mon, 2 Oct 2017 22:23:34 +0000 (00:23 +0200)
doc/md/index.md

index 24ada6c7cfafd5bcee221db47660ac6087d3a17b..5f10227f5b45c78006e6859cff42efce0b4fcee0 100644 (file)
@@ -22,6 +22,18 @@ 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 an example to start a temporary Shaarli at ``localhost:8000``, and to keeps the data you create (config, storage) during the session:
+```
+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