Jirafeau

Welcome to the official Jirafeau project, an Open-Source software.

Jirafeau allows your to "one-click-filesharing". It makes possible to upload a file in a simple way and give an unique link to it.

A demonstration of the latest version is available on jirafeau.net.

Latest CI Status: Master Next Release All Branch Builds

Main features

One upload → One download link & one delete link
Send any large files (thanks to the HTML5 file API → PHP post_max_size limit not relevant)
Shows progression: speed, percentage and remaining upload time
Preview content in browser (if possible)
Optional password protection (for uploading or downloading)
Set expiration time for downloads
Option to self-destruct after first download
Shortened URLs using base 64 encoding
Maximal upload size configurable
NO database, only use basic PHP
Simple language support with a lot of langages (help us on weblate!)
File level Deduplication for storage optimization (does store duplicate files only once, but generate multiple links)
Optional data encryption
Small administration interface
CLI script to remove expired files automatically with a cronjob
Basic, adaptable »Terms Of Service« page
Basic API
Bash script to upload files via command line
Themes

Jirafeau is a fork of the original project Jyraphe based on the 0.5 (stable version) with a lot of modifications.

As it's original project, Jirafeau is made in the KISS way (Keep It Simple, Stupid).

Jirafeau project won't evolve to a file manager and will focus to keep a very few dependencies.

Screenshots

Installation

This shows how to install Jirafeau by your own, it's quite simple but you can also use a docker image or build it yourself. Check docker folder for more informations.

System requirements:

PHP >= 5.6
Optional, but recommended: Git >= 2.7
No database required, no mail required

Installation steps:

Clone the repository or download the latest release from GitLab onto your webserver
Set owner & group according to your webserver
A) Setup with the installation wizard (web):
- Open your browser and go to your installed location, eg. https://example.com/jirafeau/
- The script will redirect to you to a minimal installation wizard to set up all required options
- All optional parameters may be set in lib/config.local.php, take a look at lib/config.original.php to see all default values
B) Setup without the installation wizard (cli):
- Just copy config.original.php to config.local.php and customize it

Upgrade

General procedure for all versions

Backup your Jirafeau installation!
Block access to Jirafeau
Checkout the new version with Git using the tagged release
- If you have installed Jirafeau just by uploading files on your server, you can download the desired version, overwrite/remove all files and chown/chmod files if needed. Keep a backup of your local configuration file tough.
With you browser, go to your Jirafeau root page
Follow the installation wizard, it should propose you the same data folder or even update automatically
Check your /lib/config.local.php and compare it with the /lib/config.original.php to see if new configuration items are available

From version 1.0 to 1.1

The download URL changed
- Add a rewrite rule in your web server configuration to rename file.php to f.php to make older, still existing links work again
The default theme changed
- Optionally change the theme in lib/config.local.php to »courgette«

From version 1.2.0 to 2.0.0

The "Terms of Service" text file changed
- To reuse previous changes to the ToS, move the old /tos_text.php file to /lib/tos.local.txt and remove all HTML und PHP Tags, leaving a regular text file

From version 2.0.0 to 3.4.1

There is nothing special to do to update from/to the following versions:

2.0.0 -> 3.0.0
3.0.0 -> 3.1.0
3.1.0 -> 3.2.0
3.2.0 -> 3.2.1
3.2.1 -> 3.3.0
3.3.0 -> 3.4.0
3.4.0 -> 3.4.1

From 3.4.1 to 4.0.0

You may have to change your administrator password in your config file as admin password are only stored using sha256 (SHA2). To do so, edit lib/config.local.php and update admin_password option using echo -n MyNewPassw0rd | sha256sum command.

Subfolder division changed in Jirafeau storage. You can either start from a fresh var- folder or you need to migrate your data.

In order to migrate your existing data:

Be sure to have a working backup of your Jirafeau instance and/or the rest of your hosting before any operation
Go to var- folder
Be sure you have read and write permissions on files and folders with your current user
Run the following commands:

