]> git.p6c8.net - jirafeau/jirafeau.git/blobdiff - README.md
Updated README
[jirafeau/jirafeau.git] / README.md
index 8c900b0780b253aa803f93d8238dd6f0645d84ab..ebec88e840c15a1ae84a834c813d878f3f3b6ce4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,8 +7,6 @@ Welcome to the official Jirafeau project, an [Open-Source software](https://en.w
 
 Jirafeau is a "one-click-filesharing": Select your file, upload, share a link. That's it.
 
 
 Jirafeau is a "one-click-filesharing": Select your file, upload, share a link. That's it.
 
-See [jirafeau.net](https://jirafeau.net/) for a demo.
-
 ![Screenshot1](screenshots/upload1.png)
 
 ## DISCLAMER
 ![Screenshot1](screenshots/upload1.png)
 
 ## DISCLAMER
@@ -29,6 +27,7 @@ In this repository we are aiming to continue development of the original Jirafea
 - Option to require, check or generate file download passwords
 - Set expiration time for downloads
 - Option to self-destruct after first download
 - Option to require, check or generate file download passwords
 - Set expiration time for downloads
 - Option to self-destruct after first download
+- Option to configure forbidden file extensions
 - Shortened URLs using Base64 encoding
 - Maximal upload size configurable
 - No database, only use basic PHP
 - Shortened URLs using Base64 encoding
 - Maximal upload size configurable
 - No database, only use basic PHP
@@ -63,10 +62,10 @@ Jirafeau project won't evolve to a file manager and will focus to keep a very fe
 
 This shows how to install Jirafeau by your own, it's quite simple but you can
 also use a [docker image](https://gitlab.com/jirafeau/Jirafeau/container_registry/) or build
 
 This shows how to install Jirafeau by your own, it's quite simple but you can
 also use a [docker image](https://gitlab.com/jirafeau/Jirafeau/container_registry/) or build
-it yourself. Check [docker folder](docker/README.md) for more informations.
+it yourself. Check [docker folder](docker/README.md) for more information.
 
 System requirements:
 
 System requirements:
-- PHP >= 7.4
+- PHP >= 8.1
 - Optional, but recommended: Git >= 2.7
 - No database required, no mail required
 
 - Optional, but recommended: Git >= 2.7
 - No database required, no mail required
 
@@ -90,12 +89,13 @@ If you have some troubles, consider the following cases
 
 - Check your `/lib/config.local.php` file and compare it with `/lib/config.original.php`, the configuration syntax or a parameter may have changed
 - Check owner and permissions of your files
 
 - Check your `/lib/config.local.php` file and compare it with `/lib/config.original.php`, the configuration syntax or a parameter may have changed
 - Check owner and permissions of your files
-- set `debug` option to `true` to check any warning or error
+- Set `debug` option to `true` to check any warning or error
 
 ## Security
 
 `var` directory contains 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:
 
 ## Security
 
 `var` directory contains 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:
+
 - Configure a `.htaccess`
 - 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)
 - Configure a `.htaccess`
 - 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)
@@ -142,14 +142,22 @@ Encryption is configured to use [XChaCha20-Poly1305](https://en.wikipedia.org/wi
 In case of security troubles on the server, attacker won't be able to access files.
 
 By activating this feature, you have to be aware of few things:
 In case of security troubles on the server, attacker won't be able to access files.
 
 By activating this feature, you have to be aware of few things:
--  Data encryption has a cost (CPU) and it takes more time for downloads to complete once file sent.
--  During the download, the server will decrypt on the fly (and use resource).
--  This feature needs to have the [`Sodium`](https://www.php.net/manual/en/book.sodium.php) PHP module.
--  File de-duplication will stop to work (as we can't compare two encrypted files).
--  Be sure your server does not log client's requests.
--  Don't forget to enable HTTPS.
 
 
-In a next step, encryption will be made by the client (in JavaScript).
+- This is **no** [end-to-end encryption](https://en.wikipedia.org/wiki/End-to-end_encryption)! Although the file should be sent to server using HTTPS, the file is unencrypted on the server for a very short time. To have end-to-end encryption, you need to encrypt the file yourself.
+- Data encryption has a cost (CPU) and it takes more time for downloads to complete once file sent.
+- During the download, the server will decrypt on the fly (and use resource).
+- This feature needs to have the [`Sodium`](https://www.php.net/manual/en/book.sodium.php) PHP module.
+- File de-duplication will stop to work (as we can't compare two encrypted files).
+- Be sure your server does not log client's requests.
+- Don't forget to enable HTTPS.
+
+In a next step, encryption will be made by the client (in JavaScript), which will also give us end-to-end encryption.
+
+## Known issues
+
+- There is an [issue](https://gitlab.com/jirafeau/Jirafeau/-/issues/40) with asynchronous uploads not working in Chromium-based browsers on servers with HTTP/3 enabled. This seems to be caused by a [bug in Chromium](https://issues.chromium.org/issues/457463688).  
+This bug can be worked around by setting `max_upload_chunk_size_bytes` to a value of around 3000000 to 5000000 (3 to 5MB) which is default since Jirafeau version 4.7.1. Please note that you have to change this value manually if you're upgrading from a version of Jirafeau older than 4.7.1!  
+Thanks to [slt](https://gitlab.com/sltrash) for reporting this and for finding a workaround.
 
 ## License
 
 
 ## License
 
@@ -222,7 +230,7 @@ Hint: To create a custom theme just copy the `courgette` folder and name your th
 ### I found a bug, what should I do?
 
 Feel free to open a bug in the [GitLab's issues](https://gitlab.com/jirafeau/Jirafeau/issues).
 ### I found a bug, what should I do?
 
 Feel free to open a bug in the [GitLab's issues](https://gitlab.com/jirafeau/Jirafeau/issues).
-If you can, please copy-paste informations related to bug opening provided in admin interface.
+If you can, please copy-paste information related to bug opening provided in admin interface.
 Admin interface can be reached by accessing `/admin.php`.
 
 ### How to set maximum file size?
 Admin interface can be reached by accessing `/admin.php`.
 
 ### How to set maximum file size?
@@ -236,8 +244,8 @@ If you don't want to allow unlimited upload size, you can still setup a maximal
 
 ### 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/jirafeau/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/jirafeau/Jirafeau/blob/master/lib/config.original.php).
+If you want to change an option, just edit your `/lib/config.local.php`.
 
 ### How can I change the Terms of Service?
 
 
 ### How can I change the Terms of Service?
 
@@ -312,4 +320,4 @@ Feel free to create an [issue](https://gitlab.com/jirafeau/Jirafeau/-/issues) if
 
 You can [drop few bucks for Jérôme Jutteau](https://www.paypal.com/paypalme/jeromejutteau)
 
 
 You can [drop few bucks for Jérôme Jutteau](https://www.paypal.com/paypalme/jeromejutteau)
 
-Many Thanks <3
\ No newline at end of file
+Many Thanks <3

patrick-canterino.de