ownCloud uses the
config/config.php file to control server operations.
config/config.sample.php lists all the configurable parameters within
ownCloud, along with example or default values. This document provides a
more detailed reference. Most options are configurable on your Admin
page, so it is usually not necessary to edit
The installer creates a configuration containing the essential parameters.
Only manually add configuration parameters to
ownCloud supports loading configuration parameters from multiple files. You can add arbitrary files ending with .config.php in the config/ directory, for example you could place your email server configuration in email.config.php. This allows you to easily create and manage custom configurations, or to divide a large complex configuration file into a set of smaller files. These custom files are not overwritten by ownCloud, and the values in these files take precedence over config.php.
These parameters are configured by the ownCloud installer, and are required for your ownCloud server to operate.
automatically by the installer. This example is for documentation only,
and you should never use it because it will not work. A valid
is created when you install ownCloud. Needs to start with a letter.
'instanceid' ⇒ 'd3c944a9a',
installer. (There are also per-user salts.) If you lose this salt you lose all your passwords. This example is for documentation only, and you should never use it.
domains prevents host header poisoning. Do not remove this, as it performs
necessary security checks. Please consider that for backend processes like
background jobs or occ commands, the url parameter in key
is used. For more details please see that key.
requests from the listed domains.
directory. The SQLite database is also stored here, when you use SQLite.
(SQLite is not available in ownCloud Enterprise Edition)
during installation and update, so you shouldn’t need to change it.
can be a legitimate step. Please consult the documentation before enabling this.
Available: - sqlite (SQLite3 - Not in Enterprise Edition) - mysql (MySQL/MariaDB) - pgsql (PostgreSQL) - oci (Oracle - Enterprise Edition Only)
hostname.example.com, or the IP address. To specify a port use
hostname:##; to specify a Unix socket use
should not need to change this.
across ownCloud instances using the same SQL database. This is set up during installation, so you shouldn’t need to change it.
you shouldn’t need to change it.
These optional parameters control some aspects of the user interface. Default values, where present, are shown.
language codes such as
en for English,
de for German, and
French. It overrides automatic language detection on public pages like login
or shared items. User’s language preferences configured under "personal →
language" override this setting after they have logged in.
URL after clicking them in the Apps menu, such as documents, calendar, and gallery. You can use a comma-separated list of app names, so if the first app is not enabled for a user then ownCloud will try the second one, and so on. If no enabled apps are found it defaults to the Files app.
ownCloud Web interface).
false removes the help item.
page, on user’s Personal pages and are used by some apps (contacts, mail,
false disables them.
false prevents them from changing their display names.
remember checkbox on the login screen. The default is 15 days, expressed
expressed in seconds.
Enabling this sends a "heartbeat" to the server to keep it from timing out.
If enabled, all access requests using the users password are blocked for enhanced security. Users have to generate special app-passwords (tokens) for their apps or clients in their personal settings which are further used for app or client authentication. Browser logon is not affected.
'login.alternatives' => [ ['href' => 'https://www.testshib.org/Shibboleth.sso/ProtectNetwork?target=https%3A%2F%2Fmy.owncloud.tld%2Flogin%2Fsso-saml%2F', 'name' => 'ProtectNetwork', 'img' => '/img/PN_sign-in.gif'], ['href' => 'https://www.testshib.org/Shibboleth.sso/OpenIdP.org?target=https%3A%2F%2Fmy.owncloud.tld%2Flogin%2Fsso-saml%2F', 'name' => 'OpenIdP.org', 'img' => '/img/openidp.png'], ]
In some specific setups CSRF protection is handled in the environment, e.g., running F5 ASM. In these cases the built-in mechanism is not needed and can be disabled. Generally speaking, however, this config switch should be left unchanged.
|leave this as is if you’re not sure what it does|
copied to the data directory of new users. Leave empty to not copy any skeleton files.
configure alternate authentication backends. Supported backends are: IMAP (OC_User_IMAP), SMB (OC_User_SMB), and FTP (OC_User_FTP).
user backend like LDAP), you can specify a custom link, where the user is redirected to, when clicking the "reset password" link after a failed login-attempt.
In case you do not want to provide any link, replace the url with 'disabled'
and other search terms. Allows finding 'Alice' when searching for 'lic'.
May slow down user search. Disable this if you encounter slow username search in the sharing dialog.
users or groups in the share autocomplete form. Lower values increase search time especially for large backends.
Any exact matches to a user or group will be returned, even though less than the minimum characters have been entered. The search is case insensitive. e.g. entering "tom" will always return "Tom" if there is an exact match.
These configure the email settings for ownCloud notifications and password resets.
firstname.lastname@example.org, substituting your own domain, of course.
lostpassword-noreply FROM addresses.
If you are using local or remote SMTP, set this to
If you are using PHP mail you must have an installed and working email system
on the server. The program used to send email is defined in the
sendmail option you need an installed and working email system on
the server, with
/usr/sbin/sendmail installed on your Unix system.
qmail the binary is /var/qmail/bin/sendmail, and it must be installed
on your Unix system.
server host. This may contain multiple hosts separated by a semi-colon. If
you need to specify the port number append it to the IP address separated by
a colon, like this:
You may need to increase this if you are running an anti-malware or spam scanner.
tls, or leave empty for no encryption.
server requires authentication.
the authentication type as
LOGIN (default) or
the SMTP server.
proxy and CLI/cron situations. This option allows you to manually override
the automatic detection; for example
www.example.com, or specify the port
http. However, if ownCloud is behind a proxy
and the proxy handles the
https calls, ownCloud would not know that
ssl is in use, which would result in incorrect URLs being generated.
Valid values are
For example, if
www.example.com/owncloud is the URL pointing to the
ownCloud instance, the webroot is
/owncloud. When proxies are in use, it
may be difficult for ownCloud to detect this parameter, resulting in invalid
expression for the remote IP address. The keys
overwritehost are subject to this condition.
For example, defining a range of IP addresses starting with
and ending with 1 to 3: *
are generated within ownCloud using any kind of command line tools (cron or
occ). The value should contain the full base URL:
As an example, alerts shown in the browser to upgrade an app are triggered by
a cron background process and therefore uses the url of this key, even if the user
has logged on via a different domain defined in key
trusted_domains. When the
user clicks an alert like this, he will be redirected to that URL and must logon again.
This parameter will be written as
RewriteBase on update and installation of
ownCloud to your
.htaccess file. While this value is often simply the URL
path of the ownCloud installation it cannot be set automatically properly in
every scenario and needs thus some manual configuration.
In a standard Apache setup this usually equals the folder that ownCloud is
accessible at. So if ownCloud is accessible via
the correct value would most likely be
/owncloud. If ownCloud is running
https://mycloud.org/ then it would be
Note that the above rule is not valid in every case, as there are some rare setup cases where this may not apply. However, to avoid any update problems this configuration value is explicitly opt-in.
After setting this value run
occ maintenance:update:htaccess. Now, when the
following conditions are met ownCloud URLs won’t contain
These parameters control the Deleted files app.
for when files and folders in the trash bin will be permanently deleted.
The app allows for two settings, a minimum time for trash bin retention,
and a maximum time for trash bin retention.
Minimum time is the number of days a file will be kept, after which it
may be deleted. Maximum time is the number of days at which it is guaranteed
to be deleted.
Both minimum and maximum times can be set together to explicitly define
file and folder deletion. For migration purposes, this setting is installed
initially set to
auto, which is equivalent to the default setting in
ownCloud 8.1 and before.
autodefault setting. Keeps files and folders in the deleted files for up to 30 days, automatically deleting them (at any time) if space is needed. Note: files may not be removed if space is not required.
D, autokeeps files and folders in the trash bin for D+ days, delete anytime if space needed (note: files may not be deleted if space is not needed)
auto, Ddelete all files in the trash bin that are older than D days automatically, delete other files anytime if space needed
D1, D2keep files and folders in the trash bin for at least D1 days and delete when exceeds D2 days
disabledtrash bin auto clean disabled, files and folders will be kept forever
These parameters control the Versions app.
for when versions will be permanently deleted.
The app allows for two settings, a minimum time for version retention, and a maximum time for version retention. Minimum time is the number of days a version will be kept, after which it may be deleted. Maximum time is the number of days at which it is guaranteed to be deleted. Both minimum and maximum times can be set together to explicitly define version deletion. For migration purposes, this setting is installed initially set to "auto", which is equivalent to the default setting in ownCloud 8.1 and before.
autodefault setting. Automatically expire versions according to expire rules. Please refer to :doc:`../configuration/files/file_versioning` for more information.
D, autokeep versions at least for D days, apply expire rules to all versions that are older than D days
auto, Ddelete all versions that are older than D days automatically, delete other versions according to expire rules
D1, D2keep versions for at least D1 days and delete when exceeds D2 days
disabledversions auto clean disabled, versions will be kept forever
ownCloud performs several verification checks. There are two options,
available. This option is only applicable to ownCloud core. It is not applicable to app updates.
by attempting to make a request from JS to https://your-domain.com/.well-known/caldav/
When this switch is set to
true ownCloud will not verify whether the
configuration is writable. However, it will not be possible to configure
all options via the Web interface. Furthermore, when updating ownCloud
it is required to make the configuration file writable again for the update
which means that ownCloud is running on a single node, which might be the most common operations mode. The only other possible value for now is 'clustered-instance' which means that ownCloud is running on at least 2 nodes. The mode of operations has various impact on the behavior of ownCloud.
These parameters configure the logging options. For additional information or advanced configuration, please see the logging section in the documentation.
default ownCloud data directory.
If syslogging is desired, set this parameter to
Setting this parameter to
errorlog will use the PHP error_log function
Warning, 3 = Error, and 4 = Fatal. The default value is Warning.
to distinguish between them.
syslog_tag can be set per instance
with a unique id. Only available if
log_type is set to
The default value is
In addition to the %replacements% below %level% can be used, but it is used as a dedicated parameter to the syslog logging facility anyway.
conditions is met, the required log level is set to debug. This allows to debug specific requests, users or apps
shared_secret: If a request parameter with the name
log_secret is set to
this value the condition is met
users: If the current request is done by one of the specified users,
this condition is met
apps: If the log message is invoked by one of the specified apps,
this condition is met
logfile: The log message invoked by the specified apps get redirected to
this logfile, this condition is met
Note: Not applicable when using syslog.
Defaults to an empty array.
'log.conditions' => [ [ 'shared_secret' => '57b58edb6637fe3059b3595cf9c41b9', 'users' => ['user1'], 'apps' => ['files_texteditor'], 'logfile' => '/tmp/test.log' ], [ 'shared_secret' => '57b58edb6637fe3059b3595cf9c41b9', 'users' => ['user1'], 'apps' => ['gallery'], 'logfile' => '/tmp/gallery.log' ], ],
This uses PHP.date formatting; see http://php.net/manual/en/function.date.php
The default is 0 or false which disables log rotation. Specify a size in bytes, for example 104857600 (100 megabytes = 100 * 1024 * 1024 bytes). A new logfile is created with a new name when the old logfile reaches the defined limit. If a rotated log file is already present, it will be overwritten. If enabled, only the active log file and one rotated file are stored.
Some of the ownCloud code may be stored in alternate locations.
/apps, you need to modify the
apps_paths key. There, you need to add a
new associative array that contains three elements. These are:
pathThe absolute file system path to the custom app folder.
urlThe request path to that folder relative to the ownCloud web root, prefixed with /.
writableWhether users can install apps in that folder. After the configuration is added, new apps will only install in a directory where writable is set to true.
The configuration example shows how to add a second directory, called
Here, new apps and updates are only written to the
This eases upgrade procedures of owncloud where shipped apps are delivered to apps/ by default.
OC::$SERVERROOT points to the web root of your instance.
Please see the Apps Management description on how to move custom apps properly.
ownCloud supports previews of image files, the covers of MP3 files, and text files. These options control enabling and disabling previews, and thumbnail size.
Covers of MP3 files
Valid values are
true, to enable previews, or
false, to disable previews
is no limit.
A value of
null means there is no limit.
preview system generates blurry previews, you might want to consider setting
a maximum scale factor. By default, pictures are upscaled to 10 times the
original size. A value of
null disables scaling.
If the image is bigger, it’ll try other preview generators, but will most likely show the default mimetype icon
Value represents the maximum filesize in megabytes Default is 50 Set to -1 for no limit
The following providers are enabled by default:
The following providers are disabled by default due to performance or privacy concerns:
note:: Troubleshooting steps for the MS Word previews are available at the :doc:`../configuration/files/collaborative_documents_configuration` section of the Administrators Manual.
The following providers are not available in Microsoft Windows:
Global settings for the Comments infrastructure
own or 3rdParty CommentsManager should be used that – for instance – uses the filesystem instead of the database to keep the comments.
These options are for halting user activity when you are performing server maintenance.
If you want to prevent users from logging in 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.
Available cache backends:
\OC\Memcache\APCuAPC user backend
\OC\Memcache\ArrayCacheIn-memory array-based backend (not recommended)
Advice on choosing between the various backends:
APCu should be easiest to install. Almost all distributions have packages. Use this for single user environment for all caches.
Use Redis or Memcached for distributed environments. For the local cache (you can configure two) take APCu.
Used for host-specific data, e.g. file paths
Used for installation-specific data, e.g. database caching
If unset, defaults to the value of memcache.local
For enhanced security it is recommended to configure Redis to require a password. See http://redis.io/topics/security for more information.
'redis' => [ 'host' => 'localhost', // can also be a unix domain socket: '/tmp/redis.sock' 'port' => 6379, 'timeout' => 0.0, 'password' => '', // Optional, if not defined no password will be used. 'dbindex' => 0, // Optional, if undefined SELECT will not run and will use Redis Server's default DB Index. ],
Only for use with Redis Clustering, for Sentinel-based setups use the single server configuration above, and perform HA on the hostname.
Redis Cluster support requires the php module phpredis in version 3.0.0 or higher.
Available failover modes: - \RedisCluster::FAILOVER_NONE - only send commands to primary nodes (default) - \RedisCluster::FAILOVER_ERROR - failover to replicas for read commands if primary is unavailable - \RedisCluster::FAILOVER_DISTRIBUTE - randomly distribute read commands across primary and replicas
Connection options for memcached, see http://apprize.info/php/scaling/15.html
'memcached_options' => array( // Set timeouts to 50ms \Memcached::OPT_CONNECT_TIMEOUT => 50, \Memcached::OPT_RETRY_TIMEOUT => 50, \Memcached::OPT_SEND_TIMEOUT => 50, \Memcached::OPT_RECV_TIMEOUT => 50, \Memcached::OPT_POLL_TIMEOUT => 50, // Enable compression \Memcached::OPT_COMPRESSION => true, // Turn on consistent hashing \Memcached::OPT_LIBKETAMA_COMPATIBLE => true, // Enable Binary Protocol \Memcached::OPT_BINARY_PROTOCOL => true, // Binary serializer will be enabled if the igbinary PECL module is available //\Memcached::OPT_SERIALIZER => \Memcached::SERIALIZER_IGBINARY, ),
$user is the current user. When specified, the format will change to
$cache_path is the configured cache directory
$user is the user.
garbage collection (in seconds). Increase this value if users have issues uploading very large files via the ownCloud Client as upload isn’t completed within one day.
Global settings for Sharing
own or 3rdParty Share Providers are used that – for instance – use the filesystem instead of the database to keep the share information.
encryption in MySQL or specify a custom wait timeout on a cheap hoster.
can be 'WAL' or 'DELETE' see for more details https://www.sqlite.org/wal.html
and MySQL can handle 4 byte characters instead of 3 byte characters.
If you want to convert an existing 3-byte setup into a 4-byte setup please
set the parameters in MySQL as mentioned below and run the migration command:
sudo -u www-data php occ db:convert-mysql-charset
The config setting will be set automatically after a successful run.
Consult the documentation for more details.
MySQL requires a special setup for longer indexes (> 767 bytes) which are needed:
[mysqld] innodb_large_prefix=ON innodb_file_format=Barracuda innodb_file_per_table=ON
Tables will be created with * character set: utf8mb4 * collation: utf8mb4_bin * row_format: compressed
See: https://dev.mysql.com/doc/refman/5.7/en/charset-unicode-utf8mb4.html https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_large_prefix https://mariadb.com/kb/en/mariadb/xtradbinnodb-server-system-variables/#innodb_large_prefix http://www.tocker.ca/benchmarking-innodb-page-compression-performance.html http://mechanics.flite.com/blog/2014/07/29/using-innodb-large-prefix-to-avoid-error-1071/
Available: - sqlite (SQLite3 - Not in Enterprise Edition) - mysql (MySQL) - pgsql (PostgreSQL) - oci (Oracle - Enterprise Edition Only)
the system temporary directory is on a limited space ramdisk or is otherwise restricted, or if external storages which do not support streaming are in use.
The Web server user must have write access to this directory.
Using a higher value requires more time and CPU power to calculate the hashes. As this number grows, the amount of work (typically CPU time or memory) necessary to compute the hash increases exponentially.
with this name.
.htaccess is blocked by default.
|USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING.|
using these names. Case insensitive.
Excluded directory names are queried at any path part like at the beginning, in the middle or at the end and will not be further processed if found. Please see the documentation for details and examples. Use when the storage backend supports eg snapshot directories to be excluded. WARNING: USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING.
ownCloud apps, this is particularly useful when creating ownCloud themes, because themes are treated as apps. The app is identified with it´s app-id.
The following example allows app-1 and theme-2 to have no signature.
AES-256-CFB are supported.
this server instance. All connections made from earlier clients will be denied by the server. Defaults to the minimum officially supported ownCloud version at the time of release of this server version.
When changing this, note that older unsupported versions of the ownCloud desktop client may not function as expected, and could lead to permanent data loss for clients or other unexpected results.
calculation, defaults to false.
NFS mounts in data/) is checked for changes made outside ownCloud. This does not apply to external storages.
→ Never check the filesystem for outside changes, provides a performance increase when it’s certain that no changes are made directly to the filesystem
→ Check each file or folder at most once per request, recommended for general use if outside changes might happen.
same storage as the upload target. Setting this to false will store the part files in the root of the users folder which might be required to work with certain external storage setups that have limited rename capabilities.
in the ownCloud directory.
filesystem for all storage.
lose this string there will be data corruption.
If you configure these also consider setting
otherwise defaults to
trusted_proxies. If the HTTP header looks like 'X-Forwarded-For', then use
If set incorrectly, a client can spoof their IP address as visible to ownCloud, bypassing access controls and making logs useless!
Defaults to 'HTTP_X_FORWARDED_FOR' if unset
If the gif is bigger, it’ll show a static preview
Value represents the maximum filesize in megabytes.
10. Set to
-1 for no limit.
This is enabled by default.
Prevents concurrent processes from accessing the same files at the same time. Can help prevent side effects that would be caused by concurrent operations. Mainly relevant for very large installations with many users working with shared files.
Any lock older than this will be automatically cleaned up. If not set this defaults to either 1 hour or the php max_execution_time, whichever is higher.
Because most memcache backends can clean values without warning using redis is highly recommended to avoid data loss.
Only enable this for local development and not in production environments This will disable the minifier and outputs some additional debug information
Be warned that, if you set this to
true, exceptions display stack traces on the web interface, including passwords, — in plain text!. We strongly encourage you never to use it in production.
This is a property used by the clients to find out if a backup has been restored on the server. Once a backup is restored run ./occ maintenance:data-fingerprint To set this to a new value.
Updating/Deleting this value can make connected clients stall until the user has resolved conflicts.
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.