# Migrate files folder
find files -type f ! -name "*_count" | while read f; do bn="$(basename "$f")"; dst="files/${bn:0:8}/${bn:8:8}/${bn:16:8}/${bn:24:8}/"; mkdir -p "$dst"; mv "$f" "$dst" ; mv "${f}_count" "$dst"; done; find files -maxdepth 1 -type d -iname "?" -exec rm -rf {} \;
# Migrate links folder
find links -type f | while read link; do bn="$(basename "$link")"; mkdir "links/$bn"; mv "$link" "links/$bn/"; done; find links -maxdepth 1 -type d -iname "?" -exec rm -rf {} \;

From 4.0.0 to 4.1.1

There is nothing special to do to update from/to the following versions:

4.0.0 -> 4.1.0
4.1.0 -> 4.1.1

Troubleshooting

If you have some troubles, consider the following cases

Check your /lib/config.local.php file and compare it with /lib/config.original.php, the configuration syntax or a parameter may have changed
Check owner & permissions of your files

Security

var directory contain all files and links. It is randomly named to limit access but you may add better protection to prevent un-authorized access to it. You have several options:

Configure a .htaccess
Move var folder to a place on your server which can't be directly accessed
Disable automatic listing on your web server config or place a index.html in var's sub-directory (this is a limited solution)

If you are using Apache, you can add the following line to your configuration to prevent people to access to your var folder:

RedirectMatch 301 ^/var-.* http://my.service.jirafeau

If you are using nginx, you can add the following to your $vhost.conf:

location ~ /var-.* {
    deny all;
    return 404;
}

If you are using lighttpd, you can deny access to var folder in your configuration:

$HTTP["url"] =~ "^/var-*" {
         url.access-deny = ("")
}

You should also remove un-necessessary write access once the installation is done (ex: configuration file). An other obvious basic security is to let access users to the site by HTTPS (make sure web_root in you config.local.php is set with https).

Server side encryption

Data encryption can be activated in options. This feature makes the server encrypt data and send the decryt key to the user (inside download URL). The decrypt key is not stored on the server so if you loose an url, you won't be able to retrieve file content. Encryption is configured to use AES256 in OFB mode. In case of security troubles on the server, attacker won't be able to access files.

By activating this feature, you have to be aware of few things:

Data encryption has a cost (cpu) and it takes more time for downloads to complete once file sent.
During the download, the server will decrypt on the fly (and use resource).
This feature needs to have the mcrypt php module.
File de-duplication will stop to work (as we can't compare two encrypted files).
Be sure your server do not log client's requests.
Don't forget to enable https.

In a next step, encryption will be made by the client (in javascript), see issue #10.

License

GNU Affero General Public License v3 (AGPL-3.0).

The GNU Affero General Public License can be found at https://www.gnu.org/licenses/agpl.html.

Please note: If you decide do make adaptions to the source code and run a service with these changes incorporated, you are required to provide a link to the source code of your version in order to obey the AGPL-3.0 license. To do so please add a link to the source (eg. a public Git repository or a download link) to the Terms of Service page. Take a look at the FAQ to find out about how to change the ToS.

PS: If you have fixed errors or added features, then please contribute to the project and send a merge request with these changes.

Contribution

If you want to contribute to project, then take a look at the git repository:

https://gitlab.com/mojo42/Jirafeau

and the Contribution Guidelines

https://gitlab.com/mojo42/Jirafeau/blob/master/CONTRIBUTING.md

FAQ

Can I add a new language in Jirafeau?

Of course ! Translations are easy to make and no technical knowledge is required.

Simply go to Jirafeau's Weblate.

If you want to add a new language in the list, feel free to contact us or leave a comment in ticket #9.

Thanks to all contributors ! :)

How do I upgrade my Jirafeau?

See upgrade instructions above.

How can I limit upload access?

There are two ways to limit upload access (but not download):

you can set one or more passwords in order to access the upload interface, or/and
you can configure a list of authorized IP (CIDR notation) which are allowed to access to the upload page

Check documentation of upload_password and upload_ip parameters in lib/config.original.php.

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

You can call the admin.php script from the command line (CLI) with the clean_expired or clean_async commands: sudo -u www-data php admin.php clean_expired.

Then the command can be placed in a cron file to automatize the process. For example:

# m h dom mon dow user  command
12 3    * * *   www-data  php /path/to/jirafeau/admin.php clean_expired
16 3    * * *   www-data  php /path/to/jirafeau/admin.php clean_async

I have some troubles with IE

If you have some strange behavior with IE, you may configure compatibility mode.

Anyway I would recommend you to use another web browser. :)

How can I change the theme?

You may change the default theme to any of the existing ones or a custom.

Open your lib/config.local.php and change setting in the »style« key to the name of any folder in the /media directory.

Hint: To create a custom theme just copy the »courgette« folder and name your theme »custom« (this way it will be ignored by git and not overwritten during updates). You are invited to enhance the existing themes and send pull requests however.

I found a bug, what should I do?

Feel free to open a bug in the GitLab's issues.

How to set maximum file size?

If your browser supports HTML5 file API, you can send files as big as you want.

For browsers who does not support HTML5 file API, the limitation come from PHP configuration. You have to set post_max_size and upload_max_filesize in your php configuration. Note that Nginx setups may requiere to configure client_max_body_size.

If you don't want to allow unlimited upload size, you can still setup a maximal file size in Jirafeau's setting (see maximal_upload_size in your configuration)

How can I edit an option?

Documentation of all default options are located in lib/config.original.php. If you want to change an option, just edit your lib/config.local.php.

How can I change the Terms of Service?

The license text on the "Terms of Service" page, which is shipped with the default installation, is based on the »Open Source Initiative Terms of Service«.

To change this text simply copy the file /lib/tos.original.txt, rename it to /lib/tos.local.txt and adapt it to your own needs.

If you update the installation, then only the tos.original.txt file may change eventually, not your tos.local.txt file.

How can I access the admin interface?

Just go to /admin.php.

How can I use the scripting interface (API)?

Simply go to /script.php with your web browser.

My downloads are incomplete or my uploads fails

Be sure your PHP installation is not using safe mode, it may cause timeouts.

If you're using nginx, you might need to increase client_max_body_size or remove the restriction altogether. In your nginx.conf:

http {
    # disable max upload size
    client_max_body_size 0;
    # add timeouts for very large uploads
    client_header_timeout 30m;
    client_body_timeout 30m;
}

How can I monitor the use of my Jirafeau instance?

You may use Munin and simple scripts to collect the number of files in the Jirafeau instance as well as the disk space occupied by all the files. You can consult this web page.

Why forking?

The original project seems not to be continued anymore and I prefer to add more features and increase security from a stable version.

What can we expect in the future?

Check issues to check open bugs and incoming new stuff. :)

What about this file deduplication thing?

Jirafeau uses a very simple file level deduplication for storage optimization.

This mean that if some people upload several times the same file, this will only store one time the file and increment a counter.

If someone use his/her delete link or an admin cleans expired links, this will decrement the counter corresponding to the file.

When the counter falls to zero, the file is destroyed.

What is the difference between "delete link" and "delete file and links" in admin interface?

As explained in the previous question, files with the same md5 hash are not duplicated and a reference counter stores the number of links pointing to a single file. So:

The button "delete link" will delete the reference to the file but might not destroy the file.
The button "delete file and links" will delete all references pointing to the file and will destroy the file.

How to contact someone from Jirafeau?

Feel free to create an issue if you found a bug.

Release notes

Version 1.0

The very first version of Jirafeau after the fork of Jyraphe.

Security fix
Keep uploader's ip
Delete link for each upload
No more clear text password storage
Simple langage support
Add an admin interface
New Design
Add term of use
New path system to manage large number of files
New option to show a page at download time
Add option to activate or not preview mode

Version 1.1

New skins
Add optional server side encryption
Unlimited file size upload using HTML5 file API
Show speed and estimated time during upload
A lot of fixes
A lot of new langages
Small API to upload files
Limit access to Jirafeau using IP, mask, passwords
Manage (some) proxy headers
Configure your maximal upload size
Configure file's lifetime durations
Preview URL
Get Jirafeau's version in admin interface

Version 1.2.0

Link on API page to generate bash script
More informative error codes for API
Security Fix: Prevent authentication bypass for admin interface
CLI script to remove expired files automatically with a cronjob
SHA-256 hash the admin password
New theme "elegantish"
Fix for JavaScript MIME-Type, prevents blocking the resource on some servers
Show download link for a file in admin interface
Default time for expiration (set to 'month' by default)
New expiration time: 'quarter'
A lof of translation contributions
Code cleanups

Version 2.0.0

Various documentation improvements
Simplify automatic generation of local configuration file
Set a custom title
Bash Script: Enhanced help, show version, return link to web view as well
»Terms of Service« refactored - Enable admin to overwrite the ToS, without changing existing source code → breaking, see upgrade notes

Version 3.0.0

Remove XHTML doctype, support HTML5 only → breaking change for older browsers
Remove redundant code
Remove baseurl usage and set absolute links instead, which for example fixes SSL issues
Extend contribution guide
Switch to PSR-2 code style (fix line endings, indentations, whitespaces, etc)
Declare system requirements
Catch API errors in upload form
Allow clients to upload files depending on IP or password
Set UTC as timezone to prevent date/time issues
Show readable date & time information
Fix UI glitches in admin panel and upload form

Version 3.1.0

Fix regression on user authentication (see #113)
Some cosmetic change

Version 3.2.0

Update translations from Update translations from weblate
Better style
Fix regression on admin password setting

Version 3.2.1

fix download view after an upload

Version 3.3.0

Added Docker Support
Added a copy button next to links to copy URLs in clipboard
Now use a delete page to confirm file deletion (#136)
Fixed object ProgressEvent Error (#127)
Added configuration tips for web servers
More translations
Style fixes
Removed useless alias API support (some old toy)

Version 3.4.0

Add encryption support in bash script
Refactoring of lang system for simpler management
Removed installation step asking for language
Merged weblate contributions
Fixed some spelling issues

Version 3.4.1

Security fixes, thanks Bishopfox Team
Translation fixes
Docker fix
Advertise javascript license for LibreJS compatibility
other minor fixes

Version 4.0.0

Removed plain-text password support for admin auth (breaking change).
Default folder sub-division to 8 characters (breaking change).
New option upload_ip_nopassword to allow a list of IP to access Jirafeau without password
Bugfix with LibreJS
Other minor bug fixes
More languages supported

Version 4.1.0

Fix upload password and allowed ip (#201)
Code refactorisation of IP checking
Fix expiration dates
Add better support for Accept-Language
Cosmetic fixes
More languages supported and language fixes

Version 4.1.1

Fix lang sanity check

Name		Name	Last commit message	Last commit date
Latest commit History 6 Commits
docker		docker
lib		lib
media		media
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
LICENSE.txt		LICENSE.txt
README.md		README.md
admin.php		admin.php
f.php		f.php
index.php		index.php
install.php		install.php
script.php		script.php
todo-list_mes_améliorations.md		todo-list_mes_améliorations.md
tos.php		tos.php

License

ValentinGratz/Jirafeu

Folders and files

Latest commit

History

Repository files navigation

Jirafeau

Main features

Screenshots

Installation

Upgrade

General procedure for all versions

From version 1.0 to 1.1

From version 1.2.0 to 2.0.0

From version 2.0.0 to 3.4.1

From 3.4.1 to 4.0.0

From 4.0.0 to 4.1.1

Troubleshooting

Security

Server side encryption

License

Contribution

FAQ

Can I add a new language in Jirafeau?

How do I upgrade my Jirafeau?

How can I limit upload access?

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

I have some troubles with IE

How can I change the theme?

I found a bug, what should I do?

How to set maximum file size?

How can I edit an option?

How can I change the Terms of Service?

How can I access the admin interface?

How can I use the scripting interface (API)?

My downloads are incomplete or my uploads fails

How can I monitor the use of my Jirafeau instance?

Why forking?

What can we expect in the future?

What about this file deduplication thing?

What is the difference between "delete link" and "delete file and links" in admin interface?

How to contact someone from Jirafeau?

Release notes

Version 1.0

Version 1.1

Version 1.2.0

Version 2.0.0

Version 3.0.0

Version 3.1.0

Version 3.2.0

Version 3.2.1

Version 3.3.0

Version 3.4.0

Version 3.4.1

Version 4.0.0

Version 4.1.0

Version 4.1.1

About

Resources

License

Stars

Watchers

Forks

Languages