X-Git-Url: https://git.p6c8.net/jirafeau_project.git/blobdiff_plain/a155e54c13f86994f4280fb18eba021f3cc7c9fd..33bb6cfe3111b316082336edae43846aaef84f17:/docker/README.md?ds=inline

diff --git a/docker/README.md b/docker/README.md
index 893d463..be2b85a 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -4,10 +4,11 @@ Jirafeau is a small PHP application so running it inside a docker is pretty stra
 
 ```
 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/).
+The admin console is located on `/admin.php`, check console output to get auto-generated admin password.
 
 # Build your own Jirafeau docker image
 
@@ -19,11 +20,9 @@ docker build -t your/jirafeau:latest .
 
 # 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.
+You may be interested to run Jirafeau on port 80:
 ```
 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
 ```
 
 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/).
@@ -34,7 +33,41 @@ Jirafeau docker image accept some options through environment variables to ease
 More details about options in `lib/config.original.php`.
 
 Available options:
+- `ADMIN_PASSWORD`: setup a specific admin password. If not set, a random password will be generated.
+- `WEB_ROOT`: setup a specific domain to point at when generating links (e.g. 'jirafeau.mydomain.com/').
+- `VAR_ROOT`: setup a specific path where to place files. default: '/data'.
 - `FILE_HASH`: can be set to `md5` (default), `partial_md5` or `random`.
+- `PREVIEW`: set to 1 or 0 to enable or disable preview.
+- `TITLE`: set Jirafeau instance title.
+- `ORGANISATION`: set organisation (in ToS).
+- `CONTACTPERSON`: set contact person (in ToS).
+- `STYLE`: apply a specific style.
+- `AVAILABILITY_DEFAULT`: setup which availability shows by default.
+- `ONE_TIME_DOWNLOAD`: set to 1 or 0 to enable or disable one time downloads.
+- `ENABLE_CRYPT`: set to 1 or 0 to enable or disable server side encryption.
+- `DEBUG`: set to 1 or 0 to enable or disable debug mode.
+- `MAXIMAL_UPLOAD_SIZE`: maximal file size allowed (expressed in MB).
+- `UPLOAD_PASSWORD`: set one or more passwords to access Jirafeau (separated by comma).
+- `UPLOAD_IP`: set one or more ip allowed to upload files (separated by comma).
+- `UPLOAD_IP_NO_PASSWORD`: set one or more ip allowed to upload files without password (separated by comma).
+- `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