Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc(config): Rearrange sample config into appropriate sections
Signed-off-by: Christoph Wurst <[email protected]>
  • Loading branch information
ChristophWurst committed May 10, 2023
commit 00d6a6f514b80aac6bdf044cdf71251caff3f46b
109 changes: 56 additions & 53 deletions config/config.sample.php
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,12 @@
*/
'passwordsalt' => '',

/**
* Secret used by Nextcloud for various purposes, e.g. to encrypt data. If you
* lose this string there will be data corruption.
*/
'secret' => '',

/**
* Your list of trusted domains that users can log into. Specifying trusted
* domains prevents host header poisoning. Do not remove this, as it performs
Expand Down Expand Up @@ -222,17 +228,6 @@
*/
'force_locale' => 'en_US',

/**
* 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``
*/
'defaultapp' => 'dashboard,files',

/**
* ``true`` enables the Help menu item in the user menu (top right of the
* Nextcloud Web interface). ``false`` removes the Help item.
Expand All @@ -245,6 +240,37 @@
*/
'allow_user_to_change_display_name' => 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.
* ``{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.
*/
'skeletondirectory' => '/path/to/nextcloud/core/skeleton',


/**
* 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.
*/
'templatedirectory' => '/path/to/nextcloud/templates',

/**
* User session
*/

/**
* Lifetime of the remember login cookie. This should be larger than the
* session_lifetime. If it is set to 0 remember me is disabled.
Expand Down Expand Up @@ -363,33 +389,6 @@
*/
'hide_login_form' => false,

/**
* 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.
*/
'skeletondirectory' => '/path/to/nextcloud/core/skeleton',


/**
* 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.
*/
'templatedirectory' => '/path/to/nextcloud/templates',

/**
* If your user backend does not allow password resets (e.g. when it's a
* read-only user backend like LDAP), you can specify a custom link, where the
Expand Down Expand Up @@ -1067,6 +1066,17 @@
* Options for the Apps folder, Apps store, and App code checker.
*/

/**
* 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``
*/
'defaultapp' => 'dashboard,files',

/**
* When enabled, admins may install apps from the Nextcloud app store.
*
Expand Down Expand Up @@ -1344,6 +1354,14 @@
*/
'maintenance_window_start' => 1,

/**
* 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.
*/
'ldap_log_file' => '',

/**
* SSL
Expand Down Expand Up @@ -2035,12 +2053,6 @@
*/
'filesystem_cache_readonly' => false,

/**
* Secret used by Nextcloud for various purposes, e.g. to encrypt data. If you
* lose this string there will be data corruption.
*/
'secret' => '',

/**
* List of trusted proxy servers
*
Expand Down Expand Up @@ -2256,15 +2268,6 @@
*/
'redis_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.
*/
'ldap_log_file' => '',

/**
* Enable diagnostics event logging
*
Expand Down