nextcloud/config/config.sample.php

756 lines
18 KiB
PHP
Executable File

<?php
/**
* This configuration file is only provided to document the different
* configuration options and their usage.
*
* DO NOT COMPLETELY BASE YOUR CONFIGURATION FILE ON THIS SAMPLE. THIS MAY BREAK
* YOUR INSTANCE. Instead, manually copy configurations switches that you
* consider important for your instance to your configuration.
*
* This file is used to generate the config documentation. Please consider
* following requirements of the current parser:
* * all comments need to start with `/**` and end with ` *\/` - each on their
* own line
* * add a `@see CONFIG_INDEX` to copy a previously described config option
* also to this line
* * everything between the ` *\/` and the next `/**` will be treated as the
* config option
*/
/**
* Only enable this for local development and not in productive environments
* This will disable the minifier and outputs some additional debug informations
*/
define('DEBUG', true);
$CONFIG = array(
/**
* Default Parameters
*
* These parameters are configured by the ownCloud installer, and are required
* for your ownCloud server to operate.
*/
/**
* This is a unique identifier for your ownCloud installation, created
* automatically by the installer.
*/
'instanceid' => '',
/**
* Define the salt used to hash the user passwords. All your user passwords are
* lost if you lose this string.
*/
'passwordsalt' => '',
/**
* List of trusted domains, to prevent host header poisoning ownCloud is only
* using these Host headers
*/
'trusted_domains' => array('demo.example.org', 'otherdomain.example.org:8080'),
/**
* The directory where the user data is stored, default to data in the ownCloud
* directory. The sqlite database is also stored here, when sqlite is used.
*/
'datadirectory' => '',
/**
* Type of database, can be sqlite, mysql or pgsql
*/
'dbtype' => 'sqlite',
/**
* Host running the ownCloud database. To specify a port use 'HOSTNAME:####'; to
* specify a unix sockets use 'localhost:/path/to/socket'.
*/
'dbhost' => '',
/**
* Name of the ownCloud database
*/
'dbname' => 'owncloud',
/**
* User to access the ownCloud database
*/
'dbuser' => '',
/**
* Password to access the ownCloud database
*/
'dbpassword' => '',
/**
* Prefix for the ownCloud tables in the database
*/
'dbtableprefix' => '',
/**
* Flag to indicate ownCloud is successfully installed (true = installed)
*/
'installed' => false,
/**
* User Experience
*
* These optional parameters control some aspects of the user interface. Default
* values, where present, are shown.
*/
/**
* Optional ownCloud default language - overrides automatic language detection
* on public pages like login or shared items. This has no effect on the user's
* language preference configured under 'personal -> language' once they have
* logged in
*/
'default_language' => 'en',
/**
* Default app to open on login.
*
* This can be a comma-separated list of app ids. If the first app is not
* enabled for the current user, it will try with the second one and so on. If
* no enabled app could be found, the 'files' app will be displayed instead.
*/
'defaultapp' => 'files',
/**
* Enable the help menu item in the settings
*/
'knowledgebaseenabled' => true,
/**
* Specifies whether avatars should be enabled
*/
'enable_avatars' => true,
/**
* Allow user to change his display name, if it is supported by the back-end
*/
'allow_user_to_change_display_name' => true,
/**
* Lifetime of the remember login cookie, default is 15 days
*/
'remember_login_cookie_lifetime' => 60*60*24*15,
/**
* Life time of a session after inactivity
*/
'session_lifetime' => 60 * 60 * 24,
/**
* Enable/disable session keep alive when a user is logged in in the Web UI.
* This is achieved by sending a 'heartbeat' to the server to prevent the
* session timing out.
*/
'session_keepalive' => true,
/**
* The directory where the skeleton files are located. These files will be
* copied to the data directory of new users. Leave empty to not copy any
* skeleton files.
*/
'skeletondirectory' => '',
/**
* TODO
*/
'user_backends' => array(
array(
'class' => 'OC_User_IMAP',
'arguments' => array('{imap.gmail.com:993/imap/ssl}INBOX')
)
),
/**
* Mail Parameters
*
* These configure the email settings for ownCloud notifications and password
* resets.
*/
/**
* Domain name used by ownCloud for the sender mail address, e.g.
* no-reply@example.com
*/
'mail_domain' => 'example.com',
/**
* FROM address used by ownCloud for the sender mail address, e.g.
* owncloud@example.com
*
* This setting overwrites the built in 'sharing-noreply' and
* 'lostpassword-noreply' FROM addresses, that ownCloud uses
*/
'mail_from_address' => 'owncloud',
/**
* Enable SMTP class debugging
*/
'mail_smtpdebug' => false,
/**
* Mode to use for sending mail, can be sendmail, smtp, qmail or php, see
* PHPMailer docs
*/
'mail_smtpmode' => 'sendmail',
/**
* Host to use for sending mail, depends on mail_smtpmode if this is used
*/
'mail_smtphost' => '127.0.0.1',
/**
* Port to use for sending mail, depends on mail_smtpmode if this is used
*/
'mail_smtpport' => 25,
/**
* SMTP server timeout in seconds for sending mail, depends on mail_smtpmode if
* this is used
*/
'mail_smtptimeout' => 10,
/**
* SMTP connection prefix or sending mail, depends on mail_smtpmode if this is
* used. Can be '', 'ssl' or 'tls'
*/
'mail_smtpsecure' => '',
/**
* Authentication needed to send mail, depends on mail_smtpmode if this is used
* (false = disable authentication)
*/
'mail_smtpauth' => false,
/**
* Authentication type needed to send mail, depends on mail_smtpmode if this is
* used Can be LOGIN (default), PLAIN or NTLM
*/
'mail_smtpauthtype' => 'LOGIN',
/**
* Username to use for sendmail mail, depends on mail_smtpauth if this is used
*/
'mail_smtpname' => '',
/**
* Password to use for sendmail mail, depends on mail_smtpauth if this is used
*/
'mail_smtppassword' => '',
/**
* Proxy Configurations
*/
/**
* The automatic hostname detection of ownCloud can fail in certain reverse
* proxy and CLI/cron situations. This option allows to manually override the
* automatic detection. You can also add a port. For example
* 'www.example.com:88'
*/
'overwritehost' => '',
/**
* The automatic protocol detection of ownCloud can fail in certain reverse
* proxy and CLI/cron situations. This option allows to manually override the
* protocol detection. For example 'https'
*/
'overwriteprotocol' => '',
/**
* The automatic webroot detection of ownCloud can fail in certain reverse proxy
* and CLI/cron situations. This option allows to manually override the
* automatic detection. For example '/domain.tld/ownCloud'. The value '/' can be
* used to remove the root.
*/
'overwritewebroot' => '',
/**
* The automatic detection of ownCloud can fail in certain reverse proxy and
* CLI/cron situations. This option allows to define a manually override
* condition as regular expression for the remote ip address. For example
* '^10\.0\.0\.[1-3]$'
*/
'overwritecondaddr' => '',
/**
* A proxy to use to connect to the internet. For example 'myproxy.org:88'
*/
'proxy' => '',
/**
* Deleted Items
*
* These parameters control the Deleted files app.
*/
/**
* How long should ownCloud keep deleted files in the trash bin, default value:
* 30 days
*/
'trashbin_retention_obligation' => 30,
/**
* Disable/Enable auto expire for the trash bin, by default auto expire is
* enabled
*/
'trashbin_auto_expire' => true,
/**
* ownCloud Verifications
*
* ownCloud performs several verification checks. There are two options, 'true'
* and 'false'.
*/
/**
* Ensure that 3rdparty applications follows coding guidelines
*/
'appcodechecker' => true,
/**
* Check if ownCloud is up to date and shows a notification if a new version is
* available
*/
'updatechecker' => true,
/**
* Are we connected to the internet or are we running in a closed network?
*/
'has_internet_connection' => true,
/**
* Check if the ownCloud WebDAV server is working correctly. Can be disabled if
* not needed in special situations
*/
'check_for_working_webdav' => true,
/**
* Check if .htaccess protection of data is working correctly. Can be disabled
* if not needed in special situations
*/
'check_for_working_htaccess' => true,
/**
* Logging
*/
/**
* Place to log to, can be 'owncloud' and 'syslog' (owncloud is log menu item in
* admin menu)
*/
'log_type' => 'owncloud',
/**
* File for the ownCloud logger to log to, (default is owncloud.log in the data
* dir)
*/
'logfile' => 'owncloud.log',
/**
* Loglevel to start logging at. 0 = DEBUG, 1 = INFO, 2 = WARN, 3 = ERROR
* (default is WARN)
*/
'loglevel' => 2,
/**
* date format to be used while writing to the ownCloud logfile
*/
'logdateformat' => 'F d, Y H:i:s',
/**
* timezone used while writing to the ownCloud logfile (default: UTC)
*/
'logtimezone' => 'Europe/Berlin',
/**
* Append all database queries and parameters to the log file. (watch out, this
* option can increase the size of your log file)
*/
'log_query' => false,
/**
* Whether ownCloud should log the last successfull cron exec
*/
'cron_log' => true,
/**
* Configure the size in bytes log rotation should happen, 0 or false disables
* the rotation. This rotates the current ownCloud logfile to a new name, this
* way the total log usage will stay limited and older entries are available for
* a while longer. The total disk usage is twice the configured size.
*
* WARNING: When you use this, the log entries will eventually be lost.
*
* Example: To set this to 100 MiB, use the value: 104857600 (1024*1024*100
* bytes).
*/
'log_rotate_size' => false,
/**
* Alternate Code Locations
*
* Some of the ownCloud code may be stored in alternate locations.
*/
/**
* Path to the parent directory of the 3rdparty directory
*/
'3rdpartyroot' => '',
/**
* URL to the parent directory of the 3rdparty directory, as seen by the browser
*/
'3rdpartyurl' => '',
/**
* links to custom clients
*/
'customclient_desktop' =>
'http://owncloud.org/sync-clients/',
'customclient_android' =>
'https://play.google.com/store/apps/details?id=com.owncloud.android',
'customclient_ios' =>
'https://itunes.apple.com/us/app/owncloud/id543672169?mt=8',
/**
* Apps
*
* Options for the Apps folder, Apps store, and App code checker.
*/
/**
* Enable installing apps from the appstore
*/
'appstoreenabled' => true,
/**
* URL of the appstore to use, server should understand OCS
*/
'appstoreurl' => 'https://api.owncloud.com/v1',
/**
* Set an array of path for your apps directories
*
* key 'path' is for the fs path and the key 'url' is for the http path to your
* applications paths. 'writable' indicates whether the user can install apps in
* this folder. You must have at least 1 app folder writable or you must set the
* parameter 'appstoreenabled' to false
*/
'apps_paths' => array(
array(
'path'=> '/var/www/owncloud/apps',
'url' => '/apps',
'writable' => true,
),
),
/**
* @see appcodechecker
*/
/**
* Previews
*
* ownCloud supports previews of image files, the covers of MP3 files, and text
* files. These options control enabling and disabling previews, and thumbnail
* size.
*/
/**
* TODO
*/
'enable_previews' => true,
/**
* the max width of a generated preview, if value is null, there is no limit
*/
'preview_max_x' => null,
/**
* the max height of a generated preview, if value is null, there is no limit
*/
'preview_max_y' => null,
/**
* the max factor to scale a preview, default is set to 10
*/
'preview_max_scale_factor' => 10,
/**
* custom path for libreoffice / openoffice binary
*/
'preview_libreoffice_path' => '/usr/bin/libreoffice',
/**
* cl parameters for libreoffice / openoffice
*/
'preview_office_cl_parameters' =>
' --headless --nologo --nofirststartwizard --invisible --norestore '.
'-convert-to pdf -outdir ',
/**
* Only register providers that have been explicitly enabled
*
* The following providers are enabled by default:
*
* - OC\Preview\Image
* - OC\Preview\MarkDown
* - OC\Preview\MP3
* - OC\Preview\TXT
*
* The following providers are disabled by default due to performance or privacy
* concerns:
*
* - OC\Preview\Illustrator
* - OC\Preview\Movies
* - OC\Preview\MSOffice2003
* - OC\Preview\MSOffice2007
* - OC\Preview\MSOfficeDoc
* - OC\Preview\OpenDocument
* - OC\Preview\PDF
* - OC\Preview\Photoshop
* - OC\Preview\Postscript
* - OC\Preview\StarOffice
* - OC\Preview\SVG
* - OC\Preview\TIFF
*/
'enabledPreviewProviders' => array(
'OC\Preview\Image',
'OC\Preview\MP3',
'OC\Preview\TXT',
'OC\Preview\MarkDown'
),
/**
* Maintenance
*
* These options are for halting user activity when you are performing server
* maintenance.
*/
/**
* Enable maintenance mode to disable ownCloud
*
* If you want to prevent users to login to ownCloud before you start doing some
* maintenance work, you need to set the value of the maintenance parameter to
* true. Please keep in mind that users who are already logged-in are kicked out
* of ownCloud instantly.
*/
'maintenance' => false,
/**
* whether usage of the instance should be restricted to admin users only
*/
'singleuser' => false,
/**
* SSL
*/
/**
* Force use of HTTPS connection (true = use HTTPS)
*/
'forcessl' => false,
/**
* Extra SSL options to be used for configuration
*/
'openssl' => array(
'config' => '/absolute/location/of/openssl.cnf',
),
/**
* Miscellaneous
*/
/**
* Blacklist a specific file and disallow the upload of files with this name
* WARNING: USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING.
*/
'blacklisted_files' => array('.htaccess'),
/**
* define default folder for shared files and folders
*/
'share_folder' => '/',
/**
* Theme to use for ownCloud
*/
'theme' => '',
/**
* Enable/disable X-Frame-Restriction
*
* HIGH SECURITY RISK IF DISABLED
*/
'xframe_restriction' => true,
/**
* default cipher used for file encryption, currently we support AES-128-CFB and
* AES-256-CFB
*/
'cipher' => 'AES-256-CFB',
/**
* memcached servers (Only used when xCache, APC and APCu are absent.)
*/
'memcached_servers' => array(
// hostname, port and optional weight. Also see:
// http://www.php.net/manual/en/memcached.addservers.php
// http://www.php.net/manual/en/memcached.addserver.php
array('localhost', 11211),
//array('other.host.local', 11211),
),
/**
* Location of the cache folder, defaults to 'data/$user/cache' where '$user' is
* the current user.
*
* When specified, the format will change to '$cache_path/$user' where
* '$cache_path' is the configured cache directory and '$user' is the user.
*/
'cache_path' => '',
/**
* EXPERIMENTAL: option whether to include external storage in quota
* calculation, defaults to false
*/
'quota_include_external_storage' => false,
/**
* specifies how often the filesystem is checked for changes made outside
* ownCloud
*
* 0 -> never check the filesystem for outside changes, provides a performance
* increase when it's certain that no changes are made directly to the
* filesystem
*
* 1 -> check each file or folder at most once per request, recommended for
* general use if outside changes might happen
*
* 2 -> check every time the filesystem is used, causes a performance hit when
* using external storages, not recommended for regular use
*/
'filesystem_check_changes' => 1,
/**
* where mount.json file should be stored
*/
'mount_file' => 'data/mount.json',
/**
* If true, prevent ownCloud from changing the cache due to changes in the
* filesystem for all storage
*/
'filesystem_cache_readonly' => false,
/**
* The example below shows how to configure ownCloud to store all files in a
* swift object storage
*
* It is important to note that ownCloud in object store mode will expect
* exclusive access to the object store container because it only stores the
* binary data for each file. The metadata is currently kept in the local
* database for performance reasons.
*
* WARNING: The current implementation is incompatible with any app that uses
* direct file IO and circumvents our virtual filesystem. That includes
* Encryption and Gallery. Gallery will store thumbnails directly in the
* filesystem and encryption will cause severe overhead because key files need
* to be fetched in addition to any requested file.
*
* One way to test is applying for a trystack account at http://trystack.org/
*/
'objectstore' => array(
'class' => 'OC\\Files\\ObjectStore\\Swift',
'arguments' => array(
// trystack will user your facebook id as the user name
'username' => 'facebook100000123456789',
// in the trystack dashboard go to user -> settings -> API Password to
// generate a password
'password' => 'Secr3tPaSSWoRdt7',
// must already exist in the objectstore, name can be different
'container' => 'owncloud',
// create the container if it does not exist. default is false
'autocreate' => true,
// required, dev-/trystack defaults to 'RegionOne'
'region' => 'RegionOne',
// The Identity / Keystone endpoint
'url' => 'http://8.21.28.222:5000/v2.0',
// required on dev-/trystack
'tenantName' => 'facebook100000123456789',
// dev-/trystack uses swift by default, the lib defaults to 'cloudFiles'
// if omitted
'serviceName' => 'swift',
),
),
/**
* Custom CSP policy, changing this will overwrite the standard policy
*/
'custom_csp_policy' =>
"default-src 'self'; script-src 'self' 'unsafe-eval'; ".
"style-src 'self' 'unsafe-inline'; frame-src *; img-src *; ".
"font-src 'self' data:; media-src *",
/**
* Forgotten ones
*/
/**
* Secret used by ownCloud for various purposes, e.g. to encrypt data. If you
* lose this string there will be data corruption.
*/
'secret' => '',
/**
* The optional authentication for the proxy to use to connect to the internet.
* The format is: [username]:[password]
*/
'proxyuserpwd' => '',
/**
* List of trusted proxy servers
*/
'trusted_proxies' => array('203.0.113.45', '198.51.100.128'),
/**
* Headers that should be trusted as client IP address in combination with
* `trusted_proxies`
*/
'forwarded_for_headers' => array('HTTP_X_FORWARDED', 'HTTP_FORWARDED_FOR'),
/**
* This entry is just here to show a warning in case somebody copied the sample
* configuration. DO NOT ADD THIS SWITCH TO YOUR CONFIGURATION!
*
* If you, brave person, have read until here be aware that you should not
* modify *ANY* settings in this file without reading the documentation
*/
'copied_sample_config' => true,
/**
* all css and js files will be served by the web server statically in one js
* file and ons css file
*/
'asset-pipeline.enabled' => false,
);