[TASK] add more details in docker documentation

[jirafeau_mojo42.git] / docker / README.md

diff --git a/docker/README.md b/docker/README.md
index 4fef8f50f344c772f8c3a213e5f527bc4ac5376b..be2b85a9caa9943dea1ab1cc91d336bf73ee85f7 100644 (file)
--- a/docker/README.md
+++ b/docker/README.md
@@ -4,7 +4,7 @@ Jirafeau is a small PHP application so running it inside a docker is pretty stra
 
 ```
 docker pull mojo42/jirafeau:latest
 
 ```
 docker pull mojo42/jirafeau:latest

-docker run -d -p 8080:80 mojo42/jirafeau:latest
+docker run -it --rm -p 8080:80 mojo42/jirafeau:latest

 ```
 
 Then connect on [locahost:8080](http://localhost:8080/).
 ```
 
 Then connect on [locahost:8080](http://localhost:8080/).


@@ -53,6 +53,22 @@ Available options:
 - `PROXY_IP`: set one or more proxy ip (separated by comma).
 - `STORE_UPLOADER_IP`: set to 1 or 0 to enable or disable keeping sender's IP with the _link_ file.
 
 - `PROXY_IP`: set one or more proxy ip (separated by comma).
 - `STORE_UPLOADER_IP`: set to 1 or 0 to enable or disable keeping sender's IP with the _link_ file.
 

+Example:
+```
+docker run -it -p 8080:80 --rm -e ADMIN_PASSWORD='p4ssw0rd' -e WEB_ROOT='jirafeau.mydomain.com/' -e UPLOAD_PASSWORD='foo,bar' -e PREVIEW=0  mojo42/jirafeau:latest
+```
+
+# Data Storage
+
+Files and links are stored in `/data` by default. Sub folders are automatically created with needed permissions at creation if needed.
+Note that configuration is not stored in /data.
+
+Example of using a dedicated volume to store Jirafeau data separatly from containter:
+```
+docker volume create jirafeau_data
+docker run -it --rm -p 8080:80 --mount source=jirafeau_data,target=/data mojo42/jirafeau:latest
+```
+

 ## Few notes
 
 - `var-...` folder where lives all uploaded data is protected from direct access
 ## Few notes
 
 - `var-...` folder where lives all uploaded data is protected from direct access