[FEATURE] more option docker options

[jirafeau.git] / docker / README.md

diff --git a/docker/README.md b/docker/README.md
index ff23b136af8b4c44db259ce0acda6cbe4e86e7bf..4fef8f50f344c772f8c3a213e5f527bc4ac5376b 100644 (file)
--- a/docker/README.md
+++ b/docker/README.md
@@ -1,55 +1,59 @@
-# Jirafeau in Docker
+# Run Jirafeau through a pre-made Docker image
 
 Jirafeau is a small PHP application so running it inside a docker is pretty straightforward.
 
-## Get Jirafeau's docker image
-
-### Pull docker image from Docker Hub
-
-`docker pull mojo42/jirafeau`
-
-### Build your own docker image
-
 ```
-git clone https://gitlab.com/mojo42/Jirafeau.git
-cd Jirafeau
-docker build -t mojo42/jirafeau:latest .
+docker pull mojo42/jirafeau:latest
+docker run -d -p 8080:80 mojo42/jirafeau:latest
 ```
 
-## Run Jirafeau image
+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.
 
-Once you have your Jirafeau's image, you can run a quick & dirty Jirafeau using:
-```
-docker run -d -p 8080:8080 mojo42/jirafeau
-```
-and then connect on [locahost:8080](http://localhost:8080) and proceed to installation.
+# Build your own Jirafeau docker image
 
-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.
 ```
-docker run -d -p 8080:8080 -v$(pwd):/www mojo42/jirafeau
+git clone https://gitlab.com/mojo42/Jirafeau.git
+cd Jirafeau
+docker build -t your/jirafeau:latest .
 ```
 
-There are also other ways to manage your container (like docker's volumes) but this is out of the scope of this documentation.
-
-## Security
+# 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:8080 mojo42/jirafeau
-docker run -d -p 80:8080 mojo42/jirafeau
 ```
 
-## Options
+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 now accept some options through environment variables to ease its configuration.
+Jirafeau docker image accept 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`.
+- `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.
 
 ## 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