admin: show Jirafeau version in admin interface

[jirafeau_project.git] / README.md

diff --git a/README.md b/README.md
index 292bf26f8e4d4fbf910639b9f86d2366a72c3ca0..f4c1ef472880bdb1ba2a96d4130bbb70f58b50e4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Introduction
 
 # Introduction
 

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

 
 Jirafeau is a web site permitting to upload a file in a simple way and give an unique link to it.
 
 
 Jirafeau is a web site permitting to upload a file in a simple way and give an unique link to it.
 


@@ -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:
+-  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


@@ -31,7 +31,7 @@ Jirafeau is a fork of the original project [Jyraphe](http://home.gna.org/jyraphe
 
 As it's original project, Jirafeau is made in the [KISS](http://en.wikipedia.org/wiki/KISS_principle) way (Keep It Simple, Stupid).
 
 
 As it's original project, Jirafeau is made in the [KISS](http://en.wikipedia.org/wiki/KISS_principle) way (Keep It Simple, Stupid).
 

-Jirafeau project won't evolve to a file manager and will focus to keep a very few dependencies
+Jirafeau project won't evolve to a file manager and will focus to keep a very few dependencies.

 
 # Screenshots
 
 
 # Screenshots
 


@@ -46,12 +46,16 @@ Here are some screenshots:
 - [Upload 4](http://i.imgur.com/P2oS1MY.jpg)
 
 # Installation
 - [Upload 4](http://i.imgur.com/P2oS1MY.jpg)
 
 # Installation

--  [Download](https://gitlab.com/mojo42/Jirafeau/repository/archive.zip) the last version of Jirafeau from Gitlab
+-  [Download](https://gitlab.com/mojo42/Jirafeau/repository/archive.zip) the last version of Jirafeau from GitLab

 -  Upload files on your web server
 -  Don't forget to set owner of uploaded files if you need to
 -  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```
 
 -  Upload files on your web server
 -  Don't forget to set owner of uploaded files if you need to
 -  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,8 +69,7 @@ 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.
+An other obvious basic security is to let access users to the site by HTTPS.

 
 # Few notes about server side encryption
 
 
 # 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.
 


@@ -90,9 +93,11 @@ In a next step, encryption will be made by the client (in javascript), see issue
 
 Of-course ! Translations are easy to make and no technical knowledge is required.
 
 
 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/projects/jirafeau/master/).
+
+If you want to add a new language in the list, feel free to contact us or leave a comment in ticket #9.

 
 

-If you want to add a new language in the list, feel free to contact us or leave a comment in #9
+We would like to thanks to anonymous contributors on weblate. :)

 
 ### How do I upgrade my Jirafeau ?
 
 
 ### How do I upgrade my Jirafeau ?
 


@@ -106,13 +111,13 @@ If you have some troubles:
 - It should probably come from your ```lib/config.local.php``` (configuration syntax may have changed). Just compare it with ```lib/config.original.php```
 - Check owner/permissions of your files.
 
 - It should probably come from your ```lib/config.local.php``` (configuration syntax may have changed). Just compare it with ```lib/config.original.php```
 - Check owner/permissions of your files.
 

-Anyway you should off-course make a backup of your current installation before doing anything :)
+Anyway you should off-course make a backup of your current installation before doing anything. :)

 
 ### How can I limit upload access ?
 
 There are two ways to limit upload access (but not download):
 - you can set one or more passwords in order to access the upload interface, or/and
 
 ### How can I limit upload access ?
 
 There are two ways to limit upload access (but not download):
 - you can set one or more passwords in order to access the upload interface, or/and

-- you can configure a list of authorized IP ([CIDR notation](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)) which are allowed to access to the upload page
+- you can configure a list of authorized IP ([CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)) which are allowed to access to the upload page

 
 Check documentation of ```upload_password``` and ```upload_ip``` parameters in [lib/config.original.php](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/config.original.php).
 
 
 Check documentation of ```upload_password``` and ```upload_ip``` parameters in [lib/config.original.php](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/config.original.php).
 


@@ -120,29 +125,29 @@ Check documentation of ```upload_password``` and ```upload_ip``` parameters in [
 
 If you have some strange behavior with IE, you may configure [compatibility mode](http://feedback.dominknow.com/knowledgebase/articles/159097-internet-explorer-ie8-ie9-ie10-and-ie11-compat).
 
 
 If you have some strange behavior with IE, you may configure [compatibility mode](http://feedback.dominknow.com/knowledgebase/articles/159097-internet-explorer-ie8-ie9-ie10-and-ie11-compat).
 

-Anyway I would recommand you to use another browser :)
+Anyway I would recommand you to use another web browser. :)

 
 ### I found a bug, what should I do ?
 
 
 ### I found a bug, what should I do ?
 

-Feel free to open a bug in the [gitlab's issues](https://gitlab.com/mojo42/Jirafeau/issues)
+Feel free to open a bug in the [GitLab's issues](https://gitlab.com/mojo42/Jirafeau/issues).

 
 ### How to set maximum file size ?
 
 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.
 
 ### How to set maximum file size ?
 
 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](http://php.net/manual/en/ini.core.php#ini.post-max-size) and [upload_max_filesize](http://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.

 
 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)
 
 ### How can I edit an option ?
 
 
 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)
 
 ### How can I edit an option ?
 

-Documentation of all default options are located in [lib/config.original.php](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/config.original.php)
-If you want to change an option, just edit your ```lib/config.local.php```
+Documentation of all default options are located in [lib/config.original.php](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/config.original.php).
+If you want to change an option, just edit your ```lib/config.local.php```.

 
 ### How can I access the admin interface ?
 
 
 ### How can I access the admin interface ?
 

-Just go to ```/admin.php```
+Just go to ```/admin.php```.

 
 ### How can I use the scripting interface ?
 
 
 ### How can I use the scripting interface ?
 


@@ -158,11 +163,11 @@ The original project seems not to be continued anymore and I prefer to add more
 
 ### What can we expect in the future ?
 
 
 ### What can we expect in the future ?
 

-Check [issues](https://gitlab.com/mojo42/Jirafeau/issues) to check open bugs and incoming new stuff :)
+Check [issues](https://gitlab.com/mojo42/Jirafeau/issues) to check open bugs and incoming new stuff. :)

 
 ### What is the Jirafeau's license ?
 
 
 ### What is the Jirafeau's license ?
 

-Jirafeau is licensed under [AGPLv3](https://gitlab.com/mojo42/Jirafeau/blob/master/COPYING)
+Jirafeau is licensed under [AGPLv3](https://gitlab.com/mojo42/Jirafeau/blob/master/COPYING).

 
 ### How do I modify the TOS (terms of use) ?
 
 
 ### How do I modify the TOS (terms of use) ?
 


@@ -187,4 +192,4 @@ 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
\ No newline at end of file
+Feel free to create an issue if you found a bug.
\ No newline at end of file