docker/README.md

   1 # Jirafeau's Docker image
   2
   3 ## Run Jirafeau through a pre-made Docker image
   4
   5 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`.
   6
   7 ```shell
   8 docker pull registry.gitlab.com/jirafeau/jirafeau:latest
   9 docker run -it --rm -p 8080:80 registry.gitlab.com/jirafeau/jirafeau:latest
  10 ```
  11
  12 Then connect on [localhost:8080](http://localhost:8080/).
  13 The admin console is located on `/admin.php`, check console output to get auto-generated admin password.
  14
  15 ## Build your own Jirafeau docker image
  16
  17 ```shell
  18 git clone https://gitlab.com/jirafeau/Jirafeau.git
  19 cd Jirafeau
  20 docker build -t your/jirafeau:latest .
  21 ```
  22
  23 ## Security
  24
  25 You may be interested in running Jirafeau on port 80:
  26
  27 ```shell
  28 docker run -d -p 80:80 --sysctl net.ipv4.ip_unprivileged_port_start=80 registry.gitlab.com/jirafeau/jirafeau
  29 ```
  30
  31 Note that Jirafeau image does not provide any SSL/TLS. You may be interested in using [docker compose](https://docs.docker.com/compose/) combined with [Let's Encrypt](https://letsencrypt.org/).
  32
  33 ## Options
  34
  35 Jirafeau's docker image accepts some options through environment variables to ease its configuration.
  36 More details about options in `lib/config.original.php`.
  37
  38 Available options:
  39 - `ADMIN_PASSWORD`: setup a specific admin password. If not set, a random password will be generated.
  40 - `ADMIN_IP`: set one or more ip allowed to access admin interface (separated by comma).
  41 - `WEB_ROOT`: setup a specific domain to point at when generating links (e.g. 'jirafeau.mydomain.com/').
  42 - `VAR_ROOT`: setup a specific path where to place files. default: '/data'.
  43 - `FILE_HASH`: can be set to `md5`, `partial_md5` or `random` (default).
  44 - `PREVIEW`: set to 1 or 0 to enable or disable preview.
  45 - `TITLE`: set Jirafeau instance title.
  46 - `ORGANISATION`: set organisation (in ToS).
  47 - `CONTACTPERSON`: set contact person (in ToS).
  48 - `STYLE`: apply a specific style from the media folder.
  49 - `DARK_STYLE`: apply a specific style for browsers in dark mode.
  50 - `AVAILABILITY_DEFAULT`: setup which availability shows by default.
  51 - `ONE_TIME_DOWNLOAD`: set to 1 or 0 to enable or disable one time downloads.
  52 - `ONE_TIME_DOWNLOAD_PRESELECTED`: set to 1 or 0 to preselect the checkbox for one time downloads.
  53 - `ENABLE_CRYPT`: set to 1 or 0 to enable or disable server side encryption.
  54 - `DEBUG`: set to 1 or 0 to enable or disable debug mode.
  55 - `MAXIMAL_UPLOAD_SIZE`: maximal file size allowed (expressed in MB).
  56 - `UPLOAD_PASSWORD`: set one or more passwords to access Jirafeau (separated by comma).
  57 - `UPLOAD_IP`: set one or more ip allowed to upload files (separated by comma).
  58 - `UPLOAD_IP_NO_PASSWORD`: set one or more ip allowed to upload files without password (separated by comma).
  59 - `PROXY_IP`: set one or more proxy ip (separated by comma).
  60 - `STORE_UPLOADER_IP`: set to 1 or 0 to enable or disable keeping sender's IP with the _link_ file.
  61 - `DOWNLOAD_PASSWORD_REQUIREMENT`: set to 'optional' (default), 'required' or 'generated' to make a password for downloading optional, required or generated
  62 - `DOWNLOAD_PASSWORD_GEN_LEN`: set length of generated download passwords
  63 - `DOWNLOAD_PASSWORD_GEN_CHARS`: set characters used for generated download passwords
  64 - `DOWNLOAD_PASSWORD_POLICY`: set to 'regex' to use a regular expression to check user provided download passwords for complexity constraints
  65 - `DOWNLOAD_PASSWORD_POLICY_REGEX`: regex to check against if password policy is set to regex
  66
  67 Example:
  68
  69 ```shell
  70 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
  71 ```
  72
  73 ## Data storage
  74
  75 Files and links are stored in `/data` by default. Subfolders are automatically created with needed permissions at creation if needed.
  76 Note that configuration is not stored in /data.
  77
  78 Example of using a dedicated volume to store Jirafeau data separately from the container:
  79
  80 ```shell
  81 docker volume create jirafeau_data
  82 docker run -it --rm -p 8080:80 --mount source=jirafeau_data,target=/data registry.gitlab.com/jirafeau/jirafeau:latest
  83 ```
  84
  85 It is also possible to put Jirafeau data into an already existing directory outside the container:
  86
  87 ```shell
  88 mkdir /tmp/jirafeau_data
  89 docker run -it --rm -p 8080:80 -v /tmp/jirafeau_data:/data registry.gitlab.com/jirafeau/jirafeau:latest
  90 ```
  91
  92 Please note that the files and directories created in the directory outside the container will probably be owned by UID 100.
  93
  94 ## Few notes
  95
  96 - `var-...` folder where lives all uploaded data is protected from direct access
  97 - 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