Added some comments explaining the build job for the Docker image

[jirafeau_project.git] / README.md

diff --git a/README.md b/README.md
index a4fba91a6527a9631159d87a5248bf39accd21ea..d2ac2b5d34b964004b1a3433a7608c4d0e799b27 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,72 +1,119 @@
-# Introduction
+# Jirafeau
+
+![Made With](https://img.shields.io/badge/made_with-php-blue.svg)
+![License](https://img.shields.io/badge/license-agpl--3.0-blue.svg)

 
 Welcome to the official Jirafeau project, an [Open-Source software](https://en.wikipedia.org/wiki/Open-source_software).
 
 
 Welcome to the official Jirafeau project, an [Open-Source software](https://en.wikipedia.org/wiki/Open-source_software).
 

-Jirafeau is a web site permitting to upload a file in a simple way and give an unique link to it.
-
-A demonstration of the latest version is available on [jirafeau.net](http://jirafeau.net/)
-
-![Screenshot1](http://i.imgur.com/TPjh48P.png)
-
-**Main features**:
--  One upload => One download link & One delete linkp
--  Send any large files (thanks to HTML5)
--  NO database, only use basic PHP
--  Shows progression: speed, percentage and remaining upload time
--  Preview content in browser (if possible)
--  Optional Password protection (for uploading or downloading)
--  Time limitation
--  Option to self-destruct after reading
--  Simple language support :gb: :fr: :de: :it: :nl: :ro: :sk: :hu: :cn: :gr: :ru: :es:
--  Small administration interface
--  File level [Deduplication](http://en.wikipedia.org/wiki/Data_deduplication) for storage optimization
--  A basic Terms Of Service which can be adapted to your needs
--  Shortened URLs using base 64 encoding
--  API interface
--  Optional data encryption
--  Skins
-...
-
-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.
+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
+
+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
+
+- One upload → one download link and one delete link
+- Send any large files (thanks to the HTML5 file API → PHP `post_max_size` limit not relevant)
+- Shows upload progress: speed, percentage and remaining upload time
+- Preview content in browser (if possible)
+- Optional password protection (for uploading or downloading)
+- Option to require, check or generate file download passwords
+- Set expiration time for downloads
+- Option to self-destruct after first download
+- Shortened URLs using Base64 encoding
+- Maximal upload size configurable
+- No database, only use basic PHP
+- Simple language support with a lot of languages
+- File level [deduplication](http://en.wikipedia.org/wiki/Data_deduplication) for storage optimization (does store duplicate files only once, but generate multiple links)
+- Optional data encryption
+- Small administration interface
+- CLI script to remove expired files automatically with a cronjob
+- Basic, adaptable "Terms Of Service" page
+- Basic API
+- Bash script to upload files via command line
+- Themes
+
+Jirafeau is a fork of the original project [Jyraphe](https://web.archive.org/web/20170506133242/home.gna.org/jyraphe) based on the 0.5 (stable version) with a **lot** of modifications.

 
 As it's original project, Jirafeau is made in the [KISS](http://en.wikipedia.org/wiki/KISS_principle) way (Keep It Simple, Stupid).
 
 Jirafeau project won't evolve to a file manager and will focus to keep a very few dependencies.
 
 
 As it's original project, Jirafeau is made in the [KISS](http://en.wikipedia.org/wiki/KISS_principle) way (Keep It Simple, Stupid).
 
 Jirafeau project won't evolve to a file manager and will focus to keep a very few dependencies.
 

-# Screenshots
+## Screenshots
+
+- [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
+it yourself. Check [docker folder](docker/README.md) for more information.

 
 

-Here are some screenshots:
-- [Installation part 1](http://i.imgur.com/hmpT1eN.jpg)
-- [Installation part 2](http://i.imgur.com/2e0UGKE.jpg)
-- [Installation part 3](http://i.imgur.com/ofAjLXh.jpg)
-- [Installation part 4](http://i.imgur.com/WXqnfqJ.jpg)
-- [Upload 1](http://i.imgur.com/SBmSwzJ.jpg)
-- [Upload 2](http://i.imgur.com/wzPkb1Z.jpg)
-- [Upload 3](http://i.imgur.com/i6n95kv.jpg)
-- [Upload 4](http://i.imgur.com/P2oS1MY.jpg)
+System requirements:
+- PHP >= 7.4
+- Optional, but recommended: Git >= 2.7
+- No database required, no mail required

 
 

-# Installation
--  [Download](https://gitlab.com/mojo42/Jirafeau/repository/archive.zip) the last version of Jirafeau from GitLab
--  Upload files on your web server
--  Don't forget to set owner of uploaded files if you need to
--  Get your web browser and go to you install location (e.g. ```http://your-web-site.org/jirafeau/```) and follow instructions
--  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```
+Installation steps:
+- Clone the [repository](https://gitlab.com/jirafeau/Jirafeau/) or download the latest [release](https://gitlab.com/jirafeau/Jirafeau/tags) from GitLab onto your webserver
+- Set owner & group according to your webserver
+- A) Setup with the installation wizard (web):
+  - Open your browser and go to your installed location, eg. `https://example.com/jirafeau/`
+  - The script will redirect to you to a minimal installation wizard to set up all required options
+  - All optional parameters may be set in `lib/config.local.php`, take a look at `lib/config.original.php` to see all default values
+- B) Setup without the installation wizard (cli):
+  - Just copy `lib/config.original.php` to `lib/config.local.php` and customize it

 
 

-Note that ```lib/config.local.php``` is auto-generated during the installation.
+💡 Hint: How to
+[install & configure Jirafeau](https://www.howtoforge.com/how-to-setup-a-file-sharing-website-with-jirafeau-on-debian-10/)
+on Debian 10 from scratch, with nginx and PHP-FPM.

 
 

-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.
+### Troubleshooting

 
 

-# Security
+If you have some troubles, consider the following cases

 
 

-```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.
+- 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
+
+## 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:
 You have several options:

-- Configure a ```.htaccess```
+
+- 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)
 
 - 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:
 


@@ -77,50 +124,68 @@ location ~ /var-.* {
 }
 ```
 
 }
 ```
 

+If you are using lighttpd, you can deny access to `var` folder in your configuration:
+
+```
+$HTTP["url"] =~ "^/var-*" {
+         url.access-deny = ("")
+}
+```
+

 You should also remove un-necessessary write access once the installation is done (ex: configuration file).
 You should also remove un-necessessary write access once the installation is done (ex: configuration file).

-An other obvious basic security is to let access users to the site by HTTPS.
+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).

 
 

-# Few notes about server side encryption
+## Server side encryption

 
 

-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).
-The decrypt key is not stored on the server so if you loose an url, you won't be able to retrieve file content.
+Data encryption can be activated in options. This feature makes the server encrypt data and send the decrypt key to the user (inside download URL).
+The decrypt key is not stored on the server so if you lose the download URL, you won't be able to retrieve file content.
+Encryption is configured to use [XChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305).

 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.
+-  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).
 -  During the download, the server will decrypt on the fly (and use resource).

--  This feature needs to have the mcrypt 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).
 -  File de-duplication will stop to work (as we can't compare two encrypted files).

--  Be sure your server do not log client's requests.
--  Don't forget to enable https.
+-  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), see issue #10.
+In a next step, encryption will be made by the client (in JavaScript).

 
 

-# FAQ
+## License

 
 

-### Can I add a new language in Jirafeau?
+GNU Affero General Public License v3 (AGPL-3.0).

 
 

-Of course ! Translations are easy to make and no technical knowledge is required.
+The GNU Affero General Public License can be found at https://www.gnu.org/licenses/agpl.html.

 
 

-Simply go to [Jirafeau's Weblate](https://hosted.weblate.org/projects/jirafeau/master/).
+Please note: If you decide do make adaptions to the source code and run a service with these changes incorporated,
+you are required to provide a link to the source code of your version in order to obey the AGPL-3.0 license.
+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.
+Take a look at the FAQ to find out about how to change the ToS.

 
 

-If you want to add a new language in the list, feel free to contact us or leave a comment in ticket #9.
+PS: If you have fixed errors or added features, then please contribute to the project and send a merge request with these changes.

 
 

-We would like to thank all anonymous contributors on weblate. :)
+## Contribution

 
 

-### How do I upgrade my Jirafeau?
+If you want to contribute to project, then take a look at the git repository:

 
 

-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.
+- https://gitlab.com/jirafeau/Jirafeau

 
 

-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.
+and the Contribution Guidelines

 
 

-After upgrading, you can compare your ```lib/config.local.php``` and ```lib/config.original.php``` to see if new configuration items are available.
+- https://gitlab.com/jirafeau/Jirafeau/blob/master/CONTRIBUTING.md

 
 

-If you have some troubles:
-- It should probably come from your ```lib/config.local.php``` (configuration syntax may have changed). Just compare it with ```lib/config.original.php```
-- Check owner/permissions of your files.
+## FAQ
+
+### Can I add a new language in Jirafeau?

 
 

-Anyway you should off-course make a backup of your current installation before doing anything. :)
+Of course! The best way is to create a new JSON file under `lib/locales` and open a merge request.
+
+Thanks to all contributors ! :)
+
+### How do I upgrade my Jirafeau?
+
+See change log and upgrade procedure in [CHANGELOG.md](https://gitlab.com/jirafeau/Jirafeau/blob/master/CHANGELOG.md).

 
 ### How can I limit upload access?
 
 
 ### How can I limit upload access?
 


@@ -128,11 +193,11 @@ There are two ways to limit upload access (but not download):
 - you can set one or more passwords in order to access the upload interface, or/and
 - 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
 
 - you can set one or more passwords in order to access the upload interface, or/and
 - 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
 

-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).
+Check documentation of `upload_password` and `upload_ip` parameters in [lib/config.original.php](https://gitlab.com/jirafeau/Jirafeau/blob/master/lib/config.original.php).

 
 ### How can I automatize the cleaning of old (expired) files?
 
 
 ### How can I automatize the cleaning of old (expired) files?
 

-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```.
+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`.

 
 Then the command can be placed in a cron file to automatize the process. For example:
 ```
 
 Then the command can be placed in a cron file to automatize the process. For example:
 ```


@@ -147,37 +212,55 @@ If you have some strange behavior with IE, you may configure [compatibility mode
 
 Anyway I would recommend you to use another web browser. :)
 
 
 Anyway I would recommend you to use another web browser. :)
 

+### How can I change the theme?
+
+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. 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). 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?
 
 ### I found a bug, what should I do?
 

-Feel free to open a bug in the [GitLab's issues](https://gitlab.com/mojo42/Jirafeau/issues).
+Feel free to open a bug in the [GitLab's issues](https://gitlab.com/jirafeau/Jirafeau/issues).
+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?
 
 
 ### How to set maximum file size?
 

-If your browser supports HTML5 file API, you can send files as big as you want.
+If your browser supports the HTML5 file API, you can send files as big as you want.

 
 

-For browsers who does not support HTML5 file API, the limitation come from PHP configuration.
-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.
+For browsers not supporting the HTML5 file API, the limitation comes from PHP configuration.
+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. Note that nginx setups may requiere to configure `client_max_body_size`.

 
 

-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)
+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)

 
 ### 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/mojo42/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?
+
+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)".
+
+To change this text simply copy the file [/lib/tos.original.txt](https://gitlab.com/jirafeau/Jirafeau/blob/master/lib/tos.original.txt), rename it to `/lib/tos.local.txt` and adapt it to your own needs.
+
+If you update the installation, then only the `tos.original.txt` file may change eventually, not your `tos.local.txt` file.

 
 ### How can I access the admin interface?
 
 
 ### How can I access the admin interface?
 

-Just go to ```/admin.php```.
+Just go to `/admin.php`.

 
 ### How can I use the scripting interface (API)?
 
 
 ### How can I use the scripting interface (API)?
 

-Simply go to ```/script.php``` with your web browser.
+Simply go to `/script.php` with your web browser.

 
 ### My downloads are incomplete or my uploads fails
 
 Be sure your PHP installation is not using safe mode, it may cause timeouts.
 
 
 ### My downloads are incomplete or my uploads fails
 
 Be sure your PHP installation is not using safe mode, it may cause timeouts.
 

-If you're using nginx, you might need to increase `client_max_body_size` or remove the restriction altogether. In your nginx.conf:
+If you're using nginx, you might need to increase `client_max_body_size` or remove the restriction altogether. In your `nginx.conf`:

 
 ```nginx
 http {
 
 ```nginx
 http {


@@ -195,81 +278,39 @@ You may use Munin and simple scripts to collect the number of files in the Jiraf
 
 ### Why forking?
 
 
 ### Why forking?
 

-The original project seems not to be continued anymore and I prefer to add more features and increase security from a stable version.
+In this repository we are aiming to continue development of the original Jirafeau project. We plan to add more features and increase security from a stable version.

 
 ### What can we expect in the future?
 
 
 ### What can we expect in the future?
 

-Check [issues](https://gitlab.com/mojo42/Jirafeau/issues) to check open bugs and incoming new stuff. :)
-
-### What is the Jirafeau's license?
-
-Jirafeau is licensed under [AGPLv3](https://gitlab.com/mojo42/Jirafeau/blob/master/COPYING).
-
-### How do I modify the TOS (terms of use)?
-
-Just edit ```tos.php``` and configure ```$org``` and ```$contact``` variables.
+Check [issues](https://gitlab.com/jirafeau/Jirafeau/issues) to check open bugs and incoming new stuff. :)

 
 ### What about this file deduplication thing?
 
 
 ### What about this file deduplication thing?
 

-Jirafeau uses a very simple file level deduplication for storage optimization.
+Jirafeau can use a very simple file level deduplication for storage optimization.

 
 

-This mean that if some people upload several times the same file, this will only store one time the file and increment a counter.
+This means that if some people upload the same file several times, the file will only be stored once and a counter will be incremented.

 
 If someone use his/her delete link or an admin cleans expired links, this will decrement the counter corresponding to the file.
 
 When the counter falls to zero, the file is destroyed.
 
 
 If someone use his/her delete link or an admin cleans expired links, this will decrement the counter corresponding to the file.
 
 When the counter falls to zero, the file is destroyed.
 

+In order to know if a newly uploaded file already exist, Jirafeau will hash the file using MD5 by default but other methods are available (see `file_hash` documentation in `lib/config.original.php`).
+
+This feature is disabled by default and can be enabled through the `file_hash` option.
+

 ### What is the difference between "delete link" and "delete file and links" in admin interface?
 
 ### What is the difference between "delete link" and "delete file and links" in admin interface?
 

-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.
+When file deduplication feature is enabled, files with the same hash are not duplicated and a reference counter stores the number of links pointing to a single file.

 So:
 - The button "delete link" will delete the reference to the file but might not destroy the file.
 - The button "delete file and links" will delete all references pointing to the file and will destroy the file.
 
 ### How to contact someone from Jirafeau?
 
 So:
 - The button "delete link" will delete the reference to the file but might not destroy the file.
 - The button "delete file and links" will delete all references pointing to the file and will destroy the file.
 
 ### How to contact someone from Jirafeau?
 

-Feel free to create an issue if you found a bug.
-
-# Release notes
-
-## Version 1.0
-
-The very first version of Jirafeau after the fork of Jyraphe.
-
-- Security fix
-- Keep uploader's ip
-- Delete link for each upload
-- No more clear text password storage
-- Simple langage support
-- Add an admin interface
-- New Design
-- Add term of use
-- New path system to manage large number of files
-- New option to show a page at download time
-- Add option to activate or not preview mode
-
-## Version 1.1
-
-- New skins
-- Add optional server side encryption
-- Unlimited file size upload using HTML5 file API
-- Show speed and estimated time during upload
-- A lot of fixes
-- A lot of new langages
-- Small API to upload files
-- Limit access to Jirafeau using IP, mask, passwords
-- Manage (some) proxy headers
-- Configure your maximal upload size
-- Configure file's lifetime durations
-- Preview URL
-- Get Jirafeau's version in admin interface
-
-### Update from 1.0 to 1.1
-
-1. Backup you Jirafeau installation
-2. Block access to Jirafeau
-3. Checkout new version using git tag 1.1
-4. With you browser, go to your Jirafeau root page
-5. Follow installation wizard, it should propose you the same data folder
-6. Add a rewrite rule in your web server configuration to rename file.php to f.php to make old url work again
-7. Go in you lib/config.local.php and lib/config.original.php to check new options and eventually change skin to 'courgette'
+Feel free to create an [issue](https://gitlab.com/jirafeau/Jirafeau/-/issues) if you found a bug.
+
+### Can I buy you a coffee?
+
+You can [drop few bucks for Jérôme Jutteau](https://www.paypal.com/paypalme/jeromejutteau)
+
+Many Thanks <3