[FEATURE] add basic docker options

[jirafeau_mojo42.git] / docker / README.md

diff --git a/docker/README.md b/docker/README.md
index 5dc4c2c0495c45bb4bab1b72e17f8a2773d0b6db..c8a6f550e712af6dccfe5c1a4f71d1410f1efac9 100644 (file)
--- a/docker/README.md
+++ b/docker/README.md
@@ -1,38 +1,44 @@
-# 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:latest
+docker run -d -p 8080:80 mojo42/jirafeau:latest
+```
 
-`docker pull mojo42/jirafeau`
+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 docker image
+# Build your own Jirafeau docker image
 
 ```
 git clone https://gitlab.com/mojo42/Jirafeau.git
 cd Jirafeau
-docker build -t mojo42/jirafeau:latest .
+docker build -t your/jirafeau:latest .
 ```
 
-## Run Jirafeau image
+# Security
 
-Once you have your Jirafeau's image, you can run a quick & dirty Jirafeau using:
+You may be interested to run Jirafeau on port 80:
 ```
-docker run -d -p 8000:80 mojo42/jirafeau
+docker run -d -p 80:80 --sysctl net.ipv4.ip_unprivileged_port_start=80 mojo42/jirafeau
 ```
-and then connect on [locahost:8000](http://localhost:8000) and proceed to installation.
 
-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 8000:80 -v$(pwd):/www 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/).
+
+# Options
+
+Jirafeau docker image accept some options through environment variables to ease its configuration.
+More details about options in `lib/config.original.php`.
 
-There are also other ways to manage your container (like docker's volumes) but this is out of the scope of this documentation.
+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`.
 
 ## 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