Update README.md

[jirafeau_mojo42.git] / lib / config.original.php

diff --git a/lib/config.original.php b/lib/config.original.php
index 30440a2c6c158b04b1537f98aa5c68e3feb93679..1f2e8b7073b441454bea055c5843c876371085c5 100644 (file)
--- a/lib/config.original.php
+++ b/lib/config.original.php
@@ -2,7 +2,7 @@
 /*
  *  Jirafeau, your web file repository
  *  Copyright (C) 2008  Julien "axolotl" BERNARD <axolotl@magieeternelle.org>
 /*
  *  Jirafeau, your web file repository
  *  Copyright (C) 2008  Julien "axolotl" BERNARD <axolotl@magieeternelle.org>

- *  Copyright (C) 2015  Jerome Jutteau <j.jutteau@gmail.com>
+ *  Copyright (C) 2015  Jerome Jutteau <jerome@jutteau.fr>

  *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU Affero General Public License as
  *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU Affero General Public License as


@@ -25,7 +25,7 @@
  * rename it to »config.local.php« and adapt the parameters.
  **/
 
  * rename it to »config.local.php« and adapt the parameters.
  **/
 

-/* URL of installation, with traling slash (eg. »https://exmaple.com/jirafeau/«)
+/* URL of installation, with trailing slash (eg. »https://example.com/jirafeau/«)

  */
 $cfg['web_root'] = '';
 
  */
 $cfg['web_root'] = '';
 


@@ -33,15 +33,17 @@ $cfg['web_root'] = '';
  */
 $cfg['var_root'] = '';
 
  */
 $cfg['var_root'] = '';
 

-/* Language - choice between 'auto' or any language located in the /lib/locales/ folder.
+/* Language - choose between 'auto' or any language located in the /lib/locales/ folder.

  * The mode »auto« will cause the script to detect the user's browser information
  * The mode »auto« will cause the script to detect the user's browser information

- * and offer a matching language, and use »en« if it is not available.
+ * and offer a matching language, or use »en« if it is not available.
+ * Forcing a specific lang will slightly reduce computation time.

  */
 $cfg['lang'] = 'auto';
 
 /* Select a theme - see media folder for available themes
  */
 $cfg['style'] = 'courgette';
  */
 $cfg['lang'] = 'auto';
 
 /* Select a theme - see media folder for available themes
  */
 $cfg['style'] = 'courgette';

+$cfg['dark_style'] = 'dark-courgette';

 
 /* Name the organisation running this installation, eg. 'ACME'
  */
 
 /* Name the organisation running this installation, eg. 'ACME'
  */


@@ -69,7 +71,7 @@ $cfg['enable_crypt'] = false;
 $cfg['link_name_length'] = 8;
 
 /* Upload password(s).
 $cfg['link_name_length'] = 8;
 
 /* Upload password(s).

- * An empty array will disable the password authentification.
+ * An empty array will disable password authentication.

  * $cfg['upload_password'] = array();               // No password
  * $cfg['upload_password'] = array('psw1');         // One password
  * $cfg['upload_password'] = array('psw1', 'psw2'); // Two passwords
  * $cfg['upload_password'] = array();               // No password
  * $cfg['upload_password'] = array('psw1');         // One password
  * $cfg['upload_password'] = array('psw1', 'psw2'); // Two passwords


@@ -85,7 +87,6 @@ $cfg['upload_password'] = array();
 $cfg['upload_ip'] = array();
 
 /* List of IP allowed to upload a file without password.
 $cfg['upload_ip'] = array();
 
 /* List of IP allowed to upload a file without password.

- * If the list is empty, then there is no upload restriction based on IP.

  * Elements of the list can be a single IP (e.g. "123.45.67.89") or
  * an IP range (e.g. "123.45.0.0/16").
  * Note that CIDR notation is available for IPv4 only for the moment.
  * Elements of the list can be a single IP (e.g. "123.45.67.89") or
  * an IP range (e.g. "123.45.0.0/16").
  * Note that CIDR notation is available for IPv4 only for the moment.


@@ -93,8 +94,9 @@ $cfg['upload_ip'] = array();
 $cfg['upload_ip_nopassword'] = array();
 
 /* Password for the admin interface.
 $cfg['upload_ip_nopassword'] = array();
 
 /* Password for the admin interface.

- * An empty password will disable the password authentification.
+ * An empty password will disable password authentication.

  * The password is a sha256 hash of the original version.
  * The password is a sha256 hash of the original version.

+ * Example: echo -n "myVerySecretAdminPassword" | sha256sum

  */
 $cfg['admin_password'] = '';
 
  */
 $cfg['admin_password'] = '';
 


@@ -112,8 +114,9 @@ $cfg['admin_http_auth_user'] = '';
  * 'hour': file available for one hour
  * 'day': file available for one day
  * 'week': file available for one week
  * 'hour': file available for one hour
  * 'day': file available for one day
  * 'week': file available for one week

