Build Docker images for linux/arm/v7, linux/arm64/v8 and linux/amd64

[jirafeau_project.git] / README.md

diff --git a/README.md b/README.md
index ac8c26e97ddade0d633ee70730f7a45c21be31f5..d2ac2b5d34b964004b1a3433a7608c4d0e799b27 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,3 @@
-# DISCLAMER
-
-This project is a fork of the [discontinued project](https://gitlab.com/mojo42/Jirafeau/) by [Jérôme Jutteau](https://gitlab.com/mojo42/).
-
-If you've also forked the original project, feel free to mention it in [comments](https://gitlab.com/mojo42/Jirafeau/-/issues/360). Jérôme will add it there.
-
-In this repository we are aiming to continue development of the original Jirafeau project. Feel free to contribute to this fork by participating in discussions and providing merge requests, so we can build the best version of Jirafeau together!
-

 # Jirafeau
 
 ![Made With](https://img.shields.io/badge/made_with-php-blue.svg)
 # Jirafeau
 
 ![Made With](https://img.shields.io/badge/made_with-php-blue.svg)


@@ -17,7 +9,15 @@ 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
+
+This project is a fork of the [discontinued project](https://gitlab.com/mojo42/Jirafeau/) by [Jérôme Jutteau](https://gitlab.com/mojo42/).
+
+If you've also forked the original project, feel free to mention it in [comments](https://gitlab.com/mojo42/Jirafeau/-/issues/360). Jérôme will add it there.
+
+In this repository we are aiming to continue development of the original Jirafeau project. Feel free to contribute to this fork by participating in discussions and providing merge requests, so we can build the best version of Jirafeau together!

 
 ## Main features
 
 
 ## Main features
 


@@ -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
 
 ## Installation
 
 This shows how to install Jirafeau by your own, it's quite simple but you can

-also use a [docker image](https://hub.docker.com/r/mojo42/jirafeau/) or build
-it yourself. Check [docker folder](docker/README.md) for more informations.
+also use a [docker image](https://gitlab.com/jirafeau/Jirafeau/container_registry/) or build
+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:

 
 

-`RedirectMatch 301 ^/var-.* http://my.service.jirafeau`
+```apache
+<LocationMatch "^/var-*">
+    Require all denied
+</LocationMatch>
+```
+
+Or you can put a `.htaccess` file containing this into your `var` folder:
+
+```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:
 


@@ -135,7 +145,7 @@ In case of security troubles on the server, attacker won't be able to access fil
 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).
 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 php module.
+-  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.
 -  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.


@@ -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