X-Git-Url: https://git.p6c8.net/jirafeau_project.git/blobdiff_plain/19047d45c1ce27cd5f3e4c4d3a1dfdd384bf8f0d..a4111660b05af9df96bbe567aa43acff34b6339d:/lib/config.original.php diff --git a/lib/config.original.php b/lib/config.original.php index 716675e..c666d03 100644 --- a/lib/config.original.php +++ b/lib/config.original.php @@ -2,6 +2,7 @@ /* * Jirafeau, your web file repository * Copyright (C) 2008 Julien "axolotl" BERNARD + * Copyright (C) 2015 Jerome Jutteau * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as @@ -14,54 +15,236 @@ * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License - * along with this program. If not, see . + * along with this program. If not, see . */ - -/* - * default configuration - * if you want to change this, overwrite in a config.local.php file + +/** + * Default configuration + * + * To overwrite these settings copy the file, + * rename it to »config.local.php« and adapt the parameters. + **/ + +/* URL of installation, with trailing slash (eg. »https://example.com/jirafeau/«) */ - global $cfg; - -/* don't forget the ending '/' */ $cfg['web_root'] = ''; + +/* Path to data directory, with trailing slash (eg. »/var/www/data/var_314159265358979323846264« + */ $cfg['var_root'] = ''; -/* Lang choice between 'auto', 'en' and 'fr'. - 'auto' mode will take the user's browser informations. Will take english if - user's langage is not available. +/* 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 + * 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'; -$cfg['style'] = 'modern'; -$cfg['rewrite'] = false; -/* An empty admin password will disable the admin interface. */ -$cfg['admin_password'] = ''; -/* preview: false (will download file) or true (will preview in browser if - * possible) . */ + +/* 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' + */ +$cfg['organisation'] = 'ACME'; + +/* Provide a contact person for this installation, eg. 'John Doe ' + */ +$cfg['contactperson'] = ''; + +/* Give the installation a title, eg. 'Datahub' or 'John Doe Filehost' + */ +$cfg['title'] = ''; + +/* Propose a preview link if file type is previewable + */ $cfg['preview'] = true; -/* Download page: - * true: Will show a download page (with preview if permited and possible). - * false: Will directly download file or preview (if permited and possible). */ -$cfg['download_page'] = false; -/* Block feature: - The scripting interface can propose to create, read, write, delete blocks - of data. */ -$cfg['enable_blocks'] = false; -/* Encryption feature. disable it by default. - * By enabling it, file-level deduplication won't work. */ + +/* Enable the encryption feature + * By enabling it, file-level deduplication won't work anymore. See FAQ. + */ $cfg['enable_crypt'] = false; -/* Split lenght of link refenrece. */ -$cfg['link_name_lenght'] = 8; -/* Upload password. Empty string disable the password. */ -$cfg['upload_password'] = ''; -/* Installation is done ? */ +/* Length of link reference + */ +$cfg['link_name_length'] = 8; + +/* Upload password(s). + * 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(); + +/* List of IP allowed to upload a file. + * 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. + */ +$cfg['upload_ip'] = array(); + +/* List of IP allowed to upload a file without password. + * 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. + */ +$cfg['upload_ip_nopassword'] = array(); + +/* Password for the admin interface. + * An empty password will disable password authentication. + * The password is a sha256 hash of the original version. + * Example: echo -n "myVerySecretAdminPassword" | sha256sum + */ +$cfg['admin_password'] = ''; + +/* If set, let the user be authenticated as administrator. + * The user provided here is the user authenticated by HTTP authentication. + * Note that Jirafeau does not manage the HTTP login part, it just checks + * that the provided user is logged in. + * If »admin_password« parameter is set, then the »admin_password« is ignored. + */ +$cfg['admin_http_auth_user'] = ''; + +/* Allow user to select different options for file expiration time. + * Possible values in array: + * 'minute': file is available for one minute + * '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 + * 'quarter': file is available for three months + * 'year': file available for one year + * 'none': unlimited availability + */ +$cfg['availabilities'] = array( + 'minute' => true, + 'hour' => true, + 'day' => true, + 'week' => true, + 'fortnight' => true, + 'month' => true, + 'quarter' => false, + 'year' => false, + 'none' => false +); + +/* Set a default value for the expiration time. + * The value has to equal one of the enabled options in »availabilities«, e.g. »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. + */ +$cfg['maximal_upload_size'] = 0; + +/* Proxy IP + * If the installation is behind some reverse proxies, it is possible to set + * the allowed proxy IP. + * $cfg['proxy_ip'] = array('12.34.56.78'); + * Jirafeau will then get a visitor's IP from HTTP_X_FORWARDED_FOR + * instead of REMOTE_ADDR. + */ +$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; -if ((basename (__FILE__) != 'config.local.php') - && file_exists (JIRAFEAU_ROOT.'lib/config.local.php')) -{ - require (JIRAFEAU_ROOT.'lib/config.local.php'); -} +/* 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 -?> +/* Set password requirement policy for downloading files + * Possible values: + * optional (default): Password may be set by the uploader, but is not mandatory + * required: Setting a password is mandatory to upload a file. + * generated: Passwords are automatically generated and shown to the uploader, when uploading a file + */ +$cfg['download_password_requirement'] = 'optional'; + +/* Set length of generated passwords + */ +$cfg['download_password_gen_len'] = 10; + +/* Set allowed chars for password generation + */ +$cfg['download_password_gen_chars'] = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#$%&*()_-=+;:,.?'; +/* Set password complexity policy for downloading files + * possible values: + * none (default): Passwords for downloading files can be of arbitrary complexity + * regex: Passwords are checked with a regex for complexity constraints + */ +$cfg['download_password_policy'] = 'none'; +/* Set the regex for regex download password policy + * Delimiters are need, but modifiers should not be used + */ +$cfg['download_password_policy_regex'] = '/.*/';