aboutsummaryrefslogtreecommitdiffstats
path: root/config
diff options
context:
space:
mode:
authorChristoph Wurst <christoph@winzerhof-wurst.at>2023-05-10 09:05:28 +0200
committerChristoph Wurst <christoph@winzerhof-wurst.at>2023-05-10 09:05:28 +0200
commit00d6a6f514b80aac6bdf044cdf71251caff3f46b (patch)
tree2e4a618c590f1e8d0ec6bbe29f1a5dc1b5174b0d /config
parent90345ddc7da5fbf92a8afb31a8e8d51a3abda0a1 (diff)
downloadnextcloud-server-00d6a6f514b80aac6bdf044cdf71251caff3f46b.tar.gz
nextcloud-server-00d6a6f514b80aac6bdf044cdf71251caff3f46b.zip
doc(config): Rearrange sample config into appropriate sections
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
Diffstat (limited to 'config')
-rw-r--r--config/config.sample.php109
1 files changed, 56 insertions, 53 deletions
diff --git a/config/config.sample.php b/config/config.sample.php
index 892f84601e4..58d101a1e32 100644
--- a/config/config.sample.php
+++ b/config/config.sample.php
@@ -55,6 +55,12 @@ $CONFIG = [
'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
* necessary security checks.
@@ -223,17 +229,6 @@ $CONFIG = [
'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.
*/
@@ -246,6 +241,37 @@ $CONFIG = [
'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.
*
@@ -364,33 +390,6 @@ $CONFIG = [
'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
* user is redirected to, when clicking the "reset password" link after a failed
@@ -1068,6 +1067,17 @@ $CONFIG = [
*/
/**
+ * 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.
*
* Defaults to ``true``
@@ -1344,6 +1354,14 @@ $CONFIG = [
*/
'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
@@ -2036,12 +2054,6 @@ $CONFIG = [
'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
*
* You may set this to an array containing a combination of
@@ -2257,15 +2269,6 @@ $CONFIG = [
'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
*
* If enabled the timings of common execution steps will be logged to the