]> git.p6c8.net - jirafeau_project.git/blob - README.md
add Greek language
[jirafeau_project.git] / README.md
1 # Introduction
2
3 Welcome to the official Jirafeau project, an [Open-Source software](https://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: :nl: :ro: :sk: :hu: :cn:
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 Note that ```lib/config.local.php``` is auto-generated during the installation.
56
57 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.
58
59 # Security
60
61 ```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.
62 You have several options:
63 - Configure a ```.htaccess```
64 - Move var folder to a place on your server which can't be directly accessed
65 - Disable automatic listing on your web server config or place a index.html in var's sub-directory (this is a limited solution)
66
67 If you are using Apache, you can add the following line to your configuration to prevent people to access to your ```var``` folder:
68
69 ```RedirectMatch 301 ^/var-.* http://my.service.jirafeau ```
70
71 If you are using nginx, you can add the following to your $vhost.conf:
72
73 ```nginx
74 location ~ /var-.* {
75 deny all;
76 return 404;
77 }
78 ```
79
80 You should also remove un-necessessary write access once the installation is done (ex: configuration file).
81 An other obvious basic security is to let access users to the site by HTTPS.
82
83 # Few notes about server side encryption
84
85 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).
86 The decrypt key is not stored on the server so if you loose an url, you won't be able to retrieve file content.
87 In case of security troubles on the server, attacker won't be able to access files.
88
89 By activating this feature, you have to be aware of few things:
90 - Data encryption has a cost (cpu) and it takes more time for downloads to complete once file sent.
91 - During the download, the server will decrypt on the fly (and use resource).
92 - This feature needs to have the mcrypt php module.
93 - File de-duplication will stop to work (as we can't compare two encrypted files).
94 - Be sure your server do not log client's requests.
95 - Don't forget to enable https.
96
97 In a next step, encryption will be made by the client (in javascript), see issue #10.
98
99 # FAQ
100
101 ### Can I add a new language in Jirafeau?
102
103 Of course ! Translations are easy to make and no technical knowledge is required.
104
105 Simply go to [Jirafeau's Weblate](https://hosted.weblate.org/projects/jirafeau/master/).
106
107 If you want to add a new language in the list, feel free to contact us or leave a comment in ticket #9.
108
109 We would like to thank all anonymous contributors on weblate. :)
110
111 ### How do I upgrade my Jirafeau?
112
113 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.
114
115 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.
116
117 After upgrading, you can compare your ```lib/config.local.php``` and ```lib/config.original.php``` to see if new configuration items are available.
118
119 If you have some troubles:
120 - It should probably come from your ```lib/config.local.php``` (configuration syntax may have changed). Just compare it with ```lib/config.original.php```
121 - Check owner/permissions of your files.
122
123 Anyway you should off-course make a backup of your current installation before doing anything. :)
124
125 ### How can I limit upload access?
126
127 There are two ways to limit upload access (but not download):
128 - you can set one or more passwords in order to access the upload interface, or/and
129 - 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
130
131 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).
132
133 ### How can I automatize the cleaning of old (expired) files?
134
135 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```.
136
137 Then the command can be placed in a cron file to automatize the process. For example:
138 ```
139 # m h dom mon dow user command
140 12 3 * * * www-data php /path/to/jirafeau/admin.php clean_expired
141 16 3 * * * www-data php /path/to/jirafeau/admin.php clean_async
142 ```
143
144 ### I have some troubles with IE
145
146 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).
147
148 Anyway I would recommend you to use another web browser. :)
149
150 ### I found a bug, what should I do?
151
152 Feel free to open a bug in the [GitLab's issues](https://gitlab.com/mojo42/Jirafeau/issues).
153
154 ### How to set maximum file size?
155
156 If your browser supports HTML5 file API, you can send files as big as you want.
157
158 For browsers who does not support HTML5 file API, the limitation come from PHP configuration.
159 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.
160
161 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)
162
163 ### How can I edit an option?
164
165 Documentation of all default options are located in [lib/config.original.php](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/config.original.php).
166 If you want to change an option, just edit your ```lib/config.local.php```.
167
168 ### How can I access the admin interface?
169
170 Just go to ```/admin.php```.
171
172 ### How can I use the scripting interface (API)?
173
174 Simply go to ```/script.php``` with your web browser.
175
176 ### My downloads are incomplete or my uploads fails
177
178 Be sure your PHP installation is not using safe mode, it may cause timeouts.
179
180 If you're using nginx, you might need to increase `client_max_body_size` or remove the restriction altogether. In your nginx.conf:
181
182 ```nginx
183 http {
184 # disable max upload size
185 client_max_body_size 0;
186 # add timeouts for very large uploads
187 client_header_timeout 30m;
188 client_body_timeout 30m;
189 }
190 ```
191
192 ### How can I monitor the use of my Jirafeau instance?
193
194 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).
195
196 ### Why forking?
197
198 The original project seems not to be continued anymore and I prefer to add more features and increase security from a stable version.
199
200 ### What can we expect in the future?
201
202 Check [issues](https://gitlab.com/mojo42/Jirafeau/issues) to check open bugs and incoming new stuff. :)
203
204 ### What is the Jirafeau's license?
205
206 Jirafeau is licensed under [AGPLv3](https://gitlab.com/mojo42/Jirafeau/blob/master/COPYING).
207
208 ### How do I modify the TOS (terms of use)?
209
210 Just edit ```tos.php``` and configure ```$org``` and ```$contact``` variables.
211
212 ### What about this file deduplication thing?
213
214 Jirafeau uses a very simple file level deduplication for storage optimization.
215
216 This mean that if some people upload several times the same file, this will only store one time the file and increment a counter.
217
218 If someone use his/her delete link or an admin cleans expired links, this will decrement the counter corresponding to the file.
219
220 When the counter falls to zero, the file is destroyed.
221
222 ### What is the difference between "delete link" and "delete file and links" in admin interface?
223
224 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.
225 So:
226 - The button "delete link" will delete the reference to the file but might not destroy the file.
227 - The button "delete file and links" will delete all references pointing to the file and will destroy the file.
228
229 ### How to contact someone from Jirafeau?
230
231 Feel free to create an issue if you found a bug.
232
233 # Release notes
234
235 ## Version 1.0
236
237 The very first version of Jirafeau after the fork of Jyraphe.
238
239 - Security fix
240 - Keep uploader's ip
241 - Delete link for each upload
242 - No more clear text password storage
243 - Simple langage support
244 - Add an admin interface
245 - New Design
246 - Add term of use
247 - New path system to manage large number of files
248 - New option to show a page at download time
249 - Add option to activate or not preview mode
250
251 ## Version 1.1
252
253 - New skins
254 - Add optional server side encryption
255 - Unlimited file size upload using HTML5 file API
256 - Show speed and estimated time during upload
257 - A lot of fixes
258 - A lot of new langages
259 - Small API to upload files
260 - Limit access to Jirafeau using IP, mask, passwords
261 - Manage (some) proxy headers
262 - Configure your maximal upload size
263 - Configure file's lifetime durations
264 - Preview URL
265 - Get Jirafeau's version in admin interface
266
267 ### Update from 1.0 to 1.1
268
269 1. Backup you Jirafeau installation
270 2. Block access to Jirafeau
271 3. Checkout new version using git tag 1.1
272 4. With you browser, go to your Jirafeau root page
273 5. Follow installation wizard, it should propose you the same data folder
274 6. Add a rewrite rule in your web server configuration to rename file.php to f.php to make old url work again
275 7. Go in you lib/config.local.php and lib/config.original.php to check new options and eventually change skin to 'courgette'

patrick-canterino.de