selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

GitLab

Self-host Jirafeau

4.7.1

One-click file sharing with expiring links

ReleaseOpen SourceAGPL-3.0
docker run -it --rm -p 8080:80 registry.gitlab.com/jirafeau/jirafeau:latest
Updated2 years ago
Setup difficultyEasy
ThemeDark mode
Port
80 (HTTP inside the container (lighttpd); the documented example publishes it as 8080 on the host)
Docker
registry.gitlab.com/jirafeau/jirafeau
Upload page with the file pickerUpload progress showing speed, percentage and remaining timeConfirmation page with the generated download and delete linksAdministration interface

What is Jirafeau?

Jirafeau alternatives

Should you self-host Jirafeau?

Jirafeau scores 58/100 on selfhost.directory (how scoring works) and ranks #27 of 89 in File Sharing.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is easy: most people get it running in one sitting. An official Docker image is available. It is AGPL-3.0-licensed.

Its closest alternative on selfhost.directory is copyparty (82/100, 47 424 stars). It scores higher overall, so compare the two before you pick. See Jirafeau vs copyparty side by side.

Features

  • Admin Interface
  • Basic API / scripting interface
  • CLI cleanup of expired files
  • File-level deduplicationEnabled through the file_hash option.
  • In-browser file preview
  • Large file uploads via HTML5 file API
  • Link expiration
  • Multi-language Support
  • One-click file upload with download and delete links
  • Password protection for uploads and downloads
  • Self-destruct after first download
  • Server-Side EncryptionNeeds the Sodium PHP module; disables deduplication and is not end-to-end encryption.
  • Short download links
  • Upload progress display

How to install Jirafeau

Install Jirafeau with Docker

Environment variables
ADMIN_PASSWORD, ADMIN_IP, LANG, AVAILABILITIES, WEB_ROOT, VAR_ROOT, FILE_HASH, PREVIEW, TITLE, ORGANISATION, CONTACTPERSON, STYLE, DARK_STYLE, AVAILABILITY_DEFAULT, ONE_TIME_DOWNLOAD, ONE_TIME_DOWNLOAD_PRESELECTED, ENABLE_CRYPT, DEBUG, MAXIMAL_UPLOAD_SIZE, UPLOAD_PASSWORD, UPLOAD_IP, UPLOAD_IP_NO_PASSWORD, PROXY_IP, STORE_UPLOADER_IP, DOWNLOAD_PASSWORD_REQUIREMENT, DOWNLOAD_PASSWORD_GEN_LEN, DOWNLOAD_PASSWORD_GEN_CHARS, DOWNLOAD_PASSWORD_POLICY, DOWNLOAD_PASSWORD_POLICY_REGEX
docker pull registry.gitlab.com/jirafeau/jirafeau:latest
docker run -it --rm -p 8080:80 registry.gitlab.com/jirafeau/jirafeau:latest

Container images are built for AMD64 and ARM64. TLS is not provided by the image; data lives in /data by default and the admin password is auto-generated (shown in the container log) unless ADMIN_PASSWORD is set.

How to configure Jirafeau

  • web_rootURL of the installation, with trailing slash, used when generating links.

    values: any URL

  • var_rootPath to the data directory (files and links), with trailing slash.

    values: any filesystem path

  • use_shortlinksfalseEnables shortened download links; needs a web server supporting URL rewriting.

    values: true / false

  • langautoInterface language, 'auto' detects from the browser.

    values: 'auto' or any language in /lib/locales/

  • stylecourgetteTheme name, a folder in the media directory.

FAQ

What about this file deduplication thing?

Repeated uploads of the same file are stored once with a reference counter; the file is destroyed when the counter reaches zero. It is disabled by default and enabled through the file_hash option.

How can I monitor the use of my Jirafeau instance?

Munin with simple scripts can collect the number of files and the disk space they occupy.

How can I use the scripting interface (API)?

Point your browser at /script.php.

How can I access the admin interface?

Open /admin.php in your browser.

How can I change the Terms of Service?

Copy lib/tos.original.txt to lib/tos.local.txt and edit it; updates only ever touch the original file.

How to set maximum file size?

Browsers with the HTML5 file API can upload arbitrarily large files; otherwise the limits come from PHP's post_max_size and upload_max_filesize, and Jirafeau's maximal_upload_size setting can cap it.

How can I change the theme?

Set the style key in lib/config.local.php to a folder name in /media; use dark_style for the dark-mode theme.

How can I automatize the cleaning of old (expired) files?

Run admin.php from the command line with the clean_expired or clean_async commands and place it in a cron entry.

How can I limit upload access?

Set one or more passwords for the upload page and/or a list of allowed IPs in CIDR notation; downloads cannot be limited this way.

Can I add a new language in Jirafeau?

Yes, create a new JSON file under lib/locales and submit it as a merge request.

More in File Sharing

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…