+ * 'fortnight': file is available for two weeks

  * 'month': file is available for one month
  * 'month': file is available for one month

- * 'quarter': file is available for three month
+ * 'quarter': file is available for three months

  * 'year': file available for one year
  * 'none': unlimited availability
  */
  * 'year': file available for one year
  * 'none': unlimited availability
  */


@@ -122,6 +125,7 @@ $cfg['availabilities'] = array(
     'hour' => true,
     'day' => true,
     'week' => true,
     'hour' => true,
     'day' => true,
     'week' => true,

+    'fortnight' => true,

     'month' => true,
     'quarter' => false,
     'year' => false,
     'month' => true,
     'quarter' => false,
     'year' => false,


@@ -133,6 +137,11 @@ $cfg['availabilities'] = array(
  */
 $cfg['availability_default'] = 'month';
 
  */
 $cfg['availability_default'] = 'month';
 

+/* Give the uploading user the option to have the file
+ * deleted after the first download.
+ */
+$cfg['one_time_download'] = true;
+

 /* Set maximal upload size expressed in MB.
  * »0« means unlimited upload size.
  */
 /* Set maximal upload size expressed in MB.
  * »0« means unlimited upload size.
  */


@@ -147,7 +156,69 @@ $cfg['maximal_upload_size'] = 0;
  */
 $cfg['proxy_ip'] = array();
 
  */
 $cfg['proxy_ip'] = array();
 

+/* File hash
+ * In order to make file deduplication work, files can be hashed through different methods.
+ * To enable file deduplication feature, set this option to `md5`.
+ *
+ * Possible values are 'md5', 'md5_outside' and 'random'.
+ *
+ * With 'md5' option, the whole file is hashed through md5. This is the default.
+ * With 'md5_outside', hash is computed using:
+ *  - md5 of the first part of the file,
+ *  - md5 of the last part of the file and
+ *  - file's size.
+ * This method offer file deduplication at minimal cost but can be dangerous as files with the same partial hash can be mistaken.
+ * With 'random' option, file hash is set to a random value and file deduplication cannot work but it is fast and safe.
+ */
+$cfg['file_hash'] = 'random';
+
+/* Work around that LiteSpeed truncates large files when downloading.
+ * Only for use with the LiteSpeed web server!
+ * An internal redirect is made using X-LiteSpeed-Location instead
+ * of streaming the file from PHP.
+ * Limitations:
+ *  - The Jirafeau files folder has to be placed under the document root and should be
+ *    protected from unauthorized access using rewrite rules.
+ *    See https://www.litespeedtech.com/support/wiki/doku.php/litespeed_wiki:config:internal-redirect#protection_from_direct_access
+ *  - Incompatible with server side encryption.
+ *  - Incompatible with one time download.
+ */
+$cfg['litespeed_workaround'] = false;
+
+/* Use the X-Sendfile header which should cause your webserver to handle
+ * the sending of the file. The webserver must be configured to do this
+ * using the mod_xsendfile module in Apache or the appropriate config in
+ * lighttpd. The offload will not happen in the case of server-side encrypted
+ * files, but all other cases should work. Benefits include being able
+ * to resume downloads and seek instantly in media players like VLC or
+ * the Firefox/Discord/Chrome embedded player.
+ */
+$cfg['use_xsendfile'] = false;
+
+/* Store uploader's IP along with 'link' file.
+ * Depending of your legislation, you may have to adjust this parameter.
+ */
+$cfg['store_uploader_ip'] = true;
+

 /* Required flag to test if the installation is already installed
  * or needs to start the installation script
  */
 $cfg['installation_done'] = false;
 /* Required flag to test if the installation is already installed
  * or needs to start the installation script
  */
 $cfg['installation_done'] = false;

+
+/* Enable this debug flag to allow eventual PHP error reporting.
+ * This is disabled by default permission misconfiguration might generate warnings or errors.
+ * Those warnings can break Jirafeau and also show path to var- folder in debug messages.
+ * var- folder should kept secret and accessing it may lead to data leak if unprotected.
+ */
+$cfg['debug'] = false;
+
+/** Set Jirafeau's maximal upload chunk
+ * When Jirafeau upload a large file, Jirafeau sends several data chunks to fit server's capabilities.
+ * Jirafeau tries to upload each data chunk with the maximal size allowed by PHP (post_max_size and upload_max_filesize).
+ * However, too large PHP configuration values are not needed and could induce unwanted side effects (see #303).
+ * This parameter set Jirafeau's own maximal chunk size with a reasonable value.
+ * Option is only used for async uploads and won't be used for browsers without html5 support.
+ * You should not touch this parameter unless you have good reason to do so. Feel free to open an issue to ask questions.
+ * Set to 0 to remove limitation.
+ */
+$cfg['max_upload_chunk_size_bytes'] = 100000000; // 100MB