docker/README.md

   1 # Jirafeau in Docker
   2
   3 Jirafeau is a small PHP application so running it inside a docker is pretty straightforward.
   4
   5 ## Get Jirafeau's docker image
   6
   7 ### Pull docker image from Docker Hub
   8
   9 `docker pull mojo42/jirafeau`
  10
  11 ### Build your own docker image
  12
  13 ```
  14 git clone https://gitlab.com/mojo42/Jirafeau.git
  15 cd Jirafeau
  16 docker build -t mojo42/jirafeau:latest .
  17 ```
  18
  19 ## Run Jirafeau image
  20
  21 Once you have your Jirafeau's image, you can run a quick & dirty Jirafeau using:
  22 ```
  23 docker run -d -p 8080:80 mojo42/jirafeau
  24 ```
  25 and then connect on [locahost:8080](http://localhost:8080/) and proceed to installation.
  26
  27 ## Security
  28
  29 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.
  30 ```
  31 docker run -d -p 80:80 --sysctl net.ipv4.ip_unprivileged_port_start=80 mojo42/jirafeau
  32 docker run -d -p 8080:80 mojo42/jirafeau
  33 docker run -d -p 80:80 mojo42/jirafeau
  34 ```
  35
  36 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/).
  37
  38 ## Options
  39
  40 Jirafeau docker image accept some options through environment variables to ease its configuration.
  41 More details about options in `lib/config.original.php`.
  42
  43 Available options:
  44 - `FILE_HASH`: can be set to `md5` (default), `partial_md5` or `random`.
  45
  46 ## Few notes
  47
  48 - `var-...` folder where lives all uploaded data is protected from direct access
  49 - 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