Jirafeau version 2.0.0

[jirafeau_mojo42.git] / README.md

diff --git a/README.md b/README.md
index b2fbe334cb8123361dab4b778d16fa7226821b5f..9a09bd3ea9832c886ad8d16e48fa3c13eb089bdc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,31 +1,34 @@
-# Introduction
+# Jirafeau

 
 Welcome to the official Jirafeau project, an [Open-Source software](https://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 project permitting a "one-click-filesharing", which makes it possible to upload a file in a simple way and give an unique link to it.

 
 

-A demonstration of the latest version is available on [jirafeau.net](http://jirafeau.net/)
+A demonstration of the latest version is available on [jirafeau.net](http://jirafeau.net/).

 
 ![Screenshot1](http://i.imgur.com/TPjh48P.png)
 
 
 ![Screenshot1](http://i.imgur.com/TPjh48P.png)
 

-**Main features**:
--  One upload => One download link & One delete linkp
--  Send any large files (thanks to HTML5)
--  NO database, only use basic PHP
--  Shows progression: speed, percentage and remaining upload time
--  Preview content in browser (if possible)
--  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: :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
--  Shortened URLs using base 64 encoding
--  API interface
--  Optional data encryption
--  Skins
-...
+## Main features
+
+- One upload → One download link & one delete link
+- Send any large files (thanks to the HTML5 file API → PHP post_max_size limit not relevant)
+- Shows progression: speed, percentage and remaining upload time
+- Preview content in browser (if possible)
+- Optional password protection (for uploading or downloading)
+- Set expiration time for downloads
+- Option to self-destruct after first download
+- 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:
+- 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
+- CLI script to remove expired files automatically with a cronjob
+- Basic, adaptable »Terms Of Service« page
+- Basic API
+- Bash script to upload files via command line
+- Skins

 
 Jirafeau is a fork of the original project [Jyraphe](http://home.gna.org/jyraphe/) based on the 0.5 (stable version) with a **lot** of modifications.
 
 
 Jirafeau is a fork of the original project [Jyraphe](http://home.gna.org/jyraphe/) based on the 0.5 (stable version) with a **lot** of modifications.
 


@@ -33,19 +36,20 @@ As it's original project, Jirafeau is made in the [KISS](http://en.wikipedia.org
 
 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

 
 

-Here are some screenshots:
-- [Installation part 1](http://i.imgur.com/hmpT1eN.jpg)
-- [Installation part 2](http://i.imgur.com/2e0UGKE.jpg)
-- [Installation part 3](http://i.imgur.com/ofAjLXh.jpg)
-- [Installation part 4](http://i.imgur.com/WXqnfqJ.jpg)
-- [Upload 1](http://i.imgur.com/SBmSwzJ.jpg)
-- [Upload 2](http://i.imgur.com/wzPkb1Z.jpg)
-- [Upload 3](http://i.imgur.com/i6n95kv.jpg)
-- [Upload 4](http://i.imgur.com/P2oS1MY.jpg)
+- [Installation - Step 1](http://i.imgur.com/hmpT1eN.jpg)
+- [Installation - Step 2](http://i.imgur.com/2e0UGKE.jpg)
+- [Installation - Step 3](http://i.imgur.com/ofAjLXh.jpg)
+- [Installation - Step 4](http://i.imgur.com/WXqnfqJ.jpg)
+- [Upload - Step 1](http://i.imgur.com/SBmSwzJ.jpg)
+- [Upload - Step 2](http://i.imgur.com/wzPkb1Z.jpg)
+- [Upload - Progress](http://i.imgur.com/i6n95kv.jpg)
+- [Upload - Confirmation page](http://i.imgur.com/P2oS1MY.jpg)
+- [Admin Interface](http://i.imgur.com/nTdsVzn.png)
+
+## Installation

 
 

-# Installation

 -  [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
 -  [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


@@ -56,7 +60,31 @@ 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.
 
 
 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
+## Update
+
+### General
+
+1. Backup you Jirafeau installation
+2. Block access to Jirafeau
+3. Checkout new version using the [tagged release](https://gitlab.com/mojo42/Jirafeau/tags)
+4. With you browser, go to your Jirafeau root page
+5. Follow installation wizard, it should propose you the same data folder
+7. Go in you lib/config.local.php and lib/config.original.php to check new options
+
+### From version 1.0 to 1.1
+
+1. Add a rewrite rule in your web server configuration to rename file.php to f.php to make old url work again
+2. Eventually change skin in »lib/config.local.php« to 'courgette'
+
+### From version 1.1 to 1.2.0
+
+Nothing particular
+
+### from version 1.2.0 to 2.0.0.
+
+1. ToS text file changed → move file from "/tos_text.php" to "/lib/tos.local.txt" and remove all HTML and PHP Tags, leaving a regular text file
+
+## 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.
 You have several options:
 
 ```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.
 You have several options:


@@ -64,14 +92,23 @@ You have several options:
 - Move var folder to a place on your server which can't be directly accessed
 - Disable automatic listing on your web server config or place a index.html in var's sub-directory (this is a limited solution)
 
 - Move var folder to a place on your server which can't be directly accessed
 - Disable automatic listing on your web server config or place a index.html in var's sub-directory (this is a limited solution)
 

-If you are using Apache, you can add the following lineto your configuration to prevent people to access to your ```var``` folder:
+If you are using Apache, you can add the following line to your configuration to prevent people to access to your ```var``` folder:

 
 ```RedirectMatch 301 ^/var-.* http://my.service.jirafeau ```
 
 
 ```RedirectMatch 301 ^/var-.* http://my.service.jirafeau ```
 

+If you are using nginx, you can add the following to your $vhost.conf:
+
+```nginx
+location ~ /var-.* {
+    deny all;
+    return 404;
+}
+```
+

 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.
 
 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
+## Server side encryption

 
 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.


@@ -82,24 +119,47 @@ 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.
 

-# FAQ
+## License
+
+GNU Affero General Public License version 3 (AGPLv3).
+
+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, 
+you are required to provide a link to the source code of your version in order to obey the AGPLv3 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:

 
 

-### Can I add a new language in Jirafeau ?
+- https://gitlab.com/mojo42/Jirafeau

 
 

-Of-course ! Translations are easy to make and no technical knowledge is required.
+and the Contribution Guidelines
+
+- https://gitlab.com/mojo42/Jirafeau/blob/master/CONTRIBUTING.md
+
+## FAQ
+
+### Can I add a new language in Jirafeau?
+
+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/).
 
 If you want to add a new language in the list, feel free to contact us or leave a comment in ticket #9.
 
 
 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.
 

-We would like to thanks to anonymous contributors on weblate. :)
+We would like to thank all anonymous contributors on weblate. :)

 
 

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

 
 If you have installed Jirafeau using git, it's pretty simple: just make a git pull and chown/chmod files who have the owner changed.
 
 
 If you have installed Jirafeau using git, it's pretty simple: just make a git pull and chown/chmod files who have the owner changed.
 


@@ -113,7 +173,7 @@ If you have some troubles:
 
 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 ?
+### 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
 
 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


@@ -121,17 +181,28 @@ There are two ways to limit upload access (but not download):
 
 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).
 

+### How can I automatize the cleaning of old (expired) files?
+
+You can call the admin.php script from the command line (CLI) with the ```clean_expired``` or ```clean_async``` commands: ```sudo -u www-data php admin.php clean_expired```.
+
+Then the command can be placed in a cron file to automatize the process. For example:
+```
+# m h dom mon dow user  command
+12 3    * * *   www-data  php /path/to/jirafeau/admin.php clean_expired
+16 3    * * *   www-data  php /path/to/jirafeau/admin.php clean_async
+```
+

 ### I have some troubles with IE
 
 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).
 
 ### I have some troubles with IE
 
 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 web browser. :)
+Anyway I would recommend 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 ?
+### How to set maximum file size?

 
 If your browser supports HTML5 file API, you can send files as big as you want.
 
 
 If your browser supports HTML5 file API, you can send files as big as you want.
 


@@ -140,16 +211,24 @@ You have to set [post_max_size](https://php.net/manual/en/ini.core.php#ini.post-
 
 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)
 

-### How can I edit an option ?
+### 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 change the Terms of Service?
+
+The license text on the "Terms of Service" page, which is shipped with the default installation, is based on the »[Open Source Initiative Terms of Service](https://opensource.org/ToS)«.
+
+To change this text simply copy the file [/lib/tos.original.txt](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/tos.original.txt), rename it to ```/lib/tos.local.txt``` and adapt it to your own needs.
+
+If you update the installation, then only the ```tos.original.txt``` file may change eventually, not your ```tos.local.txt``` file.
+
+### 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 (API)?

 
 Simply go to ```/script.php``` with your web browser.
 
 
 Simply go to ```/script.php``` with your web browser.
 


@@ -157,39 +236,102 @@ Simply go to ```/script.php``` with your web browser.
 
 Be sure your PHP installation is not using safe mode, it may cause timeouts.
 
 
 Be sure your PHP installation is not using safe mode, it may cause timeouts.
 

-### Why forking ?
+If you're using nginx, you might need to increase `client_max_body_size` or remove the restriction altogether. In your nginx.conf:

 
 

-The original project seems not to be continued anymore and I prefer to add more features and increase security from a stable version.
+```nginx
+http {
+    # disable max upload size
+    client_max_body_size 0;
+    # add timeouts for very large uploads
+    client_header_timeout 30m;
+    client_body_timeout 30m;
+}
+```

 
 

-### What can we expect in the future ?
+### How can I monitor the use of my Jirafeau instance?

 
 

-Check [issues](https://gitlab.com/mojo42/Jirafeau/issues) to check open bugs and incoming new stuff. :)
+You may use Munin and simple scripts to collect the number of files in the Jirafeau instance as well as the disk space occupied by all the files. You can consult this [web page](https://blog.bandinelli.net/index.php?post/2016/05/15/Scripts-Munin-pour-Jirafeau).

 
 

-### What is the Jirafeau's license ?
+### Why forking?

 
 

-Jirafeau is licensed under [AGPLv3](https://gitlab.com/mojo42/Jirafeau/blob/master/COPYING).
+The original project seems not to be continued anymore and I prefer to add more features and increase security from a stable version.

 
 

-### How do I modify the TOS (terms of use) ?
+### What can we expect in the future?

 
 

-Just edit ```tos.php``` and configure ```$org``` and ```$contact``` variables.
+Check [issues](https://gitlab.com/mojo42/Jirafeau/issues) to check open bugs and incoming new stuff. :)

 
 

-### What about this file deduplication thing ?
+### What about this file deduplication thing?

 
 

-Jirafeau use a very simple file level deduplication for storage optimization.
+Jirafeau uses a very simple file level deduplication for storage optimization.

 
 This mean that if some people upload several times the same file, this will only store one time the file and increment a counter.
 
 
 This mean that if some people upload several times the same file, this will only store one time the file and increment a counter.
 

-If someone use his delete link or an admin cleans expired links, this will decrement the counter corresponding to the file.
+If someone use his/her delete link or an admin cleans expired links, this will decrement the counter corresponding to the file.

 
 

-If the counter falls to zero, the file is destroyed.
+When the counter falls to zero, the file is destroyed.

 
 

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

-### 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
+### How to contact someone from Jirafeau?
+
+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 Jyraphe.
+
+- 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
+
+## Version 1.2.0
+
+- Change versioning semantic
+- A lof of translation contributions
+- Fix javascript MIME type
+- Show download in admin panel
+- Default expiration date set to 'month'
+- New expiration date: 'quarter'
+- Small other fixes
+
+## Version 2.0.0
+
+- ToS refactoring (see update notes !)
+- You can now set a title to Jirafeau in options
+- A lot of documentation improvements
+- Code refactoring & bugfixes
+- Add version to bash script
+- A lot of documentation improvements
+- Code refactoring & bug fixes
+-