khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-03 02:09:45 +07:00
Code Issues Packages Projects Releases Wiki Activity

generate documentation from config.sample.php

Browse Source
This commit is contained in:
Morris Jobke
2017-01-19 03:35:11 +01:00
parent e98be091f1
commit 058dcf39f5
1 changed files with 194 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

227
admin_manual/configuration_server/config_sample_php_parameters.rst
View File

@@ -78,8 +78,10 @@ You can specify:
'datadirectory' => '/var/www/nextcloud/data',
Where user files are stored; this defaults to ``data/`` in the Nextcloud
directory. The SQLite database is also stored here, when you use SQLite.
Where user files are stored. The SQLite database is also stored here, when
you use SQLite.
Default to ``data/`` in the Nextcloud directory.
::
@@ -99,7 +101,8 @@ Available:
- sqlite (SQLite3)
- mysql (MySQL/MariaDB)
- pgsql (PostgreSQL)
- oci (Oracle)
Defaults to ``sqlite``
::
@@ -138,6 +141,8 @@ you shouldn't need to change it.
Prefix for the Nextcloud tables in the database.
Default to ``oc_``
::
'installed' => false,
@@ -146,6 +151,8 @@ Indicates whether the Nextcloud instance was installed successfully; ``true``
indicates a successful installation, and ``false`` indicates an unsuccessful
installation.
Defaults to ``false``
.. DEFAULT_SECTION_END
.. Generated content above. Don't change this.
@@ -219,6 +226,8 @@ 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.
Defaults to ``en``
::
'defaultapp' => 'files',
@@ -229,6 +238,8 @@ gallery. You can use a comma-separated list of app names, so if the first
app is not enabled for a user then Nextcloud will try the second one, and so
on. If no enabled apps are found it defaults to the Files app.
Defaults to ``files``
::
'knowledgebaseenabled' => true,
@@ -244,6 +255,8 @@ Nextcloud Web interface). ``false`` removes the Help item.
page, on user's Personal pages and are used by some apps (contacts, mail,
etc). ``false`` disables them.
Defaults to ``true``
::
'allow_user_to_change_display_name' => true,
@@ -255,16 +268,18 @@ pages), and ``false`` prevents them from changing their display names.
'remember_login_cookie_lifetime' => 60*60*24*15,
Lifetime of the remember login cookie, which is set when the user clicks the
``remember`` checkbox on the login screen. The default is 15 days, expressed
in seconds.
Lifetime of the remember login cookie, which is set when the user clicks
the ``remember`` checkbox on the login screen.
Defaults to ``60*60*24*15`` seconds (15 days)
::
'session_lifetime' => 60 * 60 * 24,
The lifetime of a session after inactivity; the default is 24 hours,
expressed in seconds.
The lifetime of a session after inactivity.
Defaults to ``60*60*24`` seconds (24 hours)
::
@@ -274,6 +289,8 @@ Enable or disable session keep-alive when a user is logged in to the Web UI.
Enabling this sends a "heartbeat" to the server to keep it from timing out.
Defaults to ``true``
::
'token_auth_enforced' => false,
@@ -282,6 +299,8 @@ Enforce token authentication for clients, which blocks requests using the user
password for enhanced security. Users need to generate tokens in personal settings
which can be used as passwords on their clients.
Defaults to ``false``
::
'auth.bruteforce.protection.enabled' => true,
@@ -290,6 +309,8 @@ Whether the bruteforce protection shipped with Nextcloud should be enabled or no
Disabling this is discouraged for security reasons.
Defaults to ``true``
::
'skeletondirectory' => '/path/to/nextcloud/core/skeleton',
@@ -298,6 +319,8 @@ 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.
Defaults to ``core/skeleton`` in the Nextcloud directory.
::
'user_backends' => array(
@@ -342,12 +365,16 @@ of course.
FROM address that overrides the built-in ``sharing-noreply`` and
``lostpassword-noreply`` FROM addresses.
Defaults to different from addresses depending on the feature.
::
'mail_smtpdebug' => false,
Enable SMTP class debugging.
Defaults to ``false``
::
'mail_smtpmode' => 'sendmail',
@@ -367,6 +394,8 @@ the server, with ``/usr/sbin/sendmail`` installed on your Unix system.
For ``qmail`` the binary is /var/qmail/bin/sendmail, and it must be installed
on your Unix system.
Defaults to ``sendmail``
::
'mail_smtphost' => '127.0.0.1',
@@ -376,12 +405,16 @@ 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: ``127.0.0.1:24``.
Defaults to ``127.0.0.1``
::
'mail_smtpport' => 25,
This depends on ``mail_smtpmode``. Specify the port for sending mail.
Defaults to ``25``
::
'mail_smtptimeout' => 10,
@@ -390,6 +423,8 @@ This depends on ``mail_smtpmode``. This sets the SMTP server timeout, in
seconds. You may need to increase this if you are running an anti-malware or
spam scanner.
Defaults to ``10`` seconds
::
'mail_smtpsecure' => '',
@@ -397,6 +432,8 @@ spam scanner.
This depends on ``mail_smtpmode``. Specify when you are using ``ssl`` or
``tls``, or leave empty for no encryption.
Defaults to ``''`` (empty string)
::
'mail_smtpauth' => false,
@@ -404,12 +441,16 @@ This depends on ``mail_smtpmode``. Specify when you are using ``ssl`` or
This depends on ``mail_smtpmode``. Change this to ``true`` if your mail
server requires authentication.
Defaults to ``false``
::
'mail_smtpauthtype' => 'LOGIN',
This depends on ``mail_smtpmode``. If SMTP authentication is required, choose
the authentication type as ``LOGIN`` (default) or ``PLAIN``.
the authentication type as ``LOGIN`` or ``PLAIN``.
Defaults to ``LOGIN``
::
@@ -418,6 +459,8 @@ the authentication type as ``LOGIN`` (default) or ``PLAIN``.
This depends on ``mail_smtpauth``. Specify the username for authenticating to
the SMTP server.
Defaults to ``''`` (empty string)
::
'mail_smtppassword' => '',
@@ -425,6 +468,8 @@ the SMTP server.
This depends on ``mail_smtpauth``. Specify the password for authenticating to
the SMTP server.
Default to ``''`` (empty string)
Proxy Configurations
--------------------
@@ -469,6 +514,8 @@ expression for the remote IP address. For example, defining a range of IP
addresses starting with ``10.0.0.`` and ending with 1 to 3:
``^10\.0\.0\.[1-3]$``
Defaults to ``''`` (empty string)
::
'overwrite.cli.url' => '',
@@ -478,6 +525,8 @@ are generated within Nextcloud using any kind of command line tools (cron or
occ). The value should contain the full base URL:
``https://www.example.com/nextcloud``
Defaults to ``''`` (empty string)
::
'htaccess.RewriteBase' => '/',
@@ -504,6 +553,8 @@ conditions are met Nextcloud uses URLs without index.php in it:
- `mod_rewrite` is installed
- `mod_env` is installed
Defaults to ``''`` (empty string)
::
'htaccess.IgnoreFrontController' => false,
@@ -522,6 +573,8 @@ For example, try accessing resources by leaving out `index.php` in the URL.
The URL of your proxy server, for example ``proxy.example.com:8081``.
Defaults to ``''`` (empty string)
::
'proxyuserpwd' => '',
@@ -530,6 +583,8 @@ The optional authentication for the proxy to use to connect to the internet.
The format is: ``username:password``.
Defaults to ``''`` (empty string)
Deleted Items (trash bin)
-------------------------
@@ -571,6 +626,8 @@ Available values:
* ``disabled``
trash bin auto clean disabled, files and folders will be kept forever
Defaults to ``auto``
File versions
-------------
@@ -611,6 +668,8 @@ Available values:
* ``disabled``
versions auto clean disabled, versions will be kept forever
Defaults to ``auto``
Nextcloud Verifications
-----------------------
@@ -626,6 +685,8 @@ Checks an app before install whether it uses private APIs instead of the
proper public APIs. If this is set to true it will only allow to install or
enable apps that pass this check.
Defaults to ``false``
::
'updatechecker' => true,
@@ -633,12 +694,16 @@ enable apps that pass this check.
Check if Nextcloud is up-to-date and shows a notification if a new version is
available.
Defaults to ``true``
::
'updater.server.url' => 'https://updates.nextcloud.com/updater_server/',
URL that Nextcloud should use to look for updates
Defaults to ``https://updates.nextcloud.com/updater_server/``
::
'updater.release.channel' => 'stable',
@@ -647,7 +712,7 @@ The channel that Nextcloud should use to look for updates
Supported values:
- ``daily``
- ``beta`
- ``beta``
- ``stable``
- ``production``
@@ -657,6 +722,8 @@ Supported values:
Is Nextcloud connected to the Internet or running in a closed network?
Defaults to ``true``
::
'check_for_working_webdav' => true,
@@ -672,6 +739,8 @@ Allows Nextcloud to verify a working .well-known URL redirects. This is done
by attempting to make a request from JS to
https://your-domain.com/.well-known/caldav/
Defaults to ``true``
::
'check_for_working_htaccess' => true,
@@ -683,6 +752,8 @@ If it is not, then any options controlled by ``.htaccess``, such as large
file uploads, will not work. It also runs checks on the ``data/`` directory,
which verifies that it can't be accessed directly through the Web server.
Defaults to ``true``
::
'config_is_read_only' => false,
@@ -695,6 +766,8 @@ all options via the Web interface. Furthermore, when updating Nextcloud
it is required to make the configuration file writable again for the update
process.
Defaults to ``false``
Logging
-------
@@ -710,6 +783,8 @@ If syslogging is desired, set this parameter to ``syslog``.
Setting this parameter to ``errorlog`` will use the PHP error_log function
for logging.
Defaults to ``file``
::
'logfile' => '/var/log/nextcloud.log',
@@ -725,6 +800,8 @@ Defaults to ``[datadirectory]/nextcloud.log``
Loglevel to start logging at. Valid values are: 0 = Debug, 1 = Info, 2 =
Warning, 3 = Error, and 4 = Fatal. The default value is Warning.
Defaults to ``2``
::
'syslog_tag' => 'Nextcloud',
@@ -763,13 +840,17 @@ Defaults to an empty array.
This uses PHP.date formatting; see http://php.net/manual/en/function.date.php
Defaults to ``Y-m-d\TH:i:sO`` (ISO8601)
::
'logtimezone' => 'Europe/Berlin',
The default timezone for logfiles is UTC. You may change this; see
The timezone for logfiles. You may change this; see
http://php.net/manual/en/timezones.php
Defaults to ``UTC``
::
'log_query' => false,
@@ -783,6 +864,8 @@ debugging, as your logfile will become huge.
Log successful cron runs.
Defaults to ``true``
::
'log_rotate_size' => false,
@@ -793,6 +876,8 @@ or no rotation. Specify a size in bytes, for example 104857600 (100 megabytes
old logfile reaches your limit. If a rotated log file is already present, it
will be overwritten.
Defaults to ``0`` (no rotation)
Alternate Code Locations
------------------------
@@ -811,6 +896,11 @@ Some of the Nextcloud code may be stored in alternate locations.
This section is for configuring the download links for Nextcloud clients, as
seen in the first-run wizard and on Personal pages.
Defaults to
* Desktop client: ``https://nextcloud.com/install/#install-clients``
* Android client: ``https://play.google.com/store/apps/details?id=com.nextcloud.client``
* iOS client : ``https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8``
Apps
----
@@ -823,6 +913,8 @@ Options for the Apps folder, Apps store, and App code checker.
When enabled, admins may install apps from the Nextcloud app store.
Defaults to ``true``
::
'apps_paths' => array(
@@ -848,6 +940,8 @@ Checks an app before install whether it uses private APIs instead of the
proper public APIs. If this is set to true it will only allow to install or
enable apps that pass this check.
Defaults to ``false``
@@ -873,6 +967,8 @@ By default, Nextcloud can generate previews for the following filetypes:
Valid values are ``true``, to enable previews, or
``false``, to disable previews
Defaults to ``true``
::
'preview_max_x' => 2048,
@@ -880,6 +976,8 @@ Valid values are ``true``, to enable previews, or
The maximum width, in pixels, of a preview. A value of ``null`` means there
is no limit.
Defaults to ``2048``
::
'preview_max_y' => 2048,
@@ -887,6 +985,8 @@ is no limit.
The maximum height, in pixels, of a preview. A value of ``null`` means there
is no limit.
Defaults to ``2048``
::
'preview_max_scale_factor' => 10,
@@ -896,17 +996,17 @@ 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 ``1`` or ``null`` disables scaling.
Defaults to ``2``
::
'preview_max_filesize_image' => 50,
max file size for generating image previews with imagegd (default behaviour)
If the image is bigger, it'll try other preview generators,
but will most likely show the default mimetype icon
If the image is bigger, it'll try other preview generators, but will most
likely show the default mimetype icon. Set to -1 for no limit.
Value represents the maximum filesize in megabytes
Default is 50
Set to -1 for no limit
Defaults to ``50`` megabytes
::
@@ -914,6 +1014,8 @@ Set to -1 for no limit
custom path for LibreOffice/OpenOffice binary
Defaults to ``''`` (empty string)
::
'preview_office_cl_parameters' =>
@@ -922,6 +1024,8 @@ custom path for LibreOffice/OpenOffice binary
Use this if LibreOffice/OpenOffice requires additional arguments.
Defaults to ``''`` (empty string)
::
'enabledPreviewProviders' => array(
@@ -937,17 +1041,6 @@ Use this if LibreOffice/OpenOffice requires additional arguments.
Only register providers that have been explicitly enabled
The following providers are enabled by default:
- OC\\Preview\\PNG
- OC\\Preview\\JPEG
- OC\\Preview\\GIF
- OC\\Preview\\BMP
- OC\\Preview\\XBitmap
- OC\\Preview\\MarkDown
- OC\\Preview\\MP3
- OC\\Preview\\TXT
The following providers are disabled by default due to performance or privacy
concerns:
@@ -978,6 +1071,17 @@ The following providers are not available in Microsoft Windows:
- OC\\Preview\\OpenDocument
- OC\\Preview\\StarOffice
Defaults to the following providers:
- OC\\Preview\\BMP
- OC\\Preview\\GIF
- OC\\Preview\\JPEG
- OC\\Preview\\MarkDown
- OC\\Preview\\MP3
- OC\\Preview\\PNG
- OC\\Preview\\TXT
- OC\\Preview\\XBitmap
LDAP
----
@@ -994,6 +1098,8 @@ minutes. Setting it to 0 disables the feature.
See command line (occ) methods ``ldap:show-remnants`` and ``user:delete``
Defaults to ``51`` minutes
Comments
--------
@@ -1008,6 +1114,8 @@ Replaces the default Comments Manager Factory. This can be utilized if an
own or 3rdParty CommentsManager should be used that – for instance – uses the
filesystem instead of the database to keep the comments.
Defaults to ``\OC\Comments\ManagerFactory``
::
'systemtags.managerFactory' => '\OC\SystemTag\ManagerFactory',
@@ -1016,6 +1124,8 @@ Replaces the default System Tags Manager Factory. This can be utilized if an
own or 3rdParty SystemTagsManager should be used that – for instance – uses the
filesystem instead of the database to keep the comments.
Defaults to ``\OC\SystemTag\ManagerFactory``
Maintenance
-----------
@@ -1034,6 +1144,8 @@ 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 Nextcloud instantly.
Defaults to ``false``
::
'singleuser' => false,
@@ -1041,6 +1153,8 @@ are kicked out of Nextcloud instantly.
When set to ``true``, the Nextcloud instance will be unavailable for all
users who are not in the ``admin`` group.
Defaults to ``false``
SSL
---
@@ -1053,6 +1167,8 @@ SSL
Extra SSL options to be used for configuration.
Defaults to an empty array.
::
'enable_certificate_management' => false,
@@ -1086,6 +1202,8 @@ Memory caching backend for locally stored data
* Used for host-specific data, e.g. file paths
Defaults to ``none``
::
'memcache.distributed' => '\OC\Memcache\Memcached',
@@ -1095,6 +1213,8 @@ Memory caching backend for distributed data
* Used for installation-specific data, e.g. database caching
* If unset, defaults to the value of memcache.local
Defaults to ``none``
::
'redis' => array(
@@ -1157,15 +1277,19 @@ Location of the cache folder, defaults to ``data/$user/cache`` where
``$cache_path/$user`` where ``$cache_path`` is the configured cache directory
and ``$user`` is the user.
Defaults to ``''`` (empty string)
::
'cache_chunk_gc_ttl' => 86400, // 60*60*24 = 1 day
'cache_chunk_gc_ttl' => 60*60*24,
TTL of chunks located in the cache folder before they're removed by
garbage collection (in seconds). Increase this value if users have
issues uploading very large files via the Nextcloud Client as upload isn't
completed within one day.
Defaults to ``60*60*24`` (1 day)
Using Object Store with Nextcloud
---------------------------------
@@ -1230,6 +1354,8 @@ Replaces the default Share Provider Factory. This can be utilized if
own or 3rdParty Share Providers be used that – for instance – uses the
filesystem instead of the database to keep the share information.
Defaults to ``\OC\Share20\ProviderFactory``
All other configuration options
-------------------------------
@@ -1297,6 +1423,11 @@ Available:
- pgsql (PostgreSQL)
- oci (Oracle)
Defaults to the following databases:
- sqlite (SQLite3)
- mysql (MySQL)
- pgsql (PostgreSQL)
::
'tempdirectory' => '/tmp/nextcloudtemp',
@@ -1324,12 +1455,16 @@ with this name. ``.htaccess`` is blocked by default.
WARNING: USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING.
Defaults to ``array('.htaccess')``
::
'share_folder' => '/',
Define a default folder for shared files and folders other than root.
Defaults to ``/``
::
'theme' => '',
@@ -1338,6 +1473,8 @@ If you are applying a theme to Nextcloud, enter the name of the theme here.
The default location for themes is ``nextcloud/themes/``.
Defaults to the theming app which is shipped since Nextcloud 9
::
'cipher' => 'AES-256-CFB',
@@ -1358,6 +1495,8 @@ When changing this, note that older unsupported versions of the Nextcloud deskto
client may not function as expected, and could lead to permanent data loss for
clients or other unexpected results.
Defaults to ``2.0.0``
::
'quota_include_external_storage' => false,
@@ -1365,6 +1504,8 @@ clients or other unexpected results.
EXPERIMENTAL: option whether to include external storage in quota
calculation, defaults to false.
Defaults to ``false``
::
'filesystem_check_changes' => 0,
@@ -1380,6 +1521,8 @@ filesystem
1 -> Check each file or folder at most once per request, recommended for
general use if outside changes might happen.
Defaults to ``0``
::
'part_file_in_storage' => true,
@@ -1389,6 +1532,8 @@ 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.
Defaults to ``true``
::
'mount_file' => '/var/www/nextcloud/data/mount.json',
@@ -1396,6 +1541,8 @@ external storage setups that have limited rename capabilities.
Where ``mount.json`` file should be stored, defaults to ``data/mount.json``
in the Nextcloud directory.
Defaults to ``data/mount.json`` in the Nextcloud directory.
::
'filesystem_cache_readonly' => false,
@@ -1403,6 +1550,8 @@ in the Nextcloud directory.
When ``true``, prevent Nextcloud from changing the cache due to changes in
the filesystem for all storage.
Defaults to ``false``
::
'secret' => '',
@@ -1418,6 +1567,7 @@ List of trusted proxy servers
If you configure these also consider setting `forwarded_for_headers` which
otherwise defaults to `HTTP_X_FORWARDED_FOR` (the `X-Forwarded-For` header).
Defaults to an empty array.
::
@@ -1430,7 +1580,7 @@ Headers that should be trusted as client IP address in combination with
If set incorrectly, a client can spoof their IP address as visible to
Nextcloud, bypassing access controls and making logs useless!
Defaults to 'HTTP_X_FORWARED_FOR' if unset
Defaults to ``'HTTP_X_FORWARED_FOR'``
::
@@ -1440,8 +1590,10 @@ max file size for animating gifs on public-sharing-site.
If the gif is bigger, it'll show a static preview
Value represents the maximum filesize in megabytes. Default is ``10``. Set to
``-1`` for no limit.
Value represents the maximum filesize in megabytes. Set to ``-1`` for
no limit.
Defaults to ``10`` megabytes
::
@@ -1457,15 +1609,18 @@ be caused by concurrent operations. Mainly relevant for
very large installations with many users working with
shared files.
Defaults to ``true``
::
'filelocking.ttl' => 3600,
'filelocking.ttl' => 60*60,
Set the time-to-live for locks in secconds.
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.
Defaults to ``60*60`` seconds (1 hour) or the php
max_execution_time, whichever is higher.
::
@@ -1476,6 +1631,8 @@ Memory caching backend for file locking
Because most memcache backends can clean values without warning using redis
is highly recommended to *avoid data loss*.
Defaults to ``none``
::
'upgrade.disable-web' => false,
@@ -1491,6 +1648,8 @@ Set this Nextcloud instance to debugging mode
Only enable this for local development and not in production environments
This will disable the minifier and outputs some additional debug information
Defaults to ``false``
::
'data-fingerprint' => '',
@@ -1505,6 +1664,8 @@ To set this to a new value.
Updating/Deleting this value can make connected clients stall until
the user has resolved conflicts.
Defaults to ``''`` (empty string)
::
'copied_sample_config' => true,