{"id":20976925,"url":"https://github.com/pixelbrackets/jirafeau","last_synced_at":"2025-06-23T11:36:19.541Z","repository":{"id":145819677,"uuid":"318216579","full_name":"pixelbrackets/jirafeau","owner":"pixelbrackets","description":":twisted_rightwards_arrows: Fork of »Jirafeau« to send pull requests ","archived":false,"fork":false,"pushed_at":"2020-12-03T14:20:32.000Z","size":1010,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-21T14:45:37.840Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://gitlab.com/mojo42/Jirafeau","language":"PHP","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pixelbrackets.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSES/AGPL-3.0-or-later.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-03T14:18:13.000Z","updated_at":"2020-12-03T14:21:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"0a86f0b9-595a-4f16-8569-f24fc0835b52","html_url":"https://github.com/pixelbrackets/jirafeau","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pixelbrackets/jirafeau","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelbrackets%2Fjirafeau","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelbrackets%2Fjirafeau/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelbrackets%2Fjirafeau/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelbrackets%2Fjirafeau/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pixelbrackets","download_url":"https://codeload.github.com/pixelbrackets/jirafeau/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelbrackets%2Fjirafeau/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261469653,"owners_count":23163147,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T04:56:22.000Z","updated_at":"2025-06-23T11:36:14.530Z","avatar_url":"https://github.com/pixelbrackets.png","language":"PHP","readme":"# Jirafeau\n\nWelcome to the official Jirafeau project, an [Open-Source software](https://en.wikipedia.org/wiki/Open-source_software).\n\nJirafeau is a \"one-click-filesharing\": Select your file, upload, share a link. That's it.\n\nSee [jirafeau.net](https://jirafeau.net/) for a demo.\n\n![Screenshot1](http://i.imgur.com/TPjh48P.png)\n\nLatest CI Status:\nMaster [![Build Status Master](https://gitlab.com/mojo42/Jirafeau/badges/master/build.svg)](https://gitlab.com/mojo42/Jirafeau/commits/master)\nNext Release [![Build Status Next Release](https://gitlab.com/mojo42/Jirafeau/badges/test/build.svg)](https://gitlab.com/mojo42/Jirafeau/commits/master)\n[All Branch Builds](https://gitlab.com/mojo42/Jirafeau/pipelines?scope=branches)\n\n## Main features\n\n- One upload → One download link \u0026 one delete link\n- Send any large files (thanks to the HTML5 file API → PHP post_max_size limit not relevant)\n- Shows progression: speed, percentage and remaining upload time\n- Preview content in browser (if possible)\n- Optional password protection (for uploading or downloading)\n- Set expiration time for downloads\n- Option to self-destruct after first download\n- Shortened URLs using base 64 encoding\n- Maximal upload size configurable\n- NO database, only use basic PHP\n- Simple language support with a lot of langages (help us on [weblate](https://hosted.weblate.org/engage/jirafeau/)!)\n- File level [Deduplication](http://en.wikipedia.org/wiki/Data_deduplication) for storage optimization (does store duplicate files only once, but generate multiple links)\n- Optional data encryption\n- Small administration interface\n- CLI script to remove expired files automatically with a cronjob\n- Basic, adaptable »Terms Of Service« page\n- Basic API\n- Bash script to upload files via command line\n- Themes\n\nJirafeau is a fork of the original project [Jyraphe](http://home.gna.org/jyraphe/) based on the 0.5 (stable version) with a **lot** of modifications.\n\nAs it's original project, Jirafeau is made in the [KISS](http://en.wikipedia.org/wiki/KISS_principle) way (Keep It Simple, Stupid).\n\nJirafeau project won't evolve to a file manager and will focus to keep a very few dependencies.\n\n## Screenshots\n\n- [Installation - Step 1](http://i.imgur.com/hmpT1eN.jpg)\n- [Installation - Step 2](http://i.imgur.com/2e0UGKE.jpg)\n- [Installation - Step 3](http://i.imgur.com/ofAjLXh.jpg)\n- [Installation - Step 4](http://i.imgur.com/WXqnfqJ.jpg)\n- [Upload - Step 1](http://i.imgur.com/SBmSwzJ.jpg)\n- [Upload - Step 2](http://i.imgur.com/wzPkb1Z.jpg)\n- [Upload - Progress](http://i.imgur.com/i6n95kv.jpg)\n- [Upload - Confirmation page](http://i.imgur.com/P2oS1MY.jpg)\n- [Admin Interface](http://i.imgur.com/nTdsVzn.png)\n\n## Installation\n\nThis shows how to install Jirafeau by your own, it's quite simple but you can\nalso use a [docker image](https://hub.docker.com/r/mojo42/jirafeau/) or build\nit yourself. Check [docker folder](docker/README.md) for more informations.\n\nSystem requirements:\n- PHP \u003e= 5.6\n- Optional, but recommended: Git \u003e= 2.7\n- No database required, no mail required\n\nInstallation steps:\n- Clone the [repository](https://gitlab.com/mojo42/Jirafeau/) or download the latest [release](https://gitlab.com/mojo42/Jirafeau/tags) from GitLab onto your webserver\n- Set owner \u0026 group according to your webserver\n- A) Setup with the installation wizard (web):\n  - Open your browser and go to your installed location, eg. ```https://example.com/jirafeau/```\n  - The script will redirect to you to a minimal installation wizard to set up all required options\n  - All optional parameters may be set in ```lib/config.local.php```, take a look at ```lib/config.original.php``` to see all default values\n- B) Setup without the installation wizard (cli):\n  - Just copy ```lib/config.original.php``` to ```lib/config.local.php``` and customize it\n\n### Troubleshooting\n\nIf you have some troubles, consider the following cases\n\n- Check your ```/lib/config.local.php``` file and compare it with ```/lib/config.original.php```, the configuration syntax or a parameter may have changed\n- Check owner \u0026 permissions of your files\n- set `debug` option to `true` to check any warning or error\n\n## Security\n\n```var``` directory contains all files and links. It is randomly named to limit access but you may add better protection to prevent un-authorized access to it.\nYou have several options:\n- Configure a ```.htaccess```\n- Move var folder to a place on your server which can't be directly accessed\n- Disable automatic listing on your web server config or place a index.html in var's sub-directory (this is a limited solution)\n\nIf you are using Apache, you can add the following line to your configuration to prevent people to access to your ```var``` folder:\n\n```RedirectMatch 301 ^/var-.* http://my.service.jirafeau ```\n\nIf you are using nginx, you can add the following to your $vhost.conf:\n\n```nginx\nlocation ~ /var-.* {\n    deny all;\n    return 404;\n}\n```\n\nIf you are using lighttpd, you can deny access to ```var``` folder in your configuration:\n\n```\n$HTTP[\"url\"] =~ \"^/var-*\" {\n         url.access-deny = (\"\")\n}\n```\n\nYou should also remove un-necessessary write access once the installation is done (ex: configuration file).\nAn 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).\n\n## Server side encryption\n\nData encryption can be activated in options. This feature makes the server encrypt data and send the decryt key to the user (inside download URL).\nThe decrypt key is not stored on the server so if you loose an url, you won't be able to retrieve file content.\nEncryption is configured to use AES256 in OFB mode.\nIn case of security troubles on the server, attacker won't be able to access files.\n\nBy activating this feature, you have to be aware of few things:\n-  Data encryption has a cost (cpu) and it takes more time for downloads to complete once file sent.\n-  During the download, the server will decrypt on the fly (and use resource).\n-  This feature needs to have the mcrypt php module.\n-  File de-duplication will stop to work (as we can't compare two encrypted files).\n-  Be sure your server do not log client's requests.\n-  Don't forget to enable https.\n\nIn a next step, encryption will be made by the client (in javascript), see issue #10.\n\n## License\n\nGNU Affero General Public License v3 (AGPL-3.0).\n\nThe GNU Affero General Public License can be found at https://www.gnu.org/licenses/agpl.html.\n\nPlease note: If you decide do make adaptions to the source code and run a service with these changes incorporated,\nyou are required to provide a link to the source code of your version in order to obey the AGPL-3.0 license.\nTo do so please add a link to the source (eg. a public Git repository or a download link) to the Terms of Service page.\nTake a look at the FAQ to find out about how to change the ToS.\n\nPS: If you have fixed errors or added features, then please contribute to the project and send a merge request with these changes.\n\n## Contribution\n\nIf you want to contribute to project, then take a look at the git repository:\n\n- https://gitlab.com/mojo42/Jirafeau\n\nand the Contribution Guidelines\n\n- https://gitlab.com/mojo42/Jirafeau/blob/master/CONTRIBUTING.md\n\n## FAQ\n\n### Can I add a new language in Jirafeau?\n\nOf course ! Translations are easy to make and no technical knowledge is required.\n\nSimply go to [Jirafeau's Weblate](https://hosted.weblate.org/engage/jirafeau/).\n\nIf you want to add a new language in the list, feel free to contact us or leave a comment in ticket #9.\n\nThanks to all contributors ! :)\n\n### How do I upgrade my Jirafeau?\n\nSee change log and upgrade procedure in [CHANGELOG.md](https://gitlab.com/mojo42/Jirafeau/blob/master/CHANGELOG.md).\n\n### How can I limit upload access?\n\nThere are two ways to limit upload access (but not download):\n- you can set one or more passwords in order to access the upload interface, or/and\n- you can configure a list of authorized IP ([CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)) which are allowed to access to the upload page\n\nCheck documentation of ```upload_password``` and ```upload_ip``` parameters in [lib/config.original.php](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/config.original.php).\n\n### How can I automatize the cleaning of old (expired) files?\n\nYou 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```.\n\nThen the command can be placed in a cron file to automatize the process. For example:\n```\n# m h dom mon dow user  command\n12 3    * * *   www-data  php /path/to/jirafeau/admin.php clean_expired\n16 3    * * *   www-data  php /path/to/jirafeau/admin.php clean_async\n```\n\n### I have some troubles with IE\n\nIf you have some strange behavior with IE, you may configure [compatibility mode](http://feedback.dominknow.com/knowledgebase/articles/159097-internet-explorer-ie8-ie9-ie10-and-ie11-compat).\n\nAnyway I would recommend you to use another web browser. :)\n\n### How can I change the theme?\n\nYou may change the default theme to any of the existing ones or a custom.\n\nOpen your ```lib/config.local.php``` and change setting in the »`style`« key to the name of any folder in the ```/media``` directory.\n\nHint: 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.\n\n### I found a bug, what should I do?\n\nFeel free to open a bug in the [GitLab's issues](https://gitlab.com/mojo42/Jirafeau/issues).\n\n### How to set maximum file size?\n\nIf your browser supports HTML5 file API, you can send files as big as you want.\n\nFor browsers who does not support HTML5 file API, the limitation come from PHP configuration.\nYou have to set [post_max_size](https://php.net/manual/en/ini.core.php#ini.post-max-size) and [upload_max_filesize](https://php.net/manual/en/ini.core.php#ini.upload-max-filesize) in your php configuration. Note that Nginx setups may requiere to configure `client_max_body_size`.\n\nIf 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)\n\n### How can I edit an option?\n\nDocumentation of all default options are located in [lib/config.original.php](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/config.original.php).\nIf you want to change an option, just edit your ```lib/config.local.php```.\n\n### How can I change the Terms of Service?\n\nThe 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](https://opensource.org/ToS)«.\n\nTo change this text simply copy the file [/lib/tos.original.txt](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/tos.original.txt), rename it to ```/lib/tos.local.txt``` and adapt it to your own needs.\n\nIf you update the installation, then only the ```tos.original.txt``` file may change eventually, not your ```tos.local.txt``` file.\n\n### How can I access the admin interface?\n\nJust go to ```/admin.php```.\n\n### How can I use the scripting interface (API)?\n\nSimply go to ```/script.php``` with your web browser.\n\n### My downloads are incomplete or my uploads fails\n\nBe sure your PHP installation is not using safe mode, it may cause timeouts.\n\nIf you're using nginx, you might need to increase `client_max_body_size` or remove the restriction altogether. In your nginx.conf:\n\n```nginx\nhttp {\n    # disable max upload size\n    client_max_body_size 0;\n    # add timeouts for very large uploads\n    client_header_timeout 30m;\n    client_body_timeout 30m;\n}\n```\n\n### How can I monitor the use of my Jirafeau instance?\n\nYou 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](https://blog.bandinelli.net/index.php?post/2016/05/15/Scripts-Munin-pour-Jirafeau).\n\n### Why forking?\n\nThe original project seems not to be continued anymore and I prefer to add more features and increase security from a stable version.\n\n### What can we expect in the future?\n\nCheck [issues](https://gitlab.com/mojo42/Jirafeau/issues) to check open bugs and incoming new stuff. :)\n\n### What about this file deduplication thing?\n\nJirafeau uses a very simple file level deduplication for storage optimization.\n\nThis mean that if some people upload several times the same file, this will only store one time the file and increment a counter.\n\nIf someone use his/her delete link or an admin cleans expired links, this will decrement the counter corresponding to the file.\n\nWhen the counter falls to zero, the file is destroyed.\n\nIn order to know if a newly uploaded file already exist, Jirafeau will hash the file using md5 by default but other methods are available (see `file_hash` documentation in `lib/config.original.php`).\n\n### What is the difference between \"delete link\" and \"delete file and links\" in admin interface?\n\nAs explained in the previous question, files with the same hash are not duplicated and a reference counter stores the number of links pointing to a single file.\nSo:\n- The button \"delete link\" will delete the reference to the file but might not destroy the file.\n- The button \"delete file and links\" will delete all references pointing to the file and will destroy the file.\n\n### How to contact someone from Jirafeau?\n\nFeel free to create an issue if you found a bug.\n\n### Can I buy you a coffee?\n\nYou can [drop few bucks](https://www.paypal.com/paypalme/jeromejutteau) to help the [demo web site](https://jirafeau.net) to stay alive.\n","funding_links":["https://www.paypal.com/paypalme/jeromejutteau"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixelbrackets%2Fjirafeau","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpixelbrackets%2Fjirafeau","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixelbrackets%2Fjirafeau/lists"}