generate documentation from config.sample.php

This commit is contained in:
Nextcloud bot
2023-05-13 04:42:21 +00:00
parent 1496839693
commit f54b606dac

View File

@@ -57,6 +57,13 @@ 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.
::
'secret' => '',
Secret used by Nextcloud for various purposes, e.g. to encrypt data. If you
lose this string there will be data corruption.
::
'trusted_domains' =>
@@ -297,18 +304,6 @@ code.
Defaults to ``false``
::
'defaultapp' => 'dashboard,files',
Set the default app to open on login. Use the app names as they appear in the
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 Nextcloud will try the second one, and so
on. If no enabled apps are found it defaults to the dashboard app.
Defaults to ``dashboard,files``
::
'knowledgebaseenabled' => true,
@@ -323,6 +318,40 @@ Nextcloud Web interface). ``false`` removes the Help item.
``true`` allows users to change their display names (on their Personal
pages), and ``false`` prevents them from changing their display names.
::
'skeletondirectory' => '/path/to/nextcloud/core/skeleton',
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.
``{lang}`` can be used as a placeholder for the language of the user.
If the directory does not exist, it falls back to non dialect (from ``de_DE``
to ``de``). If that does not exist either, it falls back to ``default``
Defaults to ``core/skeleton`` in the Nextcloud directory.
::
'templatedirectory' => '/path/to/nextcloud/templates',
The directory where the template files are located. These files will be
copied to the template directory of new users. Leave empty to not copy any
template files.
``{lang}`` can be used as a placeholder for the language of the user.
If the directory does not exist, it falls back to non dialect (from ``de_DE``
to ``de``). If that does not exist either, it falls back to ``default``
If this is not set creating a template directory will only happen if no custom
``skeletondirectory`` is defined, otherwise the shipped templates will be used
to create a template directory for the user.
User session
------------
::
'remember_login_cookie_lifetime' => 60*60*24*15,
@@ -455,36 +484,6 @@ app is unavailable.
This will show an error. But the direct login still works with adding ?direct=1
::
'skeletondirectory' => '/path/to/nextcloud/core/skeleton',
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.
``{lang}`` can be used as a placeholder for the language of the user.
If the directory does not exist, it falls back to non dialect (from ``de_DE``
to ``de``). If that does not exist either, it falls back to ``default``
Defaults to ``core/skeleton`` in the Nextcloud directory.
::
'templatedirectory' => '/path/to/nextcloud/templates',
The directory where the template files are located. These files will be
copied to the template directory of new users. Leave empty to not copy any
template files.
``{lang}`` can be used as a placeholder for the language of the user.
If the directory does not exist, it falls back to non dialect (from ``de_DE``
to ``de``). If that does not exist either, it falls back to ``default``
If this is not set creating a template directory will only happen if no custom
``skeletondirectory`` is defined, otherwise the shipped templates will be used
to create a template directory for the user.
::
'lost_password_link' => 'https://example.org/link/to/password/reset',
@@ -1230,6 +1229,18 @@ Apps
Options for the Apps folder, Apps store, and App code checker.
::
'defaultapp' => 'dashboard,files',
Set the default app to open on login. Use the app names as they appear in the
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 Nextcloud will try the second one, and so
on. If no enabled apps are found it defaults to the dashboard app.
Defaults to ``dashboard,files``
::
'appstoreenabled' => true,
@@ -1546,6 +1557,16 @@ A value of 1 e.g. will only run these background jobs between 01:00am UTC and 05
Defaults to ``100`` which disables the feature
::
'ldap_log_file' => '',
Log all LDAP requests into a file
Warning: This heavily decreases the performance of the server and is only
meant to debug/profile the LDAP interaction manually.
Also, it might log sensitive data into a plain text file.
SSL
---
@@ -2297,13 +2318,6 @@ the filesystem for all storage.
Defaults to ``false``
::
'secret' => '',
Secret used by Nextcloud for various purposes, e.g. to encrypt data. If you
lose this string there will be data corruption.
::
'trusted_proxies' => ['203.0.113.45', '198.51.100.128', '192.168.2.0/24'],
@@ -2542,16 +2556,6 @@ Warning: This heavily decreases the performance of the server and is only
meant to debug/profile the redis interaction manually.
Also, it might log sensitive data into a plain text file.
::
'ldap_log_file' => '',
Log all LDAP requests into a file
Warning: This heavily decreases the performance of the server and is only
meant to debug/profile the LDAP interaction manually.
Also, it might log sensitive data into a plain text file.
::
'diagnostics.logging' => true,