]> git.p6c8.net - jirafeau_mojo42.git/blob - README.md
Translated using Weblate (Belarusian)
[jirafeau_mojo42.git] / README.md
1 # Jirafeau
2
3 Welcome to the official Jirafeau project, an [Open-Source software](https://en.wikipedia.org/wiki/Open-source_software).
4
5 Jirafeau allows your to "one-click-filesharing". It makes possible 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](https://jirafeau.net/).
8
9 ![Screenshot1](http://i.imgur.com/TPjh48P.png)
10
11 Latest CI Status:
12 Master [![Build Status Master](https://gitlab.com/mojo42/Jirafeau/badges/master/build.svg)](https://gitlab.com/mojo42/Jirafeau/commits/master)
13 Next Release [![Build Status Next Release](https://gitlab.com/mojo42/Jirafeau/badges/test/build.svg)](https://gitlab.com/mojo42/Jirafeau/commits/master)
14 [All Branch Builds](https://gitlab.com/mojo42/Jirafeau/pipelines?scope=branches)
15
16 ## Main features
17
18 - One upload → One download link & one delete link
19 - Send any large files (thanks to the HTML5 file API → PHP post_max_size limit not relevant)
20 - Shows progression: speed, percentage and remaining upload time
21 - Preview content in browser (if possible)
22 - Optional password protection (for uploading or downloading)
23 - Set expiration time for downloads
24 - Option to self-destruct after first download
25 - Shortened URLs using base 64 encoding
26 - Maximal upload size configurable
27 - NO database, only use basic PHP
28 - Simple language support :gb: :fr: :de: :it: :nl: :ro: :sk: :hu: :cn: :gr: :ru: :es: :tk: :flag_tr: :flag_pt: :flag_br:
29 - File level [Deduplication](http://en.wikipedia.org/wiki/Data_deduplication) for storage optimization (does store duplicate files only once, but generate multiple links)
30 - Optional data encryption
31 - Small administration interface
32 - CLI script to remove expired files automatically with a cronjob
33 - Basic, adaptable »Terms Of Service« page
34 - Basic API
35 - Bash script to upload files via command line
36 - Themes
37
38 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.
39
40 As it's original project, Jirafeau is made in the [KISS](http://en.wikipedia.org/wiki/KISS_principle) way (Keep It Simple, Stupid).
41
42 Jirafeau project won't evolve to a file manager and will focus to keep a very few dependencies.
43
44 ## Screenshots
45
46 - [Installation - Step 1](http://i.imgur.com/hmpT1eN.jpg)
47 - [Installation - Step 2](http://i.imgur.com/2e0UGKE.jpg)
48 - [Installation - Step 3](http://i.imgur.com/ofAjLXh.jpg)
49 - [Installation - Step 4](http://i.imgur.com/WXqnfqJ.jpg)
50 - [Upload - Step 1](http://i.imgur.com/SBmSwzJ.jpg)
51 - [Upload - Step 2](http://i.imgur.com/wzPkb1Z.jpg)
52 - [Upload - Progress](http://i.imgur.com/i6n95kv.jpg)
53 - [Upload - Confirmation page](http://i.imgur.com/P2oS1MY.jpg)
54 - [Admin Interface](http://i.imgur.com/nTdsVzn.png)
55
56 ## Installation
57
58 This shows how to install Jirafeau by your own, it's quite simple but you can
59 also use a [docker image](https://hub.docker.com/r/mojo42/jirafeau/) or build
60 it yourself. Check [docker folder](docker/README.md) for more informations.
61
62 System requirements:
63 - PHP >= 5.6
64 - Optional, but recommended: Git >= 2.7
65 - No database required, no mail required
66
67 Installation steps:
68 - Clone the [repository](https://gitlab.com/mojo42/Jirafeau/) or download the latest ([release](https://gitlab.com/mojo42/Jirafeau/tags) from GitLab onto your webserver
69 - Set owner & group according to your webserver
70 - A) Setup with the installation wizard (web):
71 - Open your browser and go to your installed location, eg. ```https://example.com/jirafeau/```
72 - The script will redirect to you to a minimal installation wizard to set up all required options
73 - All optional parameters may be set in ```lib/config.local.php```, take a look at ```lib/config.original.php``` to see all default values
74 - B) Setup without the installation wizard (cli):
75 - Just copy ```config.original.php``` to ```config.local.php``` and customize it
76
77 ## Upgrade
78
79 ### General procedure for all versions
80
81 1. Backup your Jirafeau installation!
82 2. Block access to Jirafeau
83 3. Checkout the new version with Git using the [tagged release](https://gitlab.com/mojo42/Jirafeau/tags)
84 * If you have installed Jirafeau just by uploading files on your server, you can download the desired version, overwrite/remove all files and chown/chmod files if needed. Keep a backup of your local configuration file tough.
85 4. With you browser, go to your Jirafeau root page
86 5. Follow the installation wizard, it should propose you the same data folder or even update automatically
87 7. Check your ```/lib/config.local.php``` and compare it with the ```/lib/config.original.php``` to see if new configuration items are available
88
89 ### From version 1.0 to 1.1
90
91 1. The download URL changed
92 * Add a rewrite rule in your web server configuration to rename ```file.php``` to ```f.php``` to make older, still existing links work again
93 1. The default theme changed
94 * Optionally change the theme in ```lib/config.local.php``` to »courgette«
95
96 ### From version 1.2.0 to 2.0.0
97
98 1. The "Terms of Service" text file changed
99 * To reuse previous changes to the ToS, move the old ```/tos_text.php``` file to ```/lib/tos.local.txt``` and remove all HTML und PHP Tags, leaving a regular text file
100
101 ### from version 2.0.0 to 3.3.0
102
103 There is nothing special to do to update from/to the following versions:
104 - 2.0.0 -> 3.0.0
105 - 3.0.0 -> 3.1.0
106 - 3.1.0 -> 3.2.0
107 - 3.2.0 -> 3.2.1
108 - 3.2.1 -> 3.3.0
109
110 ### Troubleshooting
111
112 If you have some troubles, consider the following cases
113
114 - Check your ```/lib/config.local.php``` file and compare it with ```/lib/config.original.php```, the configuration syntax or a parameter may have changed
115 - Check owner & permissions of your files
116
117 ## Security
118
119 ```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.
120 You have several options:
121 - Configure a ```.htaccess```
122 - Move var folder to a place on your server which can't be directly accessed
123 - Disable automatic listing on your web server config or place a index.html in var's sub-directory (this is a limited solution)
124
125 If you are using Apache, you can add the following line to your configuration to prevent people to access to your ```var``` folder:
126
127 ```RedirectMatch 301 ^/var-.* http://my.service.jirafeau ```
128
129 If you are using nginx, you can add the following to your $vhost.conf:
130
131 ```nginx
132 location ~ /var-.* {
133 deny all;
134 return 404;
135 }
136 ```
137
138 If you are using lighttpd, you can deny access to ```var``` folder in your configuration:
139
140 ```
141 $HTTP["url"] =~ "^/var-*" {
142 url.access-deny = ("")
143 }
144 ```
145
146 You should also remove un-necessessary write access once the installation is done (ex: configuration file).
147 An other obvious basic security is to let access users to the site by HTTPS (make sure `web_root` in you `config.local.php` is set with https).
148
149 ## Server side encryption
150
151 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).
152 The decrypt key is not stored on the server so if you loose an url, you won't be able to retrieve file content.
153 In case of security troubles on the server, attacker won't be able to access files.
154
155 By activating this feature, you have to be aware of few things:
156 - Data encryption has a cost (cpu) and it takes more time for downloads to complete once file sent.
157 - During the download, the server will decrypt on the fly (and use resource).
158 - This feature needs to have the mcrypt php module.
159 - File de-duplication will stop to work (as we can't compare two encrypted files).
160 - Be sure your server do not log client's requests.
161 - Don't forget to enable https.
162
163 In a next step, encryption will be made by the client (in javascript), see issue #10.
164
165 ## License
166
167 GNU Affero General Public License v3 (AGPL-3.0).
168
169 The GNU Affero General Public License can be found at https://www.gnu.org/licenses/agpl.html.
170
171 Please note: If you decide do make adaptions to the source code and run a service with these changes incorporated,
172 you are required to provide a link to the source code of your version in order to obey the AGPL-3.0 license.
173 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.
174 Take a look at the FAQ to find out about how to change the ToS.
175
176 PS: If you have fixed errors or added features, then please contribute to the project and send a merge request with these changes.
177
178 ## Contribution
179
180 If you want to contribute to project, then take a look at the git repository:
181
182 - https://gitlab.com/mojo42/Jirafeau
183
184 and the Contribution Guidelines
185
186 - https://gitlab.com/mojo42/Jirafeau/blob/master/CONTRIBUTING.md
187
188 ## FAQ
189
190 ### Can I add a new language in Jirafeau?
191
192 Of course ! Translations are easy to make and no technical knowledge is required.
193
194 Simply go to [Jirafeau's Weblate](https://hosted.weblate.org/projects/jirafeau/master/).
195
196 If you want to add a new language in the list, feel free to contact us or leave a comment in ticket #9.
197
198 We would like to thank all anonymous contributors on weblate. :)
199
200 ### How do I upgrade my Jirafeau?
201
202 See upgrade instructions above.
203
204 ### How can I limit upload access?
205
206 There are two ways to limit upload access (but not download):
207 - you can set one or more passwords in order to access the upload interface, or/and
208 - 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
209
210 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).
211
212 ### How can I automatize the cleaning of old (expired) files?
213
214 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```.
215
216 Then the command can be placed in a cron file to automatize the process. For example:
217 ```
218 # m h dom mon dow user command
219 12 3 * * * www-data php /path/to/jirafeau/admin.php clean_expired
220 16 3 * * * www-data php /path/to/jirafeau/admin.php clean_async
221 ```
222
223 ### I have some troubles with IE
224
225 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).
226
227 Anyway I would recommend you to use another web browser. :)
228
229 ### How can I change the theme?
230
231 You may change the default theme to any of the existing ones or a custom.
232
233 Open your ```lib/config.local.php``` and change setting in the »`style`« key to the name of any folder in the ```/media``` directory.
234
235 Hint: To create a custom theme just copy the »courgette« folder and name your theme »custom« (this way it will be ignored by git and not overwritten during updates). You are invited to enhance the existing themes and send pull requests however.
236
237 ### I found a bug, what should I do?
238
239 Feel free to open a bug in the [GitLab's issues](https://gitlab.com/mojo42/Jirafeau/issues).
240
241 ### How to set maximum file size?
242
243 If your browser supports HTML5 file API, you can send files as big as you want.
244
245 For browsers who does not support HTML5 file API, the limitation come from PHP configuration.
246 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.
247
248 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)
249
250 ### How can I edit an option?
251
252 Documentation of all default options are located in [lib/config.original.php](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/config.original.php).
253 If you want to change an option, just edit your ```lib/config.local.php```.
254
255 ### How can I change the Terms of Service?
256
257 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)«.
258
259 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.
260
261 If you update the installation, then only the ```tos.original.txt``` file may change eventually, not your ```tos.local.txt``` file.
262
263 ### How can I access the admin interface?
264
265 Just go to ```/admin.php```.
266
267 ### How can I use the scripting interface (API)?
268
269 Simply go to ```/script.php``` with your web browser.
270
271 ### My downloads are incomplete or my uploads fails
272
273 Be sure your PHP installation is not using safe mode, it may cause timeouts.
274
275 If you're using nginx, you might need to increase `client_max_body_size` or remove the restriction altogether. In your nginx.conf:
276
277 ```nginx
278 http {
279 # disable max upload size
280 client_max_body_size 0;
281 # add timeouts for very large uploads
282 client_header_timeout 30m;
283 client_body_timeout 30m;
284 }
285 ```
286
287 ### How can I monitor the use of my Jirafeau instance?
288
289 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).
290
291 ### Why forking?
292
293 The original project seems not to be continued anymore and I prefer to add more features and increase security from a stable version.
294
295 ### What can we expect in the future?
296
297 Check [issues](https://gitlab.com/mojo42/Jirafeau/issues) to check open bugs and incoming new stuff. :)
298
299 ### What about this file deduplication thing?
300
301 Jirafeau uses a very simple file level deduplication for storage optimization.
302
303 This mean that if some people upload several times the same file, this will only store one time the file and increment a counter.
304
305 If someone use his/her delete link or an admin cleans expired links, this will decrement the counter corresponding to the file.
306
307 When the counter falls to zero, the file is destroyed.
308
309 ### What is the difference between "delete link" and "delete file and links" in admin interface?
310
311 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.
312 So:
313 - The button "delete link" will delete the reference to the file but might not destroy the file.
314 - The button "delete file and links" will delete all references pointing to the file and will destroy the file.
315
316 ### How to contact someone from Jirafeau?
317
318 Feel free to create an issue if you found a bug.
319
320 ## Release notes
321
322 ### Version 1.0
323
324 The very first version of Jirafeau after the fork of Jyraphe.
325
326 - Security fix
327 - Keep uploader's ip
328 - Delete link for each upload
329 - No more clear text password storage
330 - Simple langage support
331 - Add an admin interface
332 - New Design
333 - Add term of use
334 - New path system to manage large number of files
335 - New option to show a page at download time
336 - Add option to activate or not preview mode
337
338 ### Version 1.1
339
340 - New skins
341 - Add optional server side encryption
342 - Unlimited file size upload using HTML5 file API
343 - Show speed and estimated time during upload
344 - A lot of fixes
345 - A lot of new langages
346 - Small API to upload files
347 - Limit access to Jirafeau using IP, mask, passwords
348 - Manage (some) proxy headers
349 - Configure your maximal upload size
350 - Configure file's lifetime durations
351 - Preview URL
352 - Get Jirafeau's version in admin interface
353
354 ## Version 1.2.0
355
356 - Link on API page to generate bash script
357 - More informative error codes for API
358 - Security Fix: Prevent authentication bypass for admin interface
359 - CLI script to remove expired files automatically with a cronjob
360 - SHA-256 hash the admin password
361 - New theme "elegantish"
362 - Fix for JavaScript MIME-Type, prevents blocking the resource on some servers
363 - Show download link for a file in admin interface
364 - Default time for expiration (set to 'month' by default)
365 - New expiration time: 'quarter'
366 - A lof of translation contributions
367 - Code cleanups
368
369 ## Version 2.0.0
370
371 - Various documentation improvements
372 - Simplify automatic generation of local configuration file
373 - Set a custom title
374 - Bash Script: Enhanced help, show version, return link to web view as well
375 - »Terms of Service« refactored - Enable admin to overwrite the ToS, without changing existing source code → breaking, see upgrade notes
376
377 ## Version 3.0.0
378
379 - Remove XHTML doctype, support HTML5 only → breaking change for older browsers
380 - Remove redundant code
381 - Remove baseurl usage and set absolute links instead, which for example fixes SSL issues
382 - Extend contribution guide
383 - Switch to PSR-2 code style (fix line endings, indentations, whitespaces, etc)
384 - Declare system requirements
385 - Catch API errors in upload form
386 - Allow clients to upload files depending on IP or password
387 - Set UTC as timezone to prevent date/time issues
388 - Show readable date & time information
389 - Fix UI glitches in admin panel and upload form
390
391 ## Version 3.1.0
392
393 - Fix regression on user authentication (see #113)
394 - Some cosmetic change
395
396 ## Version 3.2.0
397
398 - Update translations from Update translations from weblate
399 - Better style
400 - Fix regression on admin password setting
401
402 ## Version 3.2.1
403
404 - fix download view after an upload
405
406 ## Version 3.3.0
407
408 - Added Docker Support
409 - Added a copy button next to links to copy URLs in clipboard
410 - Now use a delete page to confirm file deletion (#136)
411 - Fixed object ProgressEvent Error (#127)
412 - Added configuration tips for web servers
413 - More translations
414 - Style fixes
415 - Removed useless alias API support (some old toy)

patrick-canterino.de