X-Git-Url: https://git.p6c8.net/jirafeau.git/blobdiff_plain/7511bd61153aaa912ebb96e3f2d6a49b27cdde5d..6191c11794e03440b10b1f8fddcc627114d82cc4:/README.md?ds=sidebyside diff --git a/README.md b/README.md index dc3522a..37fdfc7 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Next Release [![Build Status Next Release](https://gitlab.com/mojo42/Jirafeau/ba - 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: :tk: :flag_tr: :flag_pt: :flag_br: +- Simple language support with a lot of langages (help us on [weblate](https://hosted.weblate.org/engage/jirafeau/)!) - 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 @@ -72,42 +72,7 @@ Installation steps: - 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 - -1. Backup your Jirafeau installation! -2. Block access to Jirafeau -3. Checkout the new version with Git using the [tagged release](https://gitlab.com/mojo42/Jirafeau/tags) - * 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. -4. With you browser, go to your Jirafeau root page -5. Follow the installation wizard, it should propose you the same data folder or even update automatically -7. 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 - -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 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.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 + - Just copy ```lib/config.original.php``` to ```lib/config.local.php``` and customize it ### Troubleshooting @@ -118,7 +83,7 @@ If you have some troubles, consider the following cases ## 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. +```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. You have several options: - Configure a ```.htaccess``` - Move var folder to a place on your server which can't be directly accessed @@ -194,15 +159,15 @@ and the Contribution Guidelines Of course ! Translations are easy to make and no technical knowledge is required. -Simply go to [Jirafeau's Weblate](https://hosted.weblate.org/projects/jirafeau/master/). +Simply go to [Jirafeau's Weblate](https://hosted.weblate.org/engage/jirafeau/). If you want to add a new language in the list, feel free to contact us or leave a comment in ticket #9. -We would like to thank all anonymous contributors on weblate. :) +Thanks to all contributors ! :) ### How do I upgrade my Jirafeau? -See upgrade instructions above. +See change log and upgrade procedure in [CHANGELOG.md](https://gitlab.com/mojo42/Jirafeau/blob/master/CHANGELOG.md). ### How can I limit upload access? @@ -309,9 +274,11 @@ If someone use his/her delete link or an admin cleans expired links, this will d When the counter falls to zero, the file is destroyed. +In 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`). + ### 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. +As 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. 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. @@ -319,116 +286,3 @@ So: ### 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](https://www.bishopfox.com/) -- Translation fixes -- Docker fix -- Advertise javascript license for LibreJS compatibility -- other minor fixes