Merge remote-tracking branch 'origin/master'

[jirafeau.git] / README.md

diff --git a/README.md b/README.md
index 38f882ca760187ade626a8e756d9e08718de8cbe..ea431eea7afbfc3688daefd0f58371a2eabbb0fa 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ A demonstration of the latest version is available on [jirafeau.net](http://jira
 -  Optional Password protection (for uploading or downloading)
 -  Time limitation
 -  Option to self-destruct after reading
 -  Optional Password protection (for uploading or downloading)
 -  Time limitation
 -  Option to self-destruct after reading

--  Simple language support :gb: :fr: :de: :it: :nl: :ro: :sk:
+-  Simple language support :gb: :fr: :de: :it: :nl: :ro: :sk: :hu:

 -  Small administration interface
 -  File level [Deduplication](http://en.wikipedia.org/wiki/Data_deduplication) for storage optimization
 -  A basic Terms Of Service which can be adapted to your needs
 -  Small administration interface
 -  File level [Deduplication](http://en.wikipedia.org/wiki/Data_deduplication) for storage optimization
 -  A basic Terms Of Service which can be adapted to your needs


@@ -52,6 +52,10 @@ Here are some screenshots:
 -  Get your web browser and go to you install location (e.g. ```http://your-web-site.org/jirafeau/```) and follow instructions
 -  Some options are not configured from the minimal installation wizard, you may take a look at option documentation in ```lib/config.original.php``` and customize your ```lib/config.local.php```
 
 -  Get your web browser and go to you install location (e.g. ```http://your-web-site.org/jirafeau/```) and follow instructions
 -  Some options are not configured from the minimal installation wizard, you may take a look at option documentation in ```lib/config.original.php``` and customize your ```lib/config.local.php```
 

+Note that ```lib/config.local.php``` is auto-generated during the installation.
+
+If you don't want to go through the installation wizard, you can just copy ```config.original.php``` to ```config.local.php``` and customize it.
+

 # 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.
 # 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.


@@ -65,7 +69,6 @@ If you are using Apache, you can add the following lineto your configuration to
 ```RedirectMatch 301 ^/var-.* http://my.service.jirafeau ```
 
 You should also remove un-necessessary write access once the installation is done (ex: configuration file).
 ```RedirectMatch 301 ^/var-.* http://my.service.jirafeau ```
 
 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.
 
 # Few notes about server side encryption
 An other obvious basic security is to let access users to the site by HTTPS.
 
 # Few notes about server side encryption


@@ -79,8 +82,8 @@ By activating this feature, you have to be aware of few things:
 -  During the download, the server will decrypt on the fly (and use resource).
 -  This feature needs to have the mcrypt php module.
 -  File de-duplication will stop to work (as we can't compare two encrypted files).
 -  During the download, the server will decrypt on the fly (and use resource).
 -  This feature needs to have the mcrypt php module.
 -  File de-duplication will stop to work (as we can't compare two encrypted files).

--  Be sure you server do not log client's requests.
--  Don't forget to activate https.
+-  Be sure your server do not log client's requests.
+-  Don't forget to enable https.

 
 In a next step, encryption will be made by the client (in javascript), see issue #10.
 
 
 In a next step, encryption will be made by the client (in javascript), see issue #10.
 


@@ -189,4 +192,49 @@ So:
 
 ### How to contact someone from Jirafeau ?
 
 
 ### How to contact someone from Jirafeau ?
 

-Feel free to create an issue if you found a bug, else you can send an email at j.jutteau A.T gmail .DOT. com
+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 Jiraph.
+
+- 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
+
+### Update from 1.0 to 1.1
+
+1. Backup you Jirafeau installation
+2. Block access to Jirafeau
+3. Checkout new version using git tag 1.1
+4. With you browser, go to your Jirafeau root page
+5. Follow installation wizard, it should propose you the same data folder
+6. Add a rewrite rule in your web server configuration to rename file.php to f.php to make old url work again
+7. Go in you lib/config.local.php and lib/config.original.php to check new options and eventually change skin to 'courgette'
+