From b83af6c5d98282a856461a9896e9511ca7f22285 Mon Sep 17 00:00:00 2001 From: Jerome Jutteau Date: Sun, 13 Dec 2020 23:05:06 +0100 Subject: [PATCH 1/1] [TASK] clean docker documentation Signed-off-by: Jerome Jutteau --- docker/README.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/docker/README.md b/docker/README.md index ff23b13..47566a6 100644 --- a/docker/README.md +++ b/docker/README.md @@ -20,29 +20,24 @@ docker build -t mojo42/jirafeau:latest . Once you have your Jirafeau's image, you can run a quick & dirty Jirafeau using: ``` -docker run -d -p 8080:8080 mojo42/jirafeau +docker run -d -p 8080:80 mojo42/jirafeau ``` -and then connect on [locahost:8080](http://localhost:8080) 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 8080:8080 -v$(pwd):/www mojo42/jirafeau -``` - -There are also other ways to manage your container (like docker's volumes) but this is out of the scope of this documentation. +and then connect on [locahost:8080](http://localhost:8080/) and proceed to installation. ## 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. ``` 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 +docker run -d -p 8080:80 mojo42/jirafeau +docker run -d -p 80: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/). + ## 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: @@ -50,6 +45,5 @@ Available options: ## 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 -- 2.34.1