Skip to content

Latest commit

 

History

History
75 lines (58 loc) · 3.28 KB

README.md

File metadata and controls

75 lines (58 loc) · 3.28 KB
Raw

Run Jirafeau through a pre-made Docker image

Jirafeau is a small PHP application so running it inside a docker container is pretty straightforward.

docker pull mojo42/jirafeau:latest
docker run -it --rm -p 8080:80 mojo42/jirafeau:latest

Then connect on localhost:8080. The admin console is located on /admin.php, check console output to get auto-generated admin password.

Build your own Jirafeau docker image

git clone https://gitlab.com/mojo42/Jirafeau.git
cd Jirafeau
docker build -t your/jirafeau:latest .

Security

You may be interested in running Jirafeau on port 80:

docker run -d -p 80:80 --sysctl net.ipv4.ip_unprivileged_port_start=80 mojo42/jirafeau

Note that Jirafeau image does not provide any SSL/TLS. You may be interested in using docker compose combined with Let's Encrypt.

Options

Jirafeau's docker image accepts some options through environment variables to ease its configuration. More details about options in lib/config.original.php.

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, partial_md5 or random (default).
  • PREVIEW: set to 1 or 0 to enable or disable preview.
  • TITLE: set Jirafeau instance title.
  • ORGANISATION: set organisation (in ToS).
  • CONTACTPERSON: set contact person (in ToS).
  • STYLE: apply a specific style.
  • AVAILABILITY_DEFAULT: setup which availability shows by default.
  • ONE_TIME_DOWNLOAD: set to 1 or 0 to enable or disable one time downloads.
  • ENABLE_CRYPT: set to 1 or 0 to enable or disable server side encryption.
  • DEBUG: set to 1 or 0 to enable or disable debug mode.
  • MAXIMAL_UPLOAD_SIZE: maximal file size allowed (expressed in MB).
  • UPLOAD_PASSWORD: set one or more passwords to access Jirafeau (separated by comma).
  • UPLOAD_IP: set one or more ip allowed to upload files (separated by comma).
  • UPLOAD_IP_NO_PASSWORD: set one or more ip allowed to upload files without password (separated by comma).
  • PROXY_IP: set one or more proxy ip (separated by comma).
  • STORE_UPLOADER_IP: set to 1 or 0 to enable or disable keeping sender's IP with the link file.

Example:

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  mojo42/jirafeau:latest

Data Storage

Files and links are stored in /data by default. Sub folders are automatically created with needed permissions at creation if needed. Note that configuration is not stored in /data.

Example of using a dedicated volume to store Jirafeau data separately from the container:

docker volume create jirafeau_data
docker run -it --rm -p 8080:80 --mount source=jirafeau_data,target=/data mojo42/jirafeau:latest

Few notes

  • var-... folder where lives all uploaded data is protected from direct access
  • Image has been made using Alpine Linux with lighttpd which makes the container very light and start very quickly