[TASK] add docker options documentation

[jirafeau_project.git] / docker / README.md

diff --git a/docker/README.md b/docker/README.md
index 432c351a9af5cc0d0c241de095fc14c839cf5634..ff23b136af8b4c44db259ce0acda6cbe4e86e7bf 100644 (file)
--- a/docker/README.md
+++ b/docker/README.md
@@ -40,6 +40,14 @@ docker run -d -p 8080:8080 mojo42/jirafeau
 docker run -d -p 80:8080 mojo42/jirafeau
 ```
 
 docker run -d -p 80:8080 mojo42/jirafeau
 ```
 

+## Options
+
+Jirafeau docker image now accept some options through environment variables to ease its configuration.
+More details about options in `lib/config.original.php`.
+
+Available options:
+- `FILE_HASH`: can be set to `md5` (default), `partial_md5` or `random`.
+

 ## Few notes
 
 - SSL is currently not enabled in docker's image for the moment
 ## Few notes
 
 - SSL is currently not enabled in docker's image for the moment