Skip to content

Commit 3aa3d7f

Browse files
Merge pull request #38169 from nextcloud/doc/config/rearrange-sample-config
doc(config): Rearrange sample config into appropriate sections
2 parents b520a13 + 00d6a6f commit 3aa3d7f

1 file changed

Lines changed: 56 additions & 53 deletions

File tree

config/config.sample.php

Lines changed: 56 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@
5454
*/
5555
'passwordsalt' => '',
5656

57+
/**
58+
* Secret used by Nextcloud for various purposes, e.g. to encrypt data. If you
59+
* lose this string there will be data corruption.
60+
*/
61+
'secret' => '',
62+
5763
/**
5864
* Your list of trusted domains that users can log into. Specifying trusted
5965
* domains prevents host header poisoning. Do not remove this, as it performs
@@ -222,17 +228,6 @@
222228
*/
223229
'force_locale' => 'en_US',
224230

225-
/**
226-
* Set the default app to open on login. Use the app names as they appear in the
227-
* URL after clicking them in the Apps menu, such as documents, calendar, and
228-
* gallery. You can use a comma-separated list of app names, so if the first
229-
* app is not enabled for a user then Nextcloud will try the second one, and so
230-
* on. If no enabled apps are found it defaults to the dashboard app.
231-
*
232-
* Defaults to ``dashboard,files``
233-
*/
234-
'defaultapp' => 'dashboard,files',
235-
236231
/**
237232
* ``true`` enables the Help menu item in the user menu (top right of the
238233
* Nextcloud Web interface). ``false`` removes the Help item.
@@ -245,6 +240,37 @@
245240
*/
246241
'allow_user_to_change_display_name' => true,
247242

243+
/**
244+
* The directory where the skeleton files are located. These files will be
245+
* copied to the data directory of new users. Leave empty to not copy any
246+
* skeleton files.
247+
* ``{lang}`` can be used as a placeholder for the language of the user.
248+
* If the directory does not exist, it falls back to non dialect (from ``de_DE``
249+
* to ``de``). If that does not exist either, it falls back to ``default``
250+
*
251+
* Defaults to ``core/skeleton`` in the Nextcloud directory.
252+
*/
253+
'skeletondirectory' => '/path/to/nextcloud/core/skeleton',
254+
255+
256+
/**
257+
* The directory where the template files are located. These files will be
258+
* copied to the template directory of new users. Leave empty to not copy any
259+
* template files.
260+
* ``{lang}`` can be used as a placeholder for the language of the user.
261+
* If the directory does not exist, it falls back to non dialect (from ``de_DE``
262+
* to ``de``). If that does not exist either, it falls back to ``default``
263+
*
264+
* If this is not set creating a template directory will only happen if no custom
265+
* ``skeletondirectory`` is defined, otherwise the shipped templates will be used
266+
* to create a template directory for the user.
267+
*/
268+
'templatedirectory' => '/path/to/nextcloud/templates',
269+
270+
/**
271+
* User session
272+
*/
273+
248274
/**
249275
* Lifetime of the remember login cookie. This should be larger than the
250276
* session_lifetime. If it is set to 0 remember me is disabled.
@@ -363,33 +389,6 @@
363389
*/
364390
'hide_login_form' => false,
365391

366-
/**
367-
* The directory where the skeleton files are located. These files will be
368-
* copied to the data directory of new users. Leave empty to not copy any
369-
* skeleton files.
370-
* ``{lang}`` can be used as a placeholder for the language of the user.
371-
* If the directory does not exist, it falls back to non dialect (from ``de_DE``
372-
* to ``de``). If that does not exist either, it falls back to ``default``
373-
*
374-
* Defaults to ``core/skeleton`` in the Nextcloud directory.
375-
*/
376-
'skeletondirectory' => '/path/to/nextcloud/core/skeleton',
377-
378-
379-
/**
380-
* The directory where the template files are located. These files will be
381-
* copied to the template directory of new users. Leave empty to not copy any
382-
* template files.
383-
* ``{lang}`` can be used as a placeholder for the language of the user.
384-
* If the directory does not exist, it falls back to non dialect (from ``de_DE``
385-
* to ``de``). If that does not exist either, it falls back to ``default``
386-
*
387-
* If this is not set creating a template directory will only happen if no custom
388-
* ``skeletondirectory`` is defined, otherwise the shipped templates will be used
389-
* to create a template directory for the user.
390-
*/
391-
'templatedirectory' => '/path/to/nextcloud/templates',
392-
393392
/**
394393
* If your user backend does not allow password resets (e.g. when it's a
395394
* read-only user backend like LDAP), you can specify a custom link, where the
@@ -1067,6 +1066,17 @@
10671066
* Options for the Apps folder, Apps store, and App code checker.
10681067
*/
10691068

1069+
/**
1070+
* Set the default app to open on login. Use the app names as they appear in the
1071+
* URL after clicking them in the Apps menu, such as documents, calendar, and
1072+
* gallery. You can use a comma-separated list of app names, so if the first
1073+
* app is not enabled for a user then Nextcloud will try the second one, and so
1074+
* on. If no enabled apps are found it defaults to the dashboard app.
1075+
*
1076+
* Defaults to ``dashboard,files``
1077+
*/
1078+
'defaultapp' => 'dashboard,files',
1079+
10701080
/**
10711081
* When enabled, admins may install apps from the Nextcloud app store.
10721082
*
@@ -1344,6 +1354,14 @@
13441354
*/
13451355
'maintenance_window_start' => 1,
13461356

1357+
/**
1358+
* Log all LDAP requests into a file
1359+
*
1360+
* Warning: This heavily decreases the performance of the server and is only
1361+
* meant to debug/profile the LDAP interaction manually.
1362+
* Also, it might log sensitive data into a plain text file.
1363+
*/
1364+
'ldap_log_file' => '',
13471365

13481366
/**
13491367
* SSL
@@ -2035,12 +2053,6 @@
20352053
*/
20362054
'filesystem_cache_readonly' => false,
20372055

2038-
/**
2039-
* Secret used by Nextcloud for various purposes, e.g. to encrypt data. If you
2040-
* lose this string there will be data corruption.
2041-
*/
2042-
'secret' => '',
2043-
20442056
/**
20452057
* List of trusted proxy servers
20462058
*
@@ -2256,15 +2268,6 @@
22562268
*/
22572269
'redis_log_file' => '',
22582270

2259-
/**
2260-
* Log all LDAP requests into a file
2261-
*
2262-
* Warning: This heavily decreases the performance of the server and is only
2263-
* meant to debug/profile the LDAP interaction manually.
2264-
* Also, it might log sensitive data into a plain text file.
2265-
*/
2266-
'ldap_log_file' => '',
2267-
22682271
/**
22692272
* Enable diagnostics event logging
22702273
*

0 commit comments

Comments
 (0)