[TASK] don't assume http or https for webroot at installation

[jirafeau_project.git] / README.md

diff --git a/README.md b/README.md
index cc06f11442a8cd7da7b8f0b8cacc503f8d55dd7f..615c3ea2df19fcc4a2d6b99a0a11db2a063b5376 100644 (file)
--- a/README.md
+++ b/README.md
@@ -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
 
 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
+### 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
 
 There is nothing special to do to update from/to the following versions:
 - 2.0.0 -> 3.0.0


@@ -109,6 +109,31 @@ There is nothing special to do to update from/to the following versions:
 - 3.3.0 -> 3.4.0
 - 3.4.0 -> 3.4.1
 
 - 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
 
 If you have some troubles, consider the following cases
 ### Troubleshooting
 
 If you have some troubles, consider the following cases


@@ -309,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.
 
 
 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?
 
 ### 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.
 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.


@@ -435,9 +462,23 @@ The very first version of Jirafeau after the fork of Jyraphe.
 
 ## Version 4.0.0
 
 
 ## Version 4.0.0
 

-- Removed plain-text password support for admin auth (breaking change). Update `admin_password` option using `echo -n MyNewPassw0rd | sha256sum` command.
+- 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
 - 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
+