X-Git-Url: https://git.p6c8.net/jirafeau_mojo42.git/blobdiff_plain/d9ec51d885b286e2eebe786ad9bab441a9e38120..78a1c41c40bb216e3879220fc544f8ae816d3c1b:/README.md diff --git a/README.md b/README.md index d4b3f95..416ffcc 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 @@ -65,14 +65,14 @@ System requirements: - No database required, no mail required Installation steps: -- Clone the [repository](https://gitlab.com/mojo42/Jirafeau/) or download the latest ([release](https://gitlab.com/mojo42/Jirafeau/tags) from GitLab onto your webserver +- Clone the [repository](https://gitlab.com/mojo42/Jirafeau/) or download the latest [release](https://gitlab.com/mojo42/Jirafeau/tags) 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 + - Just copy ```lib/config.original.php``` to ```lib/config.local.php``` and customize it ## Upgrade @@ -98,7 +98,7 @@ Installation steps: 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 +### 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 @@ -106,6 +106,33 @@ There is nothing special to do to update from/to the following versions: - 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: +1. Be sure to have a working backup of your Jirafeau instance and/or the rest of your hosting before any operation +2. Go to `var-` folder +3. Be sure you have read and write permissions on files and folders with your current user +4. Run the following commands: +```bash +# 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 @@ -116,7 +143,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 @@ -150,6 +177,7 @@ An other obvious basic security is to let access users to the site by HTTPS (mak 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: @@ -168,13 +196,13 @@ 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, +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: @@ -191,11 +219,11 @@ 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? @@ -243,7 +271,7 @@ Feel free to open a bug in the [GitLab's issues](https://gitlab.com/mojo42/Jiraf 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](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. +You 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`. 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) @@ -306,9 +334,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. @@ -413,3 +443,42 @@ The very first version of Jirafeau after the fork of Jyraphe. - 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 + +## 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 +