Store filesize before encrypting the file

[jirafeau.git] / README.md

diff --git a/README.md b/README.md
index 8f4d169b4d219e9092cb2b2aced3d4598bc8b0b0..d2ac2b5d34b964004b1a3433a7608c4d0e799b27 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Jirafeau is a "one-click-filesharing": Select your file, upload, share a link. T
 
 See [jirafeau.net](https://jirafeau.net/) for a demo.
 
 
 See [jirafeau.net](https://jirafeau.net/) for a demo.
 

-![Screenshot1](http://i.imgur.com/TPjh48P.png)
+![Screenshot1](screenshots/upload1.png)

 
 ## DISCLAMER
 
 
 ## DISCLAMER
 


@@ -50,21 +50,20 @@ Jirafeau project won't evolve to a file manager and will focus to keep a very fe
 
 ## Screenshots
 
 
 ## Screenshots
 

-- [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 - Step 1](screenshots/install1.png)
+- [Installation - Step 2](screenshots/install2.png)
+- [Installation - Step 3](screenshots/install3.png)
+- [Upload - Step 1](screenshots/upload1.png)
+- [Upload - Step 2](screenshots/upload2.png)
+- [Upload - Progress](screenshots/upload_progress.png)
+- [Upload - Confirmation page](screenshots/upload_confirm.png)
+- [Admin Interface](screenshots/admin.png)

 
 ## Installation
 
 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
 
 ## Installation
 
 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:
 - PHP >= 7.4
 
 System requirements:
 - PHP >= 7.4


@@ -91,19 +90,30 @@ 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)
 

-If you are using Apache, you can add the following line to your configuration to prevent people to access to your `var` folder:
+If you are using Apache, you can add the following lines to your configuration to prevent people to access to your `var` folder:
+
+```apache
+<LocationMatch "^/var-*">
+    Require all denied
+</LocationMatch>
+```
+
+Or you can put a `.htaccess` file containing this into your `var` folder:

 
 

-`RedirectMatch 301 ^/var-.* http://my.service.jirafeau`
+```apache
+Require all denied
+```

 
 If you are using nginx, you can add the following to your $vhost.conf:
 
 
 If you are using nginx, you can add the following to your $vhost.conf:
 


@@ -206,14 +216,14 @@ Anyway I would recommend you to use another web browser. :)
 
 You may change the default theme to any of the existing ones or a custom.
 
 
 You may change the default theme to any of the existing ones or a custom.
 

-Open your `lib/config.local.php` and change setting in the `style` key to the name of any folder in the `/media` directory.
+Open your `lib/config.local.php` and change setting in the `style` key to the name of any folder in the `/media` directory. If you want to change the theme for dark mode, you have to set the `dark_style` key in the config file.

 
 

-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.
+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). If you want to create a custom theme for dark mode, you have to put it in a folder named `dark-custom`. You are invited to enhance the existing themes and send pull requests however.

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


@@ -227,8 +237,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?
 


@@ -301,4 +311,6 @@ Feel free to create an [issue](https://gitlab.com/jirafeau/Jirafeau/-/issues) if
 
 ### Can I buy you a coffee?
 
 
 ### Can I buy you a coffee?
 

-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