Updated Docker README

[jirafeau_project.git] / docker / README.md

diff --git a/docker/README.md b/docker/README.md
index 155de5fd9aa0e43a932e8070735d691b12c2f4f2..343c69e2edee4d2fa7ab60a29fdea8196568f46b 100644 (file)
--- a/docker/README.md
+++ b/docker/README.md
@@ -1,33 +1,36 @@
-# Run Jirafeau through a pre-made Docker image
+# Jirafeau's Docker image
 
-Jirafeau is a small PHP application so running it inside a docker container is pretty straightforward.
+## Run Jirafeau through a pre-made Docker image
 
-```
-docker pull mojo42/jirafeau:latest
-docker run -it --rm -p 8080:80 mojo42/jirafeau:latest
+Jirafeau is a small PHP application so running it inside a Docker container is pretty straightforward. Container images are built for AMD64 and ARM64 systems and can be downloaded from our registry at `registry.gitlab.com`.
+
+```shell
+docker pull registry.gitlab.com/jirafeau/jirafeau:latest
+docker run -it --rm -p 8080:80 registry.gitlab.com/jirafeau/jirafeau:latest
 ```
 
 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
+## Build your own Jirafeau docker image
 
-```
-git clone https://gitlab.com/pcanterino/Jirafeau.git
+```shell
+git clone https://gitlab.com/jirafeau/Jirafeau.git
 cd Jirafeau
 docker build -t your/jirafeau:latest .
 ```
 
-# Security
+## Security
 
 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
+
+```shell
+docker run -d -p 80:80 --sysctl net.ipv4.ip_unprivileged_port_start=80 registry.gitlab.com/jirafeau/jirafeau
 ```
 
 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
+## Options
 
 Jirafeau's docker image accepts some options through environment variables to ease its configuration.
 More details about options in `lib/config.original.php`.
@@ -46,6 +49,7 @@ Available options:
 - `DARK_STYLE`: apply a specific style for browsers in dark mode.
 - `AVAILABILITY_DEFAULT`: setup which availability shows by default.
 - `ONE_TIME_DOWNLOAD`: set to 1 or 0 to enable or disable one time downloads.
+- `ONE_TIME_DOWNLOAD_PRESELECTED`: set to 1 or 0 to preselect the checkbox for 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).
@@ -61,19 +65,28 @@ Available options:
 - `DOWNLOAD_PASSWORD_POLICY_REGEX`: regex to check against if password policy is set to regex
 
 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
+
+```shell
+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  registry.gitlab.com/jirafeau/jirafeau:latest
 ```
 
-# Data Storage
+## Data storage
 
-Files and links are stored in `/data` by default. Sub folders are automatically created with needed permissions at creation if needed.
+Files and links are stored in `/data` by default. Subfolders 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:
-```
+
+```shell
 docker volume create jirafeau_data
-docker run -it --rm -p 8080:80 --mount source=jirafeau_data,target=/data mojo42/jirafeau:latest
+docker run -it --rm -p 8080:80 --mount source=jirafeau_data,target=/data registry.gitlab.com/jirafeau/jirafeau:latest
+```
+
+It is also possible to put Jirafeau data into an already existing directory outside the container:
+
+```shell
+mkdir /tmp/jirafeau_data
+docker run -it --rm -p 8080:80 -v /tmp/jirafeau_data:/data registry.gitlab.com/jirafeau/jirafeau:latest
 ```
 
 ## Few notes