Jirafeau version 4.0.0

[jirafeau_project.git] / README.md

diff --git a/README.md b/README.md
index ae3706b4122986252a2d4f3562faede343e76976..db4bbcaf589a1e43ac7021f3edf56ef0a66d827e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,3 @@
-# SECURITY ANNOUNCEMENT
-
-## 3th Mai 2018
-
-Multiple security vulnerabilities has been reported by [Bishopfox team](https://www.bishopfox.com/) on Jirafeau project.
-
-The next release of Jirafeau (3.4.1) will include security fixes and is planned 12th Mai 2018.
-
-Upgrading Jirafeau is recommended.
-

 # Jirafeau
 
 Welcome to the official Jirafeau project, an [Open-Source software](https://en.wikipedia.org/wiki/Open-source_software).
 # Jirafeau
 
 Welcome to the official Jirafeau project, an [Open-Source software](https://en.wikipedia.org/wiki/Open-source_software).


@@ -75,7 +65,7 @@ System requirements:
 - No database required, no mail required
 
 Installation steps:
 - 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/```
 - 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/```


@@ -108,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.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
 
 There is nothing special to do to update from/to the following versions:
 - 2.0.0 -> 3.0.0


@@ -116,6 +106,8 @@ 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.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

 
 ### Troubleshooting
 
 
 ### Troubleshooting
 


@@ -160,6 +152,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.
 
 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:
 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:


@@ -178,13 +171,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.
 
 
 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.
 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:
 ## Contribution
 
 If you want to contribute to project, then take a look at the git repository:


@@ -253,7 +246,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.
 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)
 
 
 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)
 


@@ -431,3 +424,20 @@ The very first version of Jirafeau after the fork of Jyraphe.
 - Removed installation step asking for language
 - Merged weblate contributions
 - Fixed some spelling issues
 - 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). Update `admin_password` option using `echo -n MyNewPassw0rd | sha256sum` command.
+- 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