fix for #20, added also lang to env variables; added function for associative arrays...

[jirafeau_project.git] / docker / README.md

diff --git a/docker/README.md b/docker/README.md
index e7e68d7920d68a96e04dfbb0ba65c80d19f5127b..0ee1a9621d2c29f77d0eba868f22514d164a31d0 100644 (file)
--- a/docker/README.md
+++ b/docker/README.md
@@ -2,12 +2,10 @@
 
 ## Run Jirafeau through a pre-made Docker image
 
-**There are currently no official pre-made Docker images of Jirafeau! The repository mentioned in this section is outdated!**
+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`.
 
-Jirafeau is a small PHP application so running it inside a docker container is pretty straightforward.
-
-```
-docker pull registry.gitlab.com/jirafeau:latest
+```shell
+docker pull registry.gitlab.com/jirafeau/jirafeau:latest
 docker run -it --rm -p 8080:80 registry.gitlab.com/jirafeau/jirafeau:latest
 ```
 
@@ -16,7 +14,7 @@ The admin console is located on `/admin.php`, check console output to get auto-g
 
 ## Build your own Jirafeau docker image
 
-```
+```shell
 git clone https://gitlab.com/jirafeau/Jirafeau.git
 cd Jirafeau
 docker build -t your/jirafeau:latest .
@@ -25,7 +23,8 @@ docker build -t your/jirafeau:latest .
 ## Security
 
 You may be interested in running Jirafeau on port 80:
-```
+
+```shell
 docker run -d -p 80:80 --sysctl net.ipv4.ip_unprivileged_port_start=80 registry.gitlab.com/jirafeau/jirafeau
 ```
 
@@ -39,6 +38,8 @@ 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.
 - `ADMIN_IP`: set one or more ip allowed to access admin interface (separated by comma).
+- `LANG`: choose the language for jirafeau (default auto).
+- `AVAILABILITIES`: change the array for availablibilities that the user can select (see `docker-compose.yaml` for an example how to do that). Availability is the time the file should be available before it can be deleted.
 - `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`, `partial_md5` or `random` (default).
@@ -50,6 +51,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).
@@ -65,7 +67,8 @@ Available options:
 - `DOWNLOAD_PASSWORD_POLICY_REGEX`: regex to check against if password policy is set to regex
 
 Example:
-```
+
+```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
 ```
 
@@ -75,11 +78,21 @@ Files and links are stored in `/data` by default. Subfolders are automatically c
 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 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
+```
+
+Please note that the files and directories created in the directory outside the container will probably be owned by UID 100.
+
 ## Few notes
 
 - `var-...` folder where lives all uploaded data is protected from direct access