README.md

   1 # Introduction
   2
   3 Welcome to the official Jirafeau project, an [Open-Source software](http://en.wikipedia.org/wiki/Open-source_software).
   4
   5 Jirafeau is a web site permitting to upload a file in a simple way and give an unique link to it.
   6
   7 A demonstration of the latest version is available on [jirafeau.net](http://jirafeau.net/)
   8
   9 ![Screenshot1](http://i.imgur.com/TPjh48P.png)
  10
  11 **Main features**:
  12 -  One upload => One download link & One delete linkp
  13 -  Send any large files (thanks to HTML5)
  14 -  NO database, only use basic PHP
  15 -  Shows progression: speed, percentage and remaining upload time
  16 -  Preview content in browser (if possible)
  17 -  Optional Password protection (for uploading or downloading)
  18 -  Time limitation
  19 -  Option to self-destruct after reading
  20 -  Simple language support :gb: :fr: :de: :it:
  21 -  Small administration interface
  22 -  File level [Deduplication](http://en.wikipedia.org/wiki/Data_deduplication) for storage optimization
  23 -  A basic Terms Of Service which can be adapted to your needs
  24 -  Shortened URLs using base 64 encoding
  25 -  API interface
  26 -  Optional data encryption
  27 -  Skins
  28 ...
  29
  30 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.
  31
  32 As it's original project, Jirafeau is made in the [KISS](http://en.wikipedia.org/wiki/KISS_principle) way (Keep It Simple, Stupid).
  33
  34 Jirafeau project won't evolve to a file manager and will focus to keep a very few dependencies
  35
  36 # Screenshots
  37
  38 Here are some screenshots:
  39 - [Installation part 1](http://i.imgur.com/hmpT1eN.jpg)
  40 - [Installation part 2](http://i.imgur.com/2e0UGKE.jpg)
  41 - [Installation part 3](http://i.imgur.com/ofAjLXh.jpg)
  42 - [Installation part 4](http://i.imgur.com/WXqnfqJ.jpg)
  43 - [Upload 1](http://i.imgur.com/SBmSwzJ.jpg)
  44 - [Upload 2](http://i.imgur.com/wzPkb1Z.jpg)
  45 - [Upload 3](http://i.imgur.com/i6n95kv.jpg)
  46 - [Upload 4](http://i.imgur.com/P2oS1MY.jpg)
  47
  48 # Installation
  49 -  [Download](https://gitlab.com/mojo42/Jirafeau/repository/archive.zip) the last version of Jirafeau from Gitlab
  50 -  Upload files on your web server
  51 -  Don't forget to set owner of uploaded files if you need to
  52 -  Get your web browser and go to you install location (e.g. ```http://your-web-site.org/jirafeau/```) and follow instructions
  53 -  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```
  54
  55 # Security
  56
  57 ```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.
  58 You have several options:
  59 - Configure a ```.htaccess```
  60 - Move var folder to a place on your server which can't be directly accessed
  61 - Disable automatic listing on your web server config or place a index.html in var's sub-directory (this is a limited solution)
  62
  63 If you are using Apache, you can add the following lineto your configuration to prevent people to access to your ```var``` folder:
  64
  65 ```RedirectMatch 301 ^/var-.* http://my.service.jirafeau ```
  66
  67 You should also remove un-necessessary write access once the installation is done (ex: configuration file).
  68
  69 An other obvious basic security is to let access users to the site by https.
  70
  71 # Few notes about server side encryption
  72
  73 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).
  74 The decrypt key is not stored on the server so if you loose an url, you won't be able to retrieve file content.
  75 In case of security troubles on the server, attacker won't be able to access files.
  76
  77 By activating this feature, you have to be aware of few things:
  78 -  Data encryption has a cost (cpu) and it takes more time for downloads to complete once file sent.
  79 -  During the download, the server will decrypt on the fly (and use resource).
  80 -  This feature needs to have the mcrypt php module.
  81 -  File de-duplication will stop to work (as we can't compare two encrypted files).
  82 -  Be sure you server do not log client's requests.
  83 -  Don't forget to activate https.
  84
  85 In a next step, encryption will be made by the client (in javascript), see issue #10.
  86
  87 # FAQ
  88
  89 ### Can I add a new language in Jirafeau ?
  90
  91 Of-course ! Translations are easy to make and no technical knowledge is required.
  92
  93 Simply go to [Jirafeau's Weblate](https://hosted.weblate.org/projects/jirafeau/master/)
  94
  95 If you want to add a new language in the list, feel free to contact us or leave a comment in #9
  96
  97 ### How do I upgrade my Jirafeau ?
  98
  99 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.
 100
 101 If you have installed Jirafeau just by uploading files on your server, you can take the [last version](https://gitlab.com/mojo42/Jirafeau/repository/archive.zip), overwrite files and chown/chmod files if needed.
 102
 103 After upgrading, you can compare your ```lib/config.local.php``` and ```lib/config.original.php``` to see if new configuration items are available.
 104
 105 If you have some troubles:
 106 - It should probably come from your ```lib/config.local.php``` (configuration syntax may have changed). Just compare it with ```lib/config.original.php```
 107 - Check owner/permissions of your files.
 108
 109 Anyway you should off-course make a backup of your current installation before doing anything :)
 110
 111 ### How can I limit upload access ?
 112
 113 There are two ways to limit upload access (but not download):
 114 - you can set one or more passwords in order to access the upload interface, or/and
 115 - 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
 116
 117 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).
 118
 119 ### I found a bug, what should I do ?
 120
 121 Feel free to open a bug in the [gitlab's issues](https://gitlab.com/mojo42/Jirafeau/issues)
 122
 123 ### How to set maximum file size ?
 124
 125 If your browser supports HTML5 file API, you can send files as big as you want.
 126
 127 For browsers who does not support HTML5 file API, the limitation come from PHP configuration.
 128 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.
 129
 130 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)
 131
 132 ### How can I edit an option ?
 133
 134 Documentation of all default options are located in [lib/config.original.php](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/config.original.php)
 135 If you want to change an option, just edit your ```lib/config.local.php```
 136
 137 ### How can I access the admin interface ?
 138
 139 Just go to ```/admin.php```
 140
 141 ### How can I use the scripting interface ?
 142
 143 Simply go to ```/script.php``` with your web browser.
 144
 145 ### My downloads are incomplete or my uploads fails
 146
 147 Be sure your PHP installation is not using safe mode, it may cause timeouts.
 148
 149 ### Why forking ?
 150
 151 The original project seems not to be continued anymore and I prefer to add more features and increase security from a stable version.
 152
 153 ### What can we expect in the future ?
 154
 155 Check [issues](https://gitlab.com/mojo42/Jirafeau/issues) to check open bugs and incoming new stuff :)
 156
 157 ### What is the Jirafeau's license ?
 158
 159 Jirafeau is licensed under [AGPLv3](https://gitlab.com/mojo42/Jirafeau/blob/master/COPYING)
 160
 161 ### How do I modify the TOS (terms of use) ?
 162
 163 Just edit ```tos.php``` and configure ```$org``` and ```$contact``` variables.
 164
 165 ### What about this file deduplication thing ?
 166
 167 Jirafeau use a very simple file level deduplication for storage optimization.
 168
 169 This mean that if some people upload several times the same file, this will only store one time the file and increment a counter.
 170
 171 If someone use his delete link or an admin cleans expired links, this will decrement the counter corresponding to the file.
 172
 173 If the counter falls to zero, the file is destroyed.
 174
 175 ### What is the difference between "delete link" and "delete file and links" in admin interface ?
 176
 177 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.
 178 So:
 179 - The button "delete link" will delete the reference to the file but might not destroy the file.
 180 - The button "delete file and links" will delete all references pointing to the file and will destroy the file.
 181
 182 ### How to contact someone from Jirafeau ?
 183
 184 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
 185