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 ## Docker Compose
  24
  25 You can use the `docker-compose.yaml` from [here](../docker-compose.yaml)
  26
  27 ### Run Container
  28
  29 ```sh
  30 docker compose up -d
  31 ```
  32
  33 ### Custom Theme
  34
  35 1. copy the theme data from the running container
  36
  37     ```sh
  38     docker compose cp web:/www/media jirafeau_media
  39     ```
  40
  41 2. mount the theme data
  42
  43     ```yaml
  44     #....
  45     volumes:
  46         - ./jirafeau_media/your_theme:/www/media/your_theme
  47     ```
  48
  49 3. set the environment variable
  50
  51     ```yaml
  52     # ....
  53     environment:
  54     STYLE: 'your_theme'
  55     DARK_STYLE: 'your_theme'
  56     ```
  57
  58 4. run the compose file
  59
  60     ```sh
  61     docker compose up -d
  62     ```
  63
  64 ## Security
  65
  66 You may be interested in running Jirafeau on port 80:
  67
  68 ```shell
  69 docker run -d -p 80:80 --sysctl net.ipv4.ip_unprivileged_port_start=80 registry.gitlab.com/jirafeau/jirafeau
  70 ```
  71
  72 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/).
  73
  74 ## Options
  75
  76 Jirafeau's docker image accepts some options through environment variables to ease its configuration.
  77 More details about options in `lib/config.original.php`.
  78
  79 Available options:
  80
  81 - `ADMIN_PASSWORD`: setup a specific admin password. If not set, a random password will be generated.
  82 - `ADMIN_IP`: set one or more ip allowed to access admin interface (separated by comma).
  83 - `LANG`: choose the language for jirafeau (default auto).
  84 - `AVAILABILITIES`: change the array for availablibilities that the user can select (see `docker-compose.yaml` for an example how to do that). Availability is the time the file should be available before it can be deleted.
  85 - `WEB_ROOT`: setup a specific domain to point at when generating links (e.g. 'jirafeau.mydomain.com/').
  86 - `VAR_ROOT`: setup a specific path where to place files. default: '/data'.
  87 - `FILE_HASH`: can be set to `md5`, `partial_md5` or `random` (default).
  88 - `PREVIEW`: set to 1 or 0 to enable or disable preview.
  89 - `TITLE`: set Jirafeau instance title.
  90 - `ORGANISATION`: set organisation (in ToS).
  91 - `CONTACTPERSON`: set contact person (in ToS).
  92 - `STYLE`: apply a specific style from the media folder.
  93 - `DARK_STYLE`: apply a specific style for browsers in dark mode.
  94 - `AVAILABILITY_DEFAULT`: setup which availability shows by default.
  95 - `ONE_TIME_DOWNLOAD`: set to 1 or 0 to enable or disable one time downloads.
  96 - `ONE_TIME_DOWNLOAD_PRESELECTED`: set to 1 or 0 to preselect the checkbox for one time downloads.
  97 - `ENABLE_CRYPT`: set to 1 or 0 to enable or disable server side encryption.
  98 - `DEBUG`: set to 1 or 0 to enable or disable debug mode.
  99 - `MAXIMAL_UPLOAD_SIZE`: maximal file size allowed (expressed in MB).
 100 - `UPLOAD_PASSWORD`: set one or more passwords to access Jirafeau (separated by comma).
 101 - `UPLOAD_IP`: set one or more ip allowed to upload files (separated by comma).
 102 - `UPLOAD_IP_NO_PASSWORD`: set one or more ip allowed to upload files without password (separated by comma).
 103 - `PROXY_IP`: set one or more proxy ip (separated by comma).
 104 - `STORE_UPLOADER_IP`: set to 1 or 0 to enable or disable keeping sender's IP with the _link_ file.
 105 - `DOWNLOAD_PASSWORD_REQUIREMENT`: set to 'optional' (default), 'required' or 'generated' to make a password for downloading optional, required or generated
 106 - `DOWNLOAD_PASSWORD_GEN_LEN`: set length of generated download passwords
 107 - `DOWNLOAD_PASSWORD_GEN_CHARS`: set characters used for generated download passwords
 108 - `DOWNLOAD_PASSWORD_POLICY`: set to 'regex' to use a regular expression to check user provided download passwords for complexity constraints
 109 - `DOWNLOAD_PASSWORD_POLICY_REGEX`: regex to check against if password policy is set to regex
 110
 111 Example:
 112
 113 ```shell
 114 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
 115 ```
 116
 117 ## Data storage
 118
 119 Files and links are stored in `/data` by default. Subfolders are automatically created with needed permissions at creation if needed.
 120 Note that configuration is not stored in /data.
 121
 122 Example of using a dedicated volume to store Jirafeau data separately from the container:
 123
 124 ```shell
 125 docker volume create jirafeau_data
 126 docker run -it --rm -p 8080:80 --mount source=jirafeau_data,target=/data registry.gitlab.com/jirafeau/jirafeau:latest
 127 ```
 128
 129 It is also possible to put Jirafeau data into an already existing directory outside the container:
 130
 131 ```shell
 132 mkdir /tmp/jirafeau_data
 133 docker run -it --rm -p 8080:80 -v /tmp/jirafeau_data:/data registry.gitlab.com/jirafeau/jirafeau:latest
 134 ```
 135
 136 Please note that the files and directories created in the directory outside the container will probably be owned by UID 100.
 137
 138 ## Few notes
 139
 140 - `var-...` folder where lives all uploaded data is protected from direct access
 141 - 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