X-Git-Url: https://git.p6c8.net/jirafeau_mojo42.git/blobdiff_plain/c9d656d4893e5a5b7f6eb27aa1332aa165df7649..825e15ed5fca89b6ee08ecfba03dcccd5e4744b3:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 531fc2a..d4b3f95 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,17 @@ Welcome to the official Jirafeau project, an [Open-Source software](https://en.wikipedia.org/wiki/Open-source_software). -Jirafeau is a project permitting a "one-click-filesharing", which makes it possible to upload a file in a simple way and give an unique link to it. +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](http://jirafeau.net/). +A demonstration of the latest version is available on [jirafeau.net](https://jirafeau.net/). ![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 @@ -20,7 +25,7 @@ A demonstration of the latest version is available on [jirafeau.net](http://jira - Shortened URLs using base 64 encoding - Maximal upload size configurable - NO database, only use basic PHP -- Simple language support :gb: :fr: :de: :it: :nl: :ro: :sk: :hu: :cn: :gr: :ru: :es: +- Simple language support :gb: :fr: :de: :it: :nl: :ro: :sk: :hu: :cn: :gr: :ru: :es: :tk: :flag_tr: :flag_pt: :flag_br: - File level [Deduplication](http://en.wikipedia.org/wiki/Data_deduplication) for storage optimization (does store duplicate files only once, but generate multiple links) - Optional data encryption - Small administration interface @@ -28,7 +33,7 @@ A demonstration of the latest version is available on [jirafeau.net](http://jira - Basic, adaptable »Terms Of Service« page - Basic API - Bash script to upload files via command line -- Skins +- Themes Jirafeau 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. @@ -50,6 +55,10 @@ Jirafeau project won't evolve to a file manager and will focus to keep a very fe ## Installation +This shows how to install Jirafeau by your own, it's quite simple but you can +also use a [docker image](https://hub.docker.com/r/mojo42/jirafeau/) or build +it yourself. Check [docker folder](docker/README.md) for more informations. + System requirements: - PHP >= 5.6 - Optional, but recommended: Git >= 2.7 @@ -81,14 +90,23 @@ Installation steps: 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 -1. The default skin changed - * Optionally change the skin in ```lib/config.local.php``` to »courgette« +1. The default theme changed + * Optionally change the theme in ```lib/config.local.php``` to »courgette« ### From version 1.2.0 to 2.0.0 1. 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.3.0 + +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 + ### Troubleshooting If you have some troubles, consider the following cases @@ -117,8 +135,16 @@ location ~ /var-.* { } ``` +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. +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 @@ -200,6 +226,14 @@ 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](https://gitlab.com/mojo42/Jirafeau/issues). @@ -339,3 +373,43 @@ The very first version of Jirafeau after the fork of Jyraphe. - 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)