[FEATURE] provide details for bug opening

[jirafeau_project.git] / docker / README.md

diff --git a/docker/README.md b/docker/README.md
index 5dc4c2c0495c45bb4bab1b72e17f8a2773d0b6db..47566a6af1fb0068278656c40a1fcaccd714db00 100644 (file)
--- a/docker/README.md
+++ b/docker/README.md
@@ -20,19 +20,30 @@ docker build -t mojo42/jirafeau:latest .
 
 Once you have your Jirafeau's image, you can run a quick & dirty Jirafeau using:
 ```
 
 Once you have your Jirafeau's image, you can run a quick & dirty Jirafeau using:
 ```

-docker run -d -p 8000:80 mojo42/jirafeau
+docker run -d -p 8080:80 mojo42/jirafeau

 ```
 ```

-and then connect on [locahost:8000](http://localhost:8000) and proceed to installation.
+and then connect on [locahost:8080](http://localhost:8080/) and proceed to installation.

 
 

-An other way to run Jirafeau (in a more controlled way) is to mount your Jirafeau's reprository in /www folder so your data are outside the container. This way, you will be able to easily make backups, upgrade Jirafeau, change configuration and develop Jirafeau.
+## Security
+
+Jirafeau is run without privilidges with user id 2009. To make it able to open privilidged ports you can pass the capability, just stay with 8080 and use a reverse proxy or map the port 80:8080.

 ```
 ```

-docker run -d -p 8000:80 -v$(pwd):/www mojo42/jirafeau
+docker run -d -p 80:80 --sysctl net.ipv4.ip_unprivileged_port_start=80 mojo42/jirafeau
+docker run -d -p 8080:80 mojo42/jirafeau
+docker run -d -p 80:80 mojo42/jirafeau

 ```
 
 ```
 

-There are also other ways to manage your container (like docker's volumes) but this is out of the scope of this documentation.
+Note that Jirafeau image does not provide any SSL/TLS. You may be interrested in using [docker compose](https://docs.docker.com/compose/) combined with [Let's Encrypt](https://letsencrypt.org/).
+
+## Options
+
+Jirafeau docker image 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
 
 
 ## Few notes
 

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

 - `var-...` folder where lives all uploaded data is protected from direct access
 - Image has been made using [Alpine Linux](https://alpinelinux.org/) with [lighttpd](https://www.lighttpd.net/) which makes the container very light and start very quickly
 - `var-...` folder where lives all uploaded data is protected from direct access
 - Image has been made using [Alpine Linux](https://alpinelinux.org/) with [lighttpd](https://www.lighttpd.net/) which makes the container very light and start very quickly