[TASK] Update release process

[jirafeau.git] / docker / README.md

diff --git a/docker/README.md b/docker/README.md
index 4fef8f50f344c772f8c3a213e5f527bc4ac5376b..daf5302bb4f202722b5d290194406adf6c03c841 100644 (file)
--- a/docker/README.md
+++ b/docker/README.md
@@ -1,13 +1,13 @@
 # Run Jirafeau through a pre-made Docker image
 
-Jirafeau is a small PHP application so running it inside a docker is pretty straightforward.
+Jirafeau is a small PHP application so running it inside a docker container is pretty straightforward.
 
 ```
 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 [localhost: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
@@ -20,23 +20,23 @@ docker build -t your/jirafeau:latest .
 
 # Security
 
-You may be interested to run Jirafeau on port 80:
+You may be interested in running Jirafeau on port 80:
 ```
 docker run -d -p 80:80 --sysctl net.ipv4.ip_unprivileged_port_start=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/).
+Note that Jirafeau image does not provide any SSL/TLS. You may be interested 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.
+Jirafeau's docker image accepts some options through environment variables to ease its configuration.
 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`.
+- `FILE_HASH`: can be set to `md5`, `partial_md5` or `random` (default).
 - `PREVIEW`: set to 1 or 0 to enable or disable preview.
 - `TITLE`: set Jirafeau instance title.
 - `ORGANISATION`: set organisation (in ToS).
@@ -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.
 
+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 separately from the container:
+```
+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