X-Git-Url: https://git.p6c8.net/jirafeau.git/blobdiff_plain/1adc7273904dc3be64b309739d9eb9ecdbd67622..8665ea5fc150ca65125f24023b545fe39bdb2a95:/README.md diff --git a/README.md b/README.md index 37fdfc7..4a243a2 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # Jirafeau +![Build Status](https://img.shields.io/gitlab/pipeline/mojo42/Jirafeau/master.svg) +![Made With](https://img.shields.io/badge/made_with-php-blue.svg) +![License](https://img.shields.io/badge/license-agpl--3.0-blue.svg) +![Contribution](https://img.shields.io/badge/contributions_welcome-brightgreen.svg?labelColor=brightgreen) + Welcome to the official Jirafeau project, an [Open-Source software](https://en.wikipedia.org/wiki/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. +Jirafeau is a "one-click-filesharing": Select your file, upload, share a link. That's it. -A demonstration of the latest version is available on [jirafeau.net](https://jirafeau.net/). +See [jirafeau.net](https://jirafeau.net/) for a demo. ![Screenshot1](http://i.imgur.com/TPjh48P.png) -Latest CI Status: -Master [![Build Status Master](https://gitlab.com/mojo42/Jirafeau/badges/master/build.svg)](https://gitlab.com/mojo42/Jirafeau/commits/master) -Next Release [![Build Status Next Release](https://gitlab.com/mojo42/Jirafeau/badges/test/build.svg)](https://gitlab.com/mojo42/Jirafeau/commits/master) -[All Branch Builds](https://gitlab.com/mojo42/Jirafeau/pipelines?scope=branches) - ## Main features - One upload → One download link & one delete link @@ -74,12 +74,17 @@ Installation steps: - B) Setup without the installation wizard (cli): - Just copy ```lib/config.original.php``` to ```lib/config.local.php``` and customize it +💡 Hint: How to +[install & configure Jirafeau](https://www.howtoforge.com/how-to-setup-a-file-sharing-website-with-jirafeau-on-debian-10/) +on Debian 10 from scratch, with Nginx and PHP-FPM. + ### 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 +- set `debug` option to `true` to check any warning or error ## Security @@ -205,6 +210,8 @@ Hint: To create a custom theme just copy the »courgette« folder and name your ### I found a bug, what should I do? Feel free to open a bug in the [GitLab's issues](https://gitlab.com/mojo42/Jirafeau/issues). +If you can, please copy-paste informations related to bug opening provided in admin interface. +Admin interface can be reached by accessing `/admin.php`. ### How to set maximum file size? @@ -286,3 +293,7 @@ So: ### How to contact someone from Jirafeau? Feel free to create an issue if you found a bug. + +### Can I buy you a coffee? + +You can [drop few bucks](https://www.paypal.com/paypalme/jeromejutteau) to help the [demo web site](https://jirafeau.net) to stay alive.