config.sample.php 76 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452
  1. <?php
  2. /**
  3. * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
  4. * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
  5. * SPDX-License-Identifier: AGPL-3.0-only
  6. */
  7. /**
  8. * This configuration file is only provided to document the different
  9. * configuration options and their usage.
  10. *
  11. * DO NOT COMPLETELY BASE YOUR CONFIGURATION FILE ON THIS SAMPLE. THIS MAY BREAK
  12. * YOUR INSTANCE. Instead, manually copy configuration switches that you
  13. * consider important for your instance to your working ``config.php``, and
  14. * apply configuration options that are pertinent for your instance.
  15. *
  16. * This file is used to generate the configuration documentation.
  17. * Please consider following requirements of the current parser:
  18. * * all comments need to start with `/**` and end with ` *\/` - each on their
  19. * own line
  20. * * add a `@see CONFIG_INDEX` to copy a previously described config option
  21. * also to this line
  22. * * everything between the ` *\/` and the next `/**` will be treated as the
  23. * config option
  24. * * use RST syntax
  25. */
  26. $CONFIG = [
  27. /**
  28. * Default Parameters
  29. *
  30. * These parameters are configured by the Nextcloud installer, and are required
  31. * for your Nextcloud server to operate.
  32. */
  33. /**
  34. * This is a unique identifier for your Nextcloud installation, created
  35. * automatically by the installer. This example is for documentation only,
  36. * and you should never use it because it will not work. A valid ``instanceid``
  37. * is created when you install Nextcloud.
  38. *
  39. * 'instanceid' => 'd3c944a9a',
  40. */
  41. 'instanceid' => '',
  42. /**
  43. * The salt used to hash all passwords, auto-generated by the Nextcloud
  44. * installer. (There are also per-user salts.) If you lose this salt you lose
  45. * all your passwords. This example is for documentation only, and you should
  46. * never use it.
  47. *
  48. * @deprecated This salt is deprecated and only used for legacy-compatibility,
  49. * developers should *NOT* use this value for anything nowadays.
  50. *
  51. * 'passwordsalt' => 'd3c944a9af095aa08f',
  52. */
  53. 'passwordsalt' => '',
  54. /**
  55. * Secret used by Nextcloud for various purposes, e.g. to encrypt data. If you
  56. * lose this string there will be data corruption.
  57. */
  58. 'secret' => '',
  59. /**
  60. * Your list of trusted domains that users can log into. Specifying trusted
  61. * domains prevents host header poisoning. Do not remove this, as it performs
  62. * necessary security checks.
  63. * You can specify:
  64. *
  65. * - the exact hostname of your host or virtual host, e.g. demo.example.org.
  66. * - the exact hostname with permitted port, e.g. demo.example.org:443.
  67. * This disallows all other ports on this host
  68. * - use * as a wildcard, e.g. ubos-raspberry-pi*.local will allow
  69. * ubos-raspberry-pi.local and ubos-raspberry-pi-2.local
  70. * - the IP address with or without permitted port, e.g. [2001:db8::1]:8080
  71. * Using TLS certificates where commonName=<IP address> is deprecated
  72. */
  73. 'trusted_domains' =>
  74. [
  75. 'demo.example.org',
  76. 'otherdomain.example.org',
  77. '10.111.112.113',
  78. '[2001:db8::1]'
  79. ],
  80. /**
  81. * Where user files are stored. The SQLite database is also stored here, when
  82. * you use SQLite.
  83. *
  84. * Default to ``data/`` in the Nextcloud directory.
  85. */
  86. 'datadirectory' => '/var/www/nextcloud/data',
  87. /**
  88. * The current version number of your Nextcloud installation. This is set up
  89. * during installation and update, so you shouldn't need to change it.
  90. */
  91. 'version' => '',
  92. /**
  93. * Identifies the database used with this installation. See also config option
  94. * ``supportedDatabases``
  95. *
  96. * Available:
  97. * - sqlite3 (SQLite3)
  98. * - mysql (MySQL/MariaDB)
  99. * - pgsql (PostgreSQL)
  100. *
  101. * Defaults to ``sqlite3``
  102. */
  103. 'dbtype' => 'sqlite3',
  104. /**
  105. * Your host server name, for example ``localhost``, ``hostname``,
  106. * ``hostname.example.com``, or the IP address.
  107. * To specify a port use ``hostname:####``, for IPv6 addresses use the URI notation ``[ip]:port``.
  108. * To specify a Unix socket use ``/path/to/directory/containing/socket``, e.g. ``/run/postgresql/``.
  109. */
  110. 'dbhost' => '',
  111. /**
  112. * The name of the Nextcloud database, which is set during installation. You
  113. * should not need to change this.
  114. */
  115. 'dbname' => 'nextcloud',
  116. /**
  117. * The user that Nextcloud uses to write to the database. This must be unique
  118. * across Nextcloud instances using the same SQL database. This is set up during
  119. * installation, so you shouldn't need to change it.
  120. */
  121. 'dbuser' => '',
  122. /**
  123. * The password for the database user. This is set up during installation, so
  124. * you shouldn't need to change it.
  125. */
  126. 'dbpassword' => '',
  127. /**
  128. * Prefix for the Nextcloud tables in the database.
  129. *
  130. * Default to ``oc_``
  131. */
  132. 'dbtableprefix' => 'oc_',
  133. /**
  134. * Enable persistent connexions to the database.
  135. * This setting uses the "persistent" option from doctrine dbal, which in turn
  136. * uses the PDO::ATTR_PERSISTENT option from the pdo driver.
  137. */
  138. 'dbpersistent' => '',
  139. /**
  140. * Specify read only replicas to be used by Nextcloud when querying the database
  141. */
  142. 'dbreplica' => [
  143. ['user' => 'nextcloud', 'password' => 'password1', 'host' => 'replica1', 'dbname' => ''],
  144. ['user' => 'nextcloud', 'password' => 'password2', 'host' => 'replica2', 'dbname' => ''],
  145. ],
  146. /**
  147. * Add request id to the database query in a comment.
  148. *
  149. * This can be enabled to assist in mapping database logs to Nextcloud logs.
  150. */
  151. 'db.log_request_id' => false,
  152. /**
  153. * Indicates whether the Nextcloud instance was installed successfully; ``true``
  154. * indicates a successful installation, and ``false`` indicates an unsuccessful
  155. * installation.
  156. *
  157. * Defaults to ``false``
  158. */
  159. 'installed' => false,
  160. /**
  161. * User Experience
  162. *
  163. * These optional parameters control some aspects of the user interface. Default
  164. * values, where present, are shown.
  165. */
  166. /**
  167. * This sets the default language on your Nextcloud server, using ISO_639-1
  168. * language codes such as ``en`` for English, ``de`` for German, and ``fr`` for
  169. * French. The default_language parameter is only used, when the browser does
  170. * not send any language, and the user hasn’t configured own language
  171. * preferences.
  172. *
  173. * Nextcloud has two distinguished language codes for German, 'de' and 'de_DE'.
  174. * 'de' is used for informal German and 'de_DE' for formal German. By setting
  175. * this value to 'de_DE' you can enforce the formal version of German unless
  176. * the user has chosen something different explicitly.
  177. *
  178. * Defaults to ``en``
  179. */
  180. 'default_language' => 'en',
  181. /**
  182. * With this setting a language can be forced for all users. If a language is
  183. * forced, the users are also unable to change their language in the personal
  184. * settings. If users shall be unable to change their language, but users have
  185. * different languages, this value can be set to ``true`` instead of a language
  186. * code.
  187. *
  188. * Defaults to ``false``
  189. */
  190. 'force_language' => 'en',
  191. /**
  192. * This sets the default locale on your Nextcloud server, using ISO_639
  193. * language codes such as ``en`` for English, ``de`` for German, and ``fr`` for
  194. * French, and ISO-3166 country codes such as ``GB``, ``US``, ``CA``, as defined
  195. * in RFC 5646. It overrides automatic locale detection on public pages like
  196. * login or shared items. User's locale preferences configured under "personal
  197. * -> locale" override this setting after they have logged in.
  198. *
  199. * Defaults to ``en``
  200. */
  201. 'default_locale' => 'en_US',
  202. /**
  203. * This sets the default region for phone numbers on your Nextcloud server,
  204. * using ISO 3166-1 country codes such as ``DE`` for Germany, ``FR`` for France, …
  205. * It is required to allow inserting phone numbers in the user profiles starting
  206. * without the country code (e.g. +49 for Germany).
  207. *
  208. * No default value!
  209. */
  210. 'default_phone_region' => 'GB',
  211. /**
  212. * With this setting a locale can be forced for all users. If a locale is
  213. * forced, the users are also unable to change their locale in the personal
  214. * settings. If users shall be unable to change their locale, but users have
  215. * different languages, this value can be set to ``true`` instead of a locale
  216. * code.
  217. *
  218. * Defaults to ``false``
  219. */
  220. 'force_locale' => 'en_US',
  221. /**
  222. * This sets the default timezone on your Nextcloud server, using IANA
  223. * identifiers like ``Europe/Berlin`` or ``Pacific/Auckland``. The default
  224. * timezone parameter is only used when the timezone of the user can't be
  225. * determined.
  226. *
  227. * Defaults to ``UTC``
  228. */
  229. 'default_timezone' => 'Europe/Berlin',
  230. /**
  231. * ``true`` enables the Help menu item in the user menu (top right of the
  232. * Nextcloud Web interface). ``false`` removes the Help item.
  233. */
  234. 'knowledgebaseenabled' => true,
  235. /**
  236. * ``true`` embeds the documentation in an iframe inside Nextcloud.
  237. * ``false`` only shows buttons to the online documentation.
  238. */
  239. 'knowledgebase.embedded' => false,
  240. /**
  241. * ``true`` allows users to change their display names (on their Personal
  242. * pages), and ``false`` prevents them from changing their display names.
  243. */
  244. 'allow_user_to_change_display_name' => true,
  245. /**
  246. * The directory where the skeleton files are located. These files will be
  247. * copied to the data directory of new users. Leave empty to not copy any
  248. * skeleton files.
  249. * ``{lang}`` can be used as a placeholder for the language of the user.
  250. * If the directory does not exist, it falls back to non dialect (from ``de_DE``
  251. * to ``de``). If that does not exist either, it falls back to ``default``
  252. *
  253. * Defaults to ``core/skeleton`` in the Nextcloud directory.
  254. */
  255. 'skeletondirectory' => '/path/to/nextcloud/core/skeleton',
  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. * User session
  271. */
  272. /**
  273. * Lifetime of the remember login cookie. This should be larger than the
  274. * session_lifetime. If it is set to 0 remember me is disabled.
  275. *
  276. * Defaults to ``60*60*24*15`` seconds (15 days)
  277. */
  278. 'remember_login_cookie_lifetime' => 60*60*24*15,
  279. /**
  280. * The lifetime of a session after inactivity.
  281. *
  282. * The maximum possible time is limited by the session.gc_maxlifetime php.ini setting
  283. * which would overwrite this option if it is less than the value in the config.php
  284. *
  285. * Defaults to ``60*60*24`` seconds (24 hours)
  286. */
  287. 'session_lifetime' => 60 * 60 * 24,
  288. /**
  289. * The timeout in seconds for requests to servers made by the DAV component (e.g., needed for federated shares).
  290. */
  291. 'davstorage.request_timeout' => 30,
  292. /**
  293. * `true` enabled a relaxed session timeout, where the session timeout would no longer be
  294. * handled by Nextcloud but by either the PHP garbage collection or the expiration of
  295. * potential other session backends like redis.
  296. *
  297. * This may lead to sessions being available for longer than what session_lifetime uses but
  298. * comes with performance benefits as sessions are no longer a locking operation for concurrent
  299. * requests.
  300. */
  301. 'session_relaxed_expiry' => false,
  302. /**
  303. * Enable or disable session keep-alive when a user is logged in to the Web UI.
  304. * Enabling this sends a "heartbeat" to the server to keep it from timing out.
  305. *
  306. * Defaults to ``true``
  307. */
  308. 'session_keepalive' => true,
  309. /**
  310. * Enable or disable the automatic logout after session_lifetime, even if session
  311. * keepalive is enabled. This will make sure that an inactive browser will be logged out
  312. * even if requests to the server might extend the session lifetime.
  313. *
  314. * Defaults to ``false``
  315. */
  316. 'auto_logout' => false,
  317. /**
  318. * Enforce token authentication for clients, which blocks requests using the user
  319. * password for enhanced security. Users need to generate tokens in personal settings
  320. * which can be used as passwords on their clients.
  321. *
  322. * Defaults to ``false``
  323. */
  324. 'token_auth_enforced' => false,
  325. /**
  326. * The interval at which token activity should be updated.
  327. * Increasing this value means that the last activity on the security page gets
  328. * more outdated.
  329. *
  330. * Tokens are still checked every 5 minutes for validity
  331. * max value: 300
  332. *
  333. * Defaults to ``60``
  334. */
  335. 'token_auth_activity_update' => 60,
  336. /**
  337. * Whether the brute force protection shipped with Nextcloud should be enabled or not.
  338. *
  339. * Disabling this is discouraged for security reasons.
  340. *
  341. * Defaults to ``true``
  342. */
  343. 'auth.bruteforce.protection.enabled' => true,
  344. /**
  345. * Whether the brute force protection shipped with Nextcloud should be set to testing mode.
  346. *
  347. * In testing mode brute force attempts are still recorded, but the requests do
  348. * not sleep/wait for the specified time. They will still abort with
  349. * "429 Too Many Requests" when the maximum delay is reached.
  350. * Enabling this is discouraged for security reasons
  351. * and should only be done for debugging and on CI when running tests.
  352. *
  353. * Defaults to ``false``
  354. */
  355. 'auth.bruteforce.protection.testing' => false,
  356. /**
  357. * Whether the rate limit protection shipped with Nextcloud should be enabled or not.
  358. *
  359. * Disabling this is discouraged for security reasons.
  360. *
  361. * Defaults to ``true``
  362. */
  363. 'ratelimit.protection.enabled' => true,
  364. /**
  365. * By default, WebAuthn is available, but it can be explicitly disabled by admins
  366. */
  367. 'auth.webauthn.enabled' => true,
  368. /**
  369. * Whether encrypted password should be stored in the database
  370. *
  371. * The passwords are only decrypted using the login token stored uniquely in the
  372. * clients and allow to connect to external storages, autoconfigure mail account in
  373. * the mail app and periodically check if the password it still valid.
  374. *
  375. * This might be desirable to disable this functionality when using one time
  376. * passwords or when having a password policy enforcing long passwords (> 300
  377. * characters).
  378. *
  379. * By default, the passwords are stored encrypted in the database.
  380. *
  381. * WARNING: If disabled, password changes on the user back-end (e.g. on LDAP) no
  382. * longer log connected clients out automatically. Users can still disconnect
  383. * the clients by deleting the app token from the security settings.
  384. */
  385. 'auth.storeCryptedPassword' => true,
  386. /**
  387. * By default, the login form is always available. There are cases (SSO) where an
  388. * admin wants to avoid users entering their credentials to the system if the SSO
  389. * app is unavailable.
  390. *
  391. * This will show an error. But the direct login still works with adding ?direct=1
  392. */
  393. 'hide_login_form' => false,
  394. /**
  395. * If your user backend does not allow password resets (e.g. when it's a
  396. * read-only user backend like LDAP), you can specify a custom link, where the
  397. * user is redirected to, when clicking the "reset password" link after a failed
  398. * login-attempt.
  399. * In case you do not want to provide any link, replace the url with 'disabled'
  400. */
  401. 'lost_password_link' => 'https://example.org/link/to/password/reset',
  402. /**
  403. * URL to use as target for the logo link in the header (top-left logo)
  404. *
  405. * Defaults to the base URL of your Nextcloud instance
  406. */
  407. 'logo_url' => 'https://example.org',
  408. /**
  409. * Mail Parameters
  410. *
  411. * These configure the email settings for Nextcloud notifications and password
  412. * resets.
  413. */
  414. /**
  415. * The return address that you want to appear on emails sent by the Nextcloud
  416. * server, for example ``nc-admin@example.com``, substituting your own domain,
  417. * of course.
  418. */
  419. 'mail_domain' => 'example.com',
  420. /**
  421. * FROM address that overrides the built-in ``sharing-noreply`` and
  422. * ``lostpassword-noreply`` FROM addresses.
  423. *
  424. * Defaults to different from addresses depending on the feature.
  425. */
  426. 'mail_from_address' => 'nextcloud',
  427. /**
  428. * Enable SMTP class debugging.
  429. *
  430. * Defaults to ``false``
  431. */
  432. 'mail_smtpdebug' => false,
  433. /**
  434. * Which mode to use for sending mail: ``sendmail``, ``smtp`` or ``qmail``.
  435. *
  436. * If you are using local or remote SMTP, set this to ``smtp``.
  437. *
  438. * For the ``sendmail`` option you need an installed and working email system on
  439. * the server, with ``/usr/sbin/sendmail`` installed on your Unix system.
  440. *
  441. * For ``qmail`` the binary is /var/qmail/bin/sendmail, and it must be installed
  442. * on your Unix system.
  443. *
  444. * Defaults to ``smtp``
  445. */
  446. 'mail_smtpmode' => 'smtp',
  447. /**
  448. * This depends on ``mail_smtpmode``. Specify the IP address of your mail
  449. * server host. This may contain multiple hosts separated by a semicolon. If
  450. * you need to specify the port number append it to the IP address separated by
  451. * a colon, like this: ``127.0.0.1:24``.
  452. *
  453. * Defaults to ``127.0.0.1``
  454. */
  455. 'mail_smtphost' => '127.0.0.1',
  456. /**
  457. * This depends on ``mail_smtpmode``. Specify the port for sending mail.
  458. *
  459. * Defaults to ``25``
  460. */
  461. 'mail_smtpport' => 25,
  462. /**
  463. * This depends on ``mail_smtpmode``. This sets the SMTP server timeout, in
  464. * seconds. You may need to increase this if you are running an anti-malware or
  465. * spam scanner.
  466. *
  467. * Defaults to ``10`` seconds
  468. */
  469. 'mail_smtptimeout' => 10,
  470. /**
  471. * This depends on ``mail_smtpmode``. Specify ``ssl`` when you are using SSL/TLS. Any other value will be ignored.
  472. *
  473. * If the server advertises STARTTLS capabilities, they might be used, but they cannot be enforced by
  474. * this config option.
  475. *
  476. * Defaults to ``''`` (empty string)
  477. */
  478. 'mail_smtpsecure' => '',
  479. /**
  480. *
  481. * This depends on ``mail_smtpmode``. Change this to ``true`` if your mail
  482. * server requires authentication.
  483. *
  484. * Defaults to ``false``
  485. */
  486. 'mail_smtpauth' => false,
  487. /**
  488. * This depends on ``mail_smtpauth``. Specify the username for authenticating to
  489. * the SMTP server.
  490. *
  491. * Defaults to ``''`` (empty string)
  492. */
  493. 'mail_smtpname' => '',
  494. /**
  495. * This depends on ``mail_smtpauth``. Specify the password for authenticating to
  496. * the SMTP server.
  497. *
  498. * Default to ``''`` (empty string)
  499. */
  500. 'mail_smtppassword' => '',
  501. /**
  502. * Replaces the default mail template layout. This can be utilized if the
  503. * options to modify the mail texts with the theming app is not enough.
  504. * The class must extend ``\OC\Mail\EMailTemplate``
  505. */
  506. 'mail_template_class' => '\OC\Mail\EMailTemplate',
  507. /**
  508. * Email will be sent by default with an HTML and a plain text body. This option
  509. * allows to only send plain text emails.
  510. */
  511. 'mail_send_plaintext_only' => false,
  512. /**
  513. * This depends on ``mail_smtpmode``. Array of additional streams options that
  514. * will be passed to underlying Swift mailer implementation.
  515. * Defaults to an empty array.
  516. */
  517. 'mail_smtpstreamoptions' => [],
  518. /**
  519. * Which mode is used for sendmail/qmail: ``smtp`` or ``pipe``.
  520. *
  521. * For ``smtp`` the sendmail binary is started with the parameter ``-bs``:
  522. * - Use the SMTP protocol on standard input and output.
  523. *
  524. * For ``pipe`` the binary is started with the parameters ``-t``:
  525. * - Read message from STDIN and extract recipients.
  526. *
  527. * Defaults to ``smtp``
  528. */
  529. 'mail_sendmailmode' => 'smtp',
  530. /**
  531. * Proxy Configurations
  532. */
  533. /**
  534. * The automatic hostname detection of Nextcloud can fail in certain reverse
  535. * proxy and CLI/cron situations. This option allows you to manually override
  536. * the automatic detection; for example ``www.example.com``, or specify the port
  537. * ``www.example.com:8080``.
  538. */
  539. 'overwritehost' => '',
  540. /**
  541. * When generating URLs, Nextcloud attempts to detect whether the server is
  542. * accessed via ``https`` or ``http``. However, if Nextcloud is behind a proxy
  543. * and the proxy handles the ``https`` calls, Nextcloud would not know that
  544. * ``ssl`` is in use, which would result in incorrect URLs being generated.
  545. * Valid values are ``http`` and ``https``.
  546. */
  547. 'overwriteprotocol' => '',
  548. /**
  549. * Nextcloud attempts to detect the webroot for generating URLs automatically.
  550. * For example, if ``www.example.com/nextcloud`` is the URL pointing to the
  551. * Nextcloud instance, the webroot is ``/nextcloud``. When proxies are in use,
  552. * it may be difficult for Nextcloud to detect this parameter, resulting in
  553. * invalid URLs.
  554. */
  555. 'overwritewebroot' => '',
  556. /**
  557. * This option allows you to define a manual override condition as a regular
  558. * expression for the remote IP address. For example, defining a range of IP
  559. * addresses starting with ``10.0.0.`` and ending with 1 to 3:
  560. * ``^10\.0\.0\.[1-3]$``
  561. *
  562. * Defaults to ``''`` (empty string)
  563. */
  564. 'overwritecondaddr' => '',
  565. /**
  566. * Use this configuration parameter to specify the base URL for any URLs which
  567. * are generated within Nextcloud using any kind of command line tools (cron or
  568. * occ). The value should contain the full base URL:
  569. * ``https://www.example.com/nextcloud``
  570. *
  571. * Defaults to ``''`` (empty string)
  572. */
  573. 'overwrite.cli.url' => '',
  574. /**
  575. * To have clean URLs without `/index.php` this parameter needs to be configured.
  576. *
  577. * This parameter will be written as "RewriteBase" on update and installation of
  578. * Nextcloud to your `.htaccess` file. While this value is often simply the URL
  579. * path of the Nextcloud installation it cannot be set automatically properly in
  580. * every scenario and needs thus some manual configuration.
  581. *
  582. * In a standard Apache setup this usually equals the folder that Nextcloud is
  583. * accessible at. So if Nextcloud is accessible via "https://mycloud.org/nextcloud"
  584. * the correct value would most likely be "/nextcloud". If Nextcloud is running
  585. * under "https://mycloud.org/" then it would be "/".
  586. *
  587. * Note that the above rule is not valid in every case, as there are some rare setup
  588. * cases where this may not apply. However, to avoid any update problems this
  589. * configuration value is explicitly opt-in.
  590. *
  591. * After setting this value run `occ maintenance:update:htaccess`. Now, when the
  592. * following conditions are met Nextcloud URLs won't contain `index.php`:
  593. *
  594. * - `mod_rewrite` is installed
  595. * - `mod_env` is installed
  596. *
  597. * Defaults to ``''`` (empty string)
  598. */
  599. 'htaccess.RewriteBase' => '/',
  600. /**
  601. * For server setups, that don't have `mod_env` enabled or restricted (e.g. suEXEC)
  602. * this parameter has to be set to true and will assume mod_rewrite.
  603. *
  604. * Please check, if `mod_rewrite` is active and functional before setting this
  605. * parameter, and you updated your .htaccess with `occ maintenance:update:htaccess`.
  606. * Otherwise, your nextcloud installation might not be reachable anymore.
  607. * For example, try accessing resources by leaving out `index.php` in the URL.
  608. */
  609. 'htaccess.IgnoreFrontController' => false,
  610. /**
  611. * The URL of your proxy server, for example ``proxy.example.com:8081``.
  612. *
  613. * Note: Guzzle (the http library used by Nextcloud) is reading the environment
  614. * variables HTTP_PROXY (only for cli request), HTTPS_PROXY, and NO_PROXY by default.
  615. *
  616. * If you configure proxy with Nextcloud any default configuration by Guzzle
  617. * is overwritten. Make sure to set ``proxyexclude`` accordingly if necessary.
  618. *
  619. * Defaults to ``''`` (empty string)
  620. */
  621. 'proxy' => '',
  622. /**
  623. * The optional authentication for the proxy to use to connect to the internet.
  624. * The format is: ``username:password``.
  625. *
  626. * Defaults to ``''`` (empty string)
  627. */
  628. 'proxyuserpwd' => '',
  629. /**
  630. * List of host names that should not be proxied to.
  631. * For example: ``['.mit.edu', 'foo.com']``.
  632. *
  633. * Hint: Use something like ``explode(',', getenv('NO_PROXY'))`` to sync this
  634. * value with the global NO_PROXY option.
  635. *
  636. * Defaults to empty array.
  637. */
  638. 'proxyexclude' => [],
  639. /**
  640. * Allow remote servers with local addresses e.g. in federated shares, webcal services and more
  641. *
  642. * Defaults to false
  643. */
  644. 'allow_local_remote_servers' => true,
  645. /**
  646. * Deleted Items (trash bin)
  647. *
  648. * These parameters control the Deleted files app.
  649. */
  650. /**
  651. * If the trash bin app is enabled (default), this setting defines the policy
  652. * for when files and folders in the trash bin will be permanently deleted.
  653. * The app allows for two settings, a minimum time for trash bin retention,
  654. * and a maximum time for trash bin retention.
  655. *
  656. * Minimum time is the number of days a file will be kept, after which it
  657. * *may be* deleted. A file may be deleted after the minimum number of days
  658. * is expired if space is needed. The file will not be deleted if space is
  659. * not needed.
  660. *
  661. * Whether "space is needed" depends on whether a user quota is defined or not:
  662. *
  663. * * If no user quota is defined, the available space on the Nextcloud data
  664. * partition sets the limit for the trashbin
  665. * (issues: see https://github.com/nextcloud/server/issues/28451).
  666. * * If a user quota is defined, 50% of the user's remaining quota space sets
  667. * the limit for the trashbin.
  668. *
  669. * Maximum time is the number of days at which it is *guaranteed
  670. * to be* deleted. There is no further dependency on the available space.
  671. *
  672. * Both minimum and maximum times can be set together to explicitly define
  673. * file and folder deletion. For migration purposes, this setting is installed
  674. * initially set to "auto", which is equivalent to the default setting in
  675. * Nextcloud.
  676. *
  677. * Available values (D1 and D2 are configurable numbers):
  678. *
  679. * * ``auto``
  680. * default setting. keeps files and folders in the trash bin for 30 days
  681. * and automatically deletes anytime after that if space is needed (note:
  682. * files may not be deleted if space is not needed).
  683. * * ``D1, auto``
  684. * keeps files and folders in the trash bin for D1+ days, delete anytime if
  685. * space needed (note: files may not be deleted if space is not needed)
  686. * * ``auto, D2``
  687. * delete all files in the trash bin that are older than D2 days
  688. * automatically, delete other files anytime if space needed
  689. * * ``D1, D2``
  690. * keep files and folders in the trash bin for at least D1 days and
  691. * delete when exceeds D2 days (note: files will not be deleted automatically if space is needed)
  692. * * ``disabled``
  693. * trash bin auto clean disabled, files and folders will be kept forever
  694. *
  695. * Defaults to ``auto``
  696. */
  697. 'trashbin_retention_obligation' => 'auto',
  698. /**
  699. * File versions
  700. *
  701. * These parameters control the Versions app.
  702. */
  703. /**
  704. * If the versions app is enabled (default), this setting defines the policy
  705. * for when versions will be permanently deleted.
  706. * The app allows for two settings, a minimum time for version retention,
  707. * and a maximum time for version retention.
  708. * Minimum time is the number of days a version will be kept, after which it
  709. * may be deleted. Maximum time is the number of days at which it is guaranteed
  710. * to be deleted.
  711. * Both minimum and maximum times can be set together to explicitly define
  712. * version deletion. For migration purposes, this setting is installed
  713. * initially set to "auto", which is equivalent to the default setting in
  714. * Nextcloud.
  715. *
  716. * Available values:
  717. *
  718. * * ``auto``
  719. * default setting. Automatically expire versions according to expire
  720. * rules. Please refer to :doc:`../configuration_files/file_versioning` for
  721. * more information.
  722. * * ``D, auto``
  723. * keep versions at least for D days, apply expiration rules to all versions
  724. * that are older than D days
  725. * * ``auto, D``
  726. * delete all versions that are older than D days automatically, delete
  727. * other versions according to expire rules
  728. * * ``D1, D2``
  729. * keep versions for at least D1 days and delete when exceeds D2 days
  730. * * ``disabled``
  731. * versions auto clean disabled, versions will be kept forever
  732. *
  733. * Defaults to ``auto``
  734. */
  735. 'versions_retention_obligation' => 'auto',
  736. /**
  737. * Nextcloud Verifications
  738. *
  739. * Nextcloud performs several verification checks. There are two options,
  740. * ``true`` and ``false``.
  741. */
  742. /**
  743. * Checks an app before install whether it uses private APIs instead of the
  744. * proper public APIs. If this is set to true it will only allow to install or
  745. * enable apps that pass this check.
  746. *
  747. * Defaults to ``false``
  748. */
  749. 'appcodechecker' => true,
  750. /**
  751. * Check if Nextcloud is up-to-date and shows a notification if a new version is
  752. * available. It sends current version, php version, installation and last update
  753. * time and release channel to the updater server which responds with the latest
  754. * available version based on those metrics.
  755. *
  756. * Defaults to ``true``
  757. */
  758. 'updatechecker' => true,
  759. /**
  760. * URL that Nextcloud should use to look for updates
  761. *
  762. * Defaults to ``https://updates.nextcloud.com/updater_server/``
  763. */
  764. 'updater.server.url' => 'https://updates.nextcloud.com/updater_server/',
  765. /**
  766. * The channel that Nextcloud should use to look for updates
  767. *
  768. * Supported values:
  769. *
  770. * - ``daily``
  771. * - ``beta``
  772. * - ``stable``
  773. */
  774. 'updater.release.channel' => 'stable',
  775. /**
  776. * Is Nextcloud connected to the Internet or running in a closed network?
  777. *
  778. * Defaults to ``true``
  779. */
  780. 'has_internet_connection' => true,
  781. /**
  782. * Which domains to request to determine the availability of an Internet
  783. * connection. If none of these hosts are reachable, the administration panel
  784. * will show a warning. Set to an empty list to not do any such checks (warning
  785. * will still be shown).
  786. * If no protocol is provided, both http and https will be tested.
  787. * For example, 'http://www.nextcloud.com' and 'https://www.nextcloud.com'
  788. * will be tested for 'www.nextcloud.com'
  789. * If a protocol is provided, only this one will be tested.
  790. *
  791. * Defaults to the following domains:
  792. *
  793. * - www.nextcloud.com
  794. * - www.startpage.com
  795. * - www.eff.org
  796. * - www.edri.org
  797. */
  798. 'connectivity_check_domains' => [
  799. 'www.nextcloud.com',
  800. 'www.startpage.com',
  801. 'www.eff.org',
  802. 'www.edri.org'
  803. ],
  804. /**
  805. * Allows Nextcloud to verify a working .well-known URL redirects. This is done
  806. * by attempting to make a request from JS to
  807. * https://your-domain.com/.well-known/caldav/
  808. *
  809. * Defaults to ``true``
  810. */
  811. 'check_for_working_wellknown_setup' => true,
  812. /**
  813. * This is a crucial security check on Apache servers that should always be set
  814. * to ``true``. This verifies that the ``.htaccess`` file is writable and works.
  815. * If it is not, then any options controlled by ``.htaccess``, such as large
  816. * file uploads, will not work. It also runs checks on the ``data/`` directory,
  817. * which verifies that it can't be accessed directly through the Web server.
  818. *
  819. * Defaults to ``true``
  820. */
  821. 'check_for_working_htaccess' => true,
  822. /**
  823. * In rare setups (e.g. on Openshift or Docker on Windows) the permissions check
  824. * might block the installation while the underlying system offers no means to
  825. * "correct" the permissions. In this case, set the value to false.
  826. *
  827. * In regular cases, if issues with permissions are encountered they should be
  828. * adjusted accordingly. Changing the flag is discouraged.
  829. *
  830. * Defaults to ``true``
  831. */
  832. 'check_data_directory_permissions' => true,
  833. /**
  834. * In certain environments it is desired to have a read-only configuration file.
  835. * When this switch is set to ``true``, writing to the config file will be
  836. * forbidden. Therefore, it will not be possible to configure all options via
  837. * the Web interface. Furthermore, when updating Nextcloud it is required to
  838. * make the configuration file writable again and to set this switch to ``false``
  839. * for the update process.
  840. *
  841. * Defaults to ``false``
  842. */
  843. 'config_is_read_only' => false,
  844. /**
  845. * Logging
  846. */
  847. /**
  848. * This parameter determines where the Nextcloud logs are sent.
  849. * ``file``: the logs are written to file ``nextcloud.log`` in the default
  850. * Nextcloud data directory. The log file can be changed with parameter
  851. * ``logfile``.
  852. * ``syslog``: the logs are sent to the system log. This requires a syslog daemon
  853. * to be active.
  854. * ``errorlog``: the logs are sent to the PHP ``error_log`` function.
  855. * ``systemd``: the logs are sent to the Systemd journal. This requires a system
  856. * that runs Systemd and the Systemd journal. The PHP extension ``systemd``
  857. * must be installed and active.
  858. *
  859. * Defaults to ``file``
  860. */
  861. 'log_type' => 'file',
  862. /**
  863. * This parameter determines where the audit logs are sent. See ``log_type`` for more information.
  864. *
  865. * Defaults to ``file``
  866. */
  867. 'log_type_audit' => 'file',
  868. /**
  869. * Name of the file to which the Nextcloud logs are written if parameter
  870. * ``log_type`` is set to ``file``.
  871. *
  872. * Defaults to ``[datadirectory]/nextcloud.log``
  873. */
  874. 'logfile' => '/var/log/nextcloud.log',
  875. /**
  876. * Name of the file to which the audit logs are written if parameter
  877. * ``log_type`` is set to ``file``.
  878. *
  879. * Defaults to ``[datadirectory]/audit.log``
  880. */
  881. 'logfile_audit' => '/var/log/audit.log',
  882. /**
  883. * Log file mode for the Nextcloud logging type in octal notation.
  884. *
  885. * Defaults to 0640 (writeable by user, readable by group).
  886. */
  887. 'logfilemode' => 0640,
  888. /**
  889. * Loglevel to start logging at. Valid values are: 0 = Debug, 1 = Info, 2 =
  890. * Warning, 3 = Error, and 4 = Fatal. The default value is Warning.
  891. *
  892. * Defaults to ``2``
  893. */
  894. 'loglevel' => 2,
  895. /**
  896. * Loglevel used by the frontend to start logging at. The same values as
  897. * for ``loglevel`` can be used. If not set it defaults to the value
  898. * configured for ``loglevel`` or Warning if that is not set either.
  899. *
  900. * Defaults to ``2``
  901. */
  902. 'loglevel_frontend' => 2,
  903. /**
  904. * Loglevel used by the dirty database query detection. Useful to identify
  905. * potential database bugs in production. Set this to loglevel or higher to
  906. * see dirty queries in the logs.
  907. *
  908. * Defaults to ``0`` (debug)
  909. */
  910. 'loglevel_dirty_database_queries' => 0,
  911. /**
  912. * If you maintain different instances and aggregate the logs, you may want
  913. * to distinguish between them. ``syslog_tag`` can be set per instance
  914. * with a unique id. Only available if ``log_type`` is set to ``syslog`` or
  915. * ``systemd``.
  916. *
  917. * The default value is ``Nextcloud``.
  918. */
  919. 'syslog_tag' => 'Nextcloud',
  920. /**
  921. * If you maintain different instances and aggregate the logs, you may want
  922. * to distinguish between them. ``syslog_tag_audit`` can be set per instance
  923. * with a unique id. Only available if ``log_type`` is set to ``syslog`` or
  924. * ``systemd``.
  925. *
  926. * The default value is the value of ``syslog_tag``.
  927. */
  928. 'syslog_tag_audit' => 'Nextcloud',
  929. /**
  930. * Log condition for log level increase based on conditions. Once one of these
  931. * conditions is met, the required log level is set to debug. This allows to
  932. * debug specific requests, users or apps
  933. *
  934. * Supported conditions:
  935. * - ``shared_secret``: if a request parameter with the name `log_secret` is set to
  936. * this value the condition is met
  937. * - ``users``: if the current request is done by one of the specified users,
  938. * this condition is met
  939. * - ``apps``: if the log message is invoked by one of the specified apps,
  940. * this condition is met
  941. *
  942. * Defaults to an empty array.
  943. */
  944. 'log.condition' => [
  945. 'shared_secret' => '57b58edb6637fe3059b3595cf9c41b9',
  946. 'users' => ['sample-user'],
  947. 'apps' => ['files'],
  948. ],
  949. /**
  950. * Enables logging a backtrace with each log line. Normally, only Exceptions
  951. * are carrying backtrace information which are logged automatically. This
  952. * switch turns them on for any log message. Enabling this option will lead
  953. * to increased log data size.
  954. *
  955. * Defaults to ``false``.
  956. */
  957. 'log.backtrace' => false,
  958. /**
  959. * This uses PHP.date formatting; see https://www.php.net/manual/en/function.date.php
  960. *
  961. * Defaults to ISO 8601 ``2005-08-15T15:52:01+00:00`` - see \DateTime::ATOM
  962. * (https://www.php.net/manual/en/class.datetime.php#datetime.constants.atom)
  963. */
  964. 'logdateformat' => 'F d, Y H:i:s',
  965. /**
  966. * The timezone for logfiles. You may change this; see
  967. * https://www.php.net/manual/en/timezones.php
  968. *
  969. * Defaults to ``UTC``
  970. */
  971. 'logtimezone' => 'Europe/Berlin',
  972. /**
  973. * Append all database queries and parameters to the log file. Use this only for
  974. * debugging, as your logfile will become huge.
  975. */
  976. 'log_query' => false,
  977. /**
  978. * Enables log rotation and limits the total size of logfiles. Set it to 0 for
  979. * no rotation. Specify a size in bytes, for example 104857600 (100 megabytes
  980. * = 100 * 1024 * 1024 bytes). A new logfile is created with a new name when the
  981. * old logfile reaches your limit. If a rotated log file is already present, it
  982. * will be overwritten.
  983. *
  984. * Defaults to 100 MB
  985. */
  986. 'log_rotate_size' => 100 * 1024 * 1024,
  987. /**
  988. * Enable built-in profiler. Helpful when trying to debug performance
  989. * issues.
  990. *
  991. * Note that this has a performance impact and shouldn't be enabled
  992. * on production.
  993. */
  994. 'profiler' => false,
  995. /**
  996. * Alternate Code Locations
  997. *
  998. * Some Nextcloud code may be stored in alternate locations.
  999. */
  1000. /**
  1001. * This section is for configuring the download links for Nextcloud clients, as
  1002. * seen in the first-run wizard and on Personal pages.
  1003. *
  1004. * Defaults to:
  1005. *
  1006. * - Desktop client: ``https://nextcloud.com/install/#install-clients``
  1007. * - Android client: ``https://play.google.com/store/apps/details?id=com.nextcloud.client``
  1008. * - iOS client: ``https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8``
  1009. * - iOS client app id: ``1125420102``
  1010. */
  1011. 'customclient_desktop' =>
  1012. 'https://nextcloud.com/install/#install-clients',
  1013. 'customclient_android' =>
  1014. 'https://play.google.com/store/apps/details?id=com.nextcloud.client',
  1015. 'customclient_ios' =>
  1016. 'https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8',
  1017. 'customclient_ios_appid' =>
  1018. '1125420102',
  1019. /**
  1020. * Apps
  1021. *
  1022. * Options for the Apps folder, Apps store, and App code checker.
  1023. */
  1024. /**
  1025. * Set the default app to open on login. Use the app names as they appear in the
  1026. * URL after clicking them in the Apps menu, such as documents, calendar, and
  1027. * gallery. You can use a comma-separated list of app names, so if the first
  1028. * app is not enabled for a user then Nextcloud will try the second one, and so
  1029. * on. If no enabled apps are found it defaults to the dashboard app.
  1030. *
  1031. * Defaults to ``dashboard,files``
  1032. */
  1033. 'defaultapp' => 'dashboard,files',
  1034. /**
  1035. * When enabled, admins may install apps from the Nextcloud app store.
  1036. *
  1037. * Defaults to ``true``
  1038. */
  1039. 'appstoreenabled' => true,
  1040. /**
  1041. * Enables the installation of apps from a self-hosted apps store.
  1042. * Requires that at least one of the configured apps directories is writeable.
  1043. *
  1044. * Defaults to ``https://apps.nextcloud.com/api/v1``
  1045. */
  1046. 'appstoreurl' => 'https://apps.nextcloud.com/api/v1',
  1047. /**
  1048. * Filters allowed installable apps from the appstore.
  1049. * Empty array will prevent all apps from the store to be found.
  1050. */
  1051. 'appsallowlist' => [],
  1052. /**
  1053. * Use the ``apps_paths`` parameter to set the location of the Apps directory,
  1054. * which should be scanned for available apps, and where user-specific apps
  1055. * should be installed from the Apps store. The ``path`` defines the absolute
  1056. * file system path to the app folder. The key ``url`` defines the HTTP Web path
  1057. * to that folder, starting from the Nextcloud webroot. The key ``writable``
  1058. * indicates if a Web server can write files to that folder.
  1059. */
  1060. 'apps_paths' => [
  1061. [
  1062. 'path'=> '/var/www/nextcloud/apps',
  1063. 'url' => '/apps',
  1064. 'writable' => true,
  1065. ],
  1066. ],
  1067. /**
  1068. * @see appcodechecker
  1069. */
  1070. /**
  1071. * Previews
  1072. *
  1073. * Nextcloud supports previews of image files, the covers of MP3 files, and text
  1074. * files. These options control enabling and disabling previews, and thumbnail
  1075. * size.
  1076. */
  1077. /**
  1078. * By default, Nextcloud can generate previews for the following filetypes:
  1079. *
  1080. * - Image files
  1081. * - Covers of MP3 files
  1082. * - Text documents
  1083. *
  1084. * Valid values are ``true``, to enable previews, or
  1085. * ``false``, to disable previews
  1086. *
  1087. * Defaults to ``true``
  1088. */
  1089. 'enable_previews' => true,
  1090. /**
  1091. * Number of all preview requests being processed concurrently,
  1092. * including previews that need to be newly generated, and those that have
  1093. * been generated.
  1094. *
  1095. * This should be greater than 'preview_concurrency_new'.
  1096. * If unspecified, defaults to twice the value of 'preview_concurrency_new'.
  1097. */
  1098. 'preview_concurrency_all' => 8,
  1099. /**
  1100. * Number of new previews that are being concurrently generated.
  1101. *
  1102. * Depending on the max preview size set by 'preview_max_x' and 'preview_max_y',
  1103. * the generation process can consume considerable CPU and memory resources.
  1104. * It's recommended to limit this to be no greater than the number of CPU cores.
  1105. * If unspecified, defaults to the number of CPU cores, or 4 if that cannot
  1106. * be determined.
  1107. */
  1108. 'preview_concurrency_new' => 4,
  1109. /**
  1110. * The maximum width, in pixels, of a preview. A value of ``null`` means there
  1111. * is no limit.
  1112. *
  1113. * Defaults to ``4096``
  1114. */
  1115. 'preview_max_x' => 4096,
  1116. /**
  1117. * The maximum height, in pixels, of a preview. A value of ``null`` means there
  1118. * is no limit.
  1119. *
  1120. * Defaults to ``4096``
  1121. */
  1122. 'preview_max_y' => 4096,
  1123. /**
  1124. * Max file size for generating image previews with imagegd (default behavior).
  1125. * If the image is bigger, it'll try other preview generators, but will most
  1126. * likely either show the default mimetype icon or not display the image at all.
  1127. * Set to ``-1`` for no limit and try to generate image previews on all file sizes.
  1128. *
  1129. * Defaults to ``50`` megabytes
  1130. */
  1131. 'preview_max_filesize_image' => 50,
  1132. /**
  1133. * max memory for generating image previews with imagegd (default behavior)
  1134. * Reads the image dimensions from the header and assumes 32 bits per pixel.
  1135. * If creating the image would allocate more memory, preview generation will
  1136. * be disabled and the default mimetype icon is shown. Set to -1 for no limit.
  1137. *
  1138. * Defaults to ``256`` megabytes
  1139. */
  1140. 'preview_max_memory' => 256,
  1141. /**
  1142. * custom path for LibreOffice/OpenOffice binary
  1143. *
  1144. *
  1145. * Defaults to ``''`` (empty string)
  1146. */
  1147. 'preview_libreoffice_path' => '/usr/bin/libreoffice',
  1148. /**
  1149. * custom path for ffmpeg binary
  1150. *
  1151. * Defaults to ``null`` and falls back to searching ``avconv`` and ``ffmpeg`` in the configured ``PATH`` environment
  1152. */
  1153. 'preview_ffmpeg_path' => '/usr/bin/ffmpeg',
  1154. /**
  1155. * Set the URL of the Imaginary service to send image previews to.
  1156. * Also requires the ``OC\Preview\Imaginary`` provider to be enabled.
  1157. *
  1158. * See https://github.com/h2non/imaginary
  1159. */
  1160. 'preview_imaginary_url' => 'http://previews_hpb:8088/',
  1161. /**
  1162. * If you want set a api key for imaginary.
  1163. */
  1164. 'preview_imaginary_key' => 'secret',
  1165. /**
  1166. * Only register providers that have been explicitly enabled
  1167. *
  1168. * The following providers are disabled by default due to performance or privacy
  1169. * concerns:
  1170. *
  1171. * - ``OC\Preview\Font``
  1172. * - ``OC\Preview\HEIC``
  1173. * - ``OC\Preview\Illustrator``
  1174. * - ``OC\Preview\Movie``
  1175. * - ``OC\Preview\MSOffice2003``
  1176. * - ``OC\Preview\MSOffice2007``
  1177. * - ``OC\Preview\MSOfficeDoc``
  1178. * - ``OC\Preview\PDF``
  1179. * - ``OC\Preview\Photoshop``
  1180. * - ``OC\Preview\Postscript``
  1181. * - ``OC\Preview\StarOffice``
  1182. * - ``OC\Preview\SVG``
  1183. * - ``OC\Preview\TIFF``
  1184. * - ``OC\Preview\EMF``
  1185. *
  1186. *
  1187. * Defaults to the following providers:
  1188. *
  1189. * - ``OC\Preview\BMP``
  1190. * - ``OC\Preview\GIF``
  1191. * - ``OC\Preview\JPEG``
  1192. * - ``OC\Preview\Krita``
  1193. * - ``OC\Preview\MarkDown``
  1194. * - ``OC\Preview\MP3``
  1195. * - ``OC\Preview\OpenDocument``
  1196. * - ``OC\Preview\PNG``
  1197. * - ``OC\Preview\TXT``
  1198. * - ``OC\Preview\XBitmap``
  1199. */
  1200. 'enabledPreviewProviders' => [
  1201. 'OC\Preview\BMP',
  1202. 'OC\Preview\GIF',
  1203. 'OC\Preview\JPEG',
  1204. 'OC\Preview\Krita',
  1205. 'OC\Preview\MarkDown',
  1206. 'OC\Preview\MP3',
  1207. 'OC\Preview\OpenDocument',
  1208. 'OC\Preview\PNG',
  1209. 'OC\Preview\TXT',
  1210. 'OC\Preview\XBitmap',
  1211. ],
  1212. /**
  1213. * LDAP
  1214. *
  1215. * Global settings used by LDAP User and Group Backend
  1216. */
  1217. /**
  1218. * defines the interval in minutes for the background job that checks user
  1219. * existence and marks them as ready to be cleaned up. The number is always
  1220. * minutes. Setting it to 0 disables the feature.
  1221. * See command line (occ) methods ``ldap:show-remnants`` and ``user:delete``
  1222. *
  1223. * Defaults to ``51`` minutes
  1224. */
  1225. 'ldapUserCleanupInterval' => 51,
  1226. /**
  1227. * Sort groups in the user settings by name instead of the user count
  1228. *
  1229. * By enabling this the user count beside the group name is disabled as well.
  1230. * @deprecated since Nextcloud 29 - Use the frontend instead or set the app config value `group.sortBy` for `core` to `2`
  1231. */
  1232. 'sort_groups_by_name' => false,
  1233. /**
  1234. * Comments
  1235. *
  1236. * Global settings for the Comments infrastructure
  1237. */
  1238. /**
  1239. * Replaces the default Comments Manager Factory. This can be utilized if an
  1240. * own or 3rdParty CommentsManager should be used that – for instance – uses the
  1241. * filesystem instead of the database to keep the comments.
  1242. *
  1243. * Defaults to ``\OC\Comments\ManagerFactory``
  1244. */
  1245. 'comments.managerFactory' => '\OC\Comments\ManagerFactory',
  1246. /**
  1247. * Replaces the default System Tags Manager Factory. This can be utilized if an
  1248. * own or 3rdParty SystemTagsManager should be used that – for instance – uses the
  1249. * filesystem instead of the database to keep the tags.
  1250. *
  1251. * Defaults to ``\OC\SystemTag\ManagerFactory``
  1252. */
  1253. 'systemtags.managerFactory' => '\OC\SystemTag\ManagerFactory',
  1254. /**
  1255. * Maintenance
  1256. *
  1257. * These options are for halting user activity when you are performing server
  1258. * maintenance.
  1259. */
  1260. /**
  1261. * Enable maintenance mode to disable Nextcloud
  1262. *
  1263. * If you want to prevent users from logging in to Nextcloud before you start
  1264. * doing some maintenance work, you need to set the value of the maintenance
  1265. * parameter to true. Please keep in mind that users who are already logged-in
  1266. * are kicked out of Nextcloud instantly.
  1267. *
  1268. * Defaults to ``false``
  1269. */
  1270. 'maintenance' => false,
  1271. /**
  1272. * UTC Hour for maintenance windows
  1273. *
  1274. * Some background jobs only run once a day. When an hour is defined for this config,
  1275. * the background jobs which advertise themselves as not time sensitive will be
  1276. * delayed during the "working" hours and only run in the 4 hours after the given time.
  1277. * This is e.g. used for activity expiration, suspicious login training and update checks.
  1278. *
  1279. * A value of 1 e.g. will only run these background jobs between 01:00am UTC and 05:00am UTC.
  1280. *
  1281. * Defaults to ``100`` which disables the feature
  1282. */
  1283. 'maintenance_window_start' => 1,
  1284. /**
  1285. * Log all LDAP requests into a file
  1286. *
  1287. * Warning: This heavily decreases the performance of the server and is only
  1288. * meant to debug/profile the LDAP interaction manually.
  1289. * Also, it might log sensitive data into a plain text file.
  1290. */
  1291. 'ldap_log_file' => '',
  1292. /**
  1293. * SSL
  1294. */
  1295. /**
  1296. * Extra SSL options to be used for configuration.
  1297. *
  1298. * Defaults to an empty array.
  1299. */
  1300. 'openssl' => [
  1301. 'config' => '/absolute/location/of/openssl.cnf',
  1302. ],
  1303. /**
  1304. * Memory caching backend configuration
  1305. *
  1306. * Available cache backends:
  1307. *
  1308. * * ``\OC\Memcache\APCu`` APC user backend
  1309. * * ``\OC\Memcache\ArrayCache`` In-memory array-based backend (not recommended)
  1310. * * ``\OC\Memcache\Memcached`` Memcached backend
  1311. * * ``\OC\Memcache\Redis`` Redis backend
  1312. *
  1313. * Advice on choosing between the various backends:
  1314. *
  1315. * * APCu should be easiest to install. Almost all distributions have packages.
  1316. * Use this for single user environment for all caches.
  1317. * * Use Redis or Memcached for distributed environments.
  1318. * For the local cache (you can configure two) take APCu.
  1319. */
  1320. /**
  1321. * Memory caching backend for locally stored data
  1322. *
  1323. * * Used for host-specific data, e.g. file paths
  1324. *
  1325. * Defaults to ``none``
  1326. */
  1327. 'memcache.local' => '\OC\Memcache\APCu',
  1328. /**
  1329. * Memory caching backend for distributed data
  1330. *
  1331. * * Used for installation-specific data, e.g. database caching
  1332. * * If unset, defaults to the value of memcache.local
  1333. *
  1334. * Defaults to ``none``
  1335. */
  1336. 'memcache.distributed' => '\OC\Memcache\Memcached',
  1337. /**
  1338. * Connection details for redis to use for memory caching in a single server configuration.
  1339. *
  1340. * For enhanced security it is recommended to configure Redis
  1341. * to require a password. See http://redis.io/topics/security
  1342. * for more information.
  1343. *
  1344. * We also support redis SSL/TLS encryption as of version 6.
  1345. * See https://redis.io/topics/encryption for more information.
  1346. */
  1347. 'redis' => [
  1348. 'host' => 'localhost', // can also be a unix domain socket: '/tmp/redis.sock'
  1349. 'port' => 6379,
  1350. 'timeout' => 0.0,
  1351. 'read_timeout' => 0.0,
  1352. 'user' => '', // Optional: if not defined, no password will be used.
  1353. 'password' => '', // Optional: if not defined, no password will be used.
  1354. 'dbindex' => 0, // Optional: if undefined SELECT will not run and will use Redis Server's default DB Index.
  1355. // If redis in-transit encryption is enabled, provide certificates
  1356. // SSL context https://www.php.net/manual/en/context.ssl.php
  1357. 'ssl_context' => [
  1358. 'local_cert' => '/certs/redis.crt',
  1359. 'local_pk' => '/certs/redis.key',
  1360. 'cafile' => '/certs/ca.crt'
  1361. ]
  1362. ],
  1363. /**
  1364. * Connection details for a Redis Cluster.
  1365. *
  1366. * Redis Cluster support requires the php module phpredis in version 3.0.0 or
  1367. * higher.
  1368. *
  1369. * Available failover modes:
  1370. * - \RedisCluster::FAILOVER_NONE - only send commands to master nodes (default)
  1371. * - \RedisCluster::FAILOVER_ERROR - failover to slaves for read commands if master is unavailable (recommended)
  1372. * - \RedisCluster::FAILOVER_DISTRIBUTE - randomly distribute read commands across master and slaves
  1373. *
  1374. * WARNING: FAILOVER_DISTRIBUTE is a not recommended setting, and we strongly
  1375. * suggest to not use it if you use Redis for file locking. Due to the way Redis
  1376. * is synchronized it could happen, that the read for an existing lock is
  1377. * scheduled to a slave that is not fully synchronized with the connected master
  1378. * which then causes a FileLocked exception.
  1379. *
  1380. * See https://redis.io/topics/cluster-spec for details about the Redis cluster
  1381. *
  1382. * Authentication works with phpredis version 4.2.1+. See
  1383. * https://github.com/phpredis/phpredis/commit/c5994f2a42b8a348af92d3acb4edff1328ad8ce1
  1384. */
  1385. 'redis.cluster' => [
  1386. 'seeds' => [ // provide some or all of the cluster servers to bootstrap discovery, port required
  1387. 'localhost:7000',
  1388. 'localhost:7001',
  1389. ],
  1390. 'timeout' => 0.0,
  1391. 'read_timeout' => 0.0,
  1392. 'failover_mode' => \RedisCluster::FAILOVER_ERROR,
  1393. 'user' => '', // Optional: if not defined, no password will be used.
  1394. 'password' => '', // Optional: if not defined, no password will be used.
  1395. // If redis in-transit encryption is enabled, provide certificates
  1396. // SSL context https://www.php.net/manual/en/context.ssl.php
  1397. 'ssl_context' => [
  1398. 'local_cert' => '/certs/redis.crt',
  1399. 'local_pk' => '/certs/redis.key',
  1400. 'cafile' => '/certs/ca.crt'
  1401. ]
  1402. ],
  1403. /**
  1404. * Server details for one or more memcached servers to use for memory caching.
  1405. */
  1406. 'memcached_servers' => [
  1407. // hostname, port and optional weight
  1408. // or path and port 0 for unix socket. Also see:
  1409. // https://www.php.net/manual/en/memcached.addservers.php
  1410. // https://www.php.net/manual/en/memcached.addserver.php
  1411. ['localhost', 11211],
  1412. //array('other.host.local', 11211),
  1413. ],
  1414. /**
  1415. * Connection options for memcached
  1416. */
  1417. 'memcached_options' => [
  1418. // Set timeouts to 50ms
  1419. \Memcached::OPT_CONNECT_TIMEOUT => 50,
  1420. \Memcached::OPT_RETRY_TIMEOUT => 50,
  1421. \Memcached::OPT_SEND_TIMEOUT => 50,
  1422. \Memcached::OPT_RECV_TIMEOUT => 50,
  1423. \Memcached::OPT_POLL_TIMEOUT => 50,
  1424. // Enable compression
  1425. \Memcached::OPT_COMPRESSION => true,
  1426. // Turn on consistent hashing
  1427. \Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
  1428. // Enable Binary Protocol
  1429. \Memcached::OPT_BINARY_PROTOCOL => true,
  1430. // Binary serializer vill be enabled if the igbinary PECL module is available
  1431. //\Memcached::OPT_SERIALIZER => \Memcached::SERIALIZER_IGBINARY,
  1432. ],
  1433. /**
  1434. * Location of the cache folder, defaults to ``data/$user/cache`` where
  1435. * ``$user`` is the current user. When specified, the format will change to
  1436. * ``$cache_path/$user`` where ``$cache_path`` is the configured cache directory
  1437. * and ``$user`` is the user.
  1438. *
  1439. * Defaults to ``''`` (empty string)
  1440. */
  1441. 'cache_path' => '',
  1442. /**
  1443. * TTL of chunks located in the cache folder before they're removed by
  1444. * garbage collection (in seconds). Increase this value if users have
  1445. * issues uploading very large files via the Nextcloud Client as upload isn't
  1446. * completed within one day.
  1447. *
  1448. * Defaults to ``60*60*24`` (1 day)
  1449. */
  1450. 'cache_chunk_gc_ttl' => 60*60*24,
  1451. /**
  1452. * Using Object Store with Nextcloud
  1453. */
  1454. /**
  1455. * This example shows how to configure Nextcloud to store all files in a
  1456. * swift object storage.
  1457. *
  1458. * It is important to note that Nextcloud in object store mode will expect
  1459. * exclusive access to the object store container because it only stores the
  1460. * binary data for each file. The metadata is currently kept in the local
  1461. * database for performance reasons.
  1462. *
  1463. * WARNING: The current implementation is incompatible with any app that uses
  1464. * direct file IO and circumvents our virtual filesystem. That includes
  1465. * Encryption and Gallery. Gallery will store thumbnails directly in the
  1466. * filesystem and encryption will cause severe overhead because key files need
  1467. * to be fetched in addition to any requested file.
  1468. *
  1469. */
  1470. 'objectstore' => [
  1471. 'class' => 'OC\\Files\\ObjectStore\\Swift',
  1472. 'arguments' => [
  1473. // trystack will use your facebook id as the username
  1474. 'username' => 'facebook100000123456789',
  1475. // in the trystack dashboard go to user -> settings -> API Password to
  1476. // generate a password
  1477. 'password' => 'Secr3tPaSSWoRdt7',
  1478. // must already exist in the objectstore, name can be different
  1479. 'container' => 'nextcloud',
  1480. // prefix to prepend to the fileid, default is 'oid:urn:'
  1481. 'objectPrefix' => 'oid:urn:',
  1482. // create the container if it does not exist. default is false
  1483. 'autocreate' => true,
  1484. // required, dev-/trystack defaults to 'RegionOne'
  1485. 'region' => 'RegionOne',
  1486. // The Identity / Keystone endpoint
  1487. 'url' => 'http://8.21.28.222:5000/v2.0',
  1488. // uploadPartSize: size of the uploaded chunks, defaults to 524288000
  1489. 'uploadPartSize' => 524288000,
  1490. // required on dev-/trystack
  1491. 'tenantName' => 'facebook100000123456789',
  1492. // dev-/trystack uses swift by default, the lib defaults to 'cloudFiles'
  1493. // if omitted
  1494. 'serviceName' => 'swift',
  1495. // The Interface / url Type, optional
  1496. 'urlType' => 'internal'
  1497. ],
  1498. ],
  1499. /**
  1500. * To use swift V3
  1501. */
  1502. 'objectstore' => [
  1503. 'class' => 'OC\\Files\\ObjectStore\\Swift',
  1504. 'arguments' => [
  1505. 'autocreate' => true,
  1506. 'user' => [
  1507. 'name' => 'swift',
  1508. 'password' => 'swift',
  1509. 'domain' => [
  1510. 'name' => 'default',
  1511. ],
  1512. ],
  1513. 'scope' => [
  1514. 'project' => [
  1515. 'name' => 'service',
  1516. 'domain' => [
  1517. 'name' => 'default',
  1518. ],
  1519. ],
  1520. ],
  1521. 'tenantName' => 'service',
  1522. 'serviceName' => 'swift',
  1523. 'region' => 'regionOne',
  1524. 'url' => 'http://yourswifthost:5000/v3',
  1525. 'bucket' => 'nextcloud',
  1526. ],
  1527. ],
  1528. /**
  1529. * If this is set to true and a multibucket object store is configured then
  1530. * newly created previews are put into 256 dedicated buckets.
  1531. *
  1532. * Those buckets are named like the mulibucket version but with the postfix
  1533. * ``-preview-NUMBER`` where NUMBER is between 0 and 255.
  1534. *
  1535. * Keep in mind that only previews of files are put in there that don't have
  1536. * some already. Otherwise, the old bucket will be used.
  1537. *
  1538. * To migrate existing previews to this new multibucket distribution of previews
  1539. * use the occ command ``preview:repair``. For now this will only migrate
  1540. * previews that were generated before Nextcloud 19 in the flat
  1541. * ``appdata_INSTANCEID/previews/FILEID`` folder structure.
  1542. */
  1543. 'objectstore.multibucket.preview-distribution' => false,
  1544. /**
  1545. * Sharing
  1546. *
  1547. * Global settings for Sharing
  1548. */
  1549. /**
  1550. * Replaces the default Share Provider Factory. This can be utilized if
  1551. * own or 3rdParty Share Providers are used that – for instance – use the
  1552. * filesystem instead of the database to keep the share information.
  1553. *
  1554. * Defaults to ``\OC\Share20\ProviderFactory``
  1555. */
  1556. 'sharing.managerFactory' => '\OC\Share20\ProviderFactory',
  1557. /**
  1558. * Enables expiration for link share passwords sent by email (sharebymail).
  1559. * The passwords will expire after the configured interval, the users can
  1560. * still request a new one in the public link page.
  1561. */
  1562. 'sharing.enable_mail_link_password_expiration' => false,
  1563. /**
  1564. * Expiration interval for passwords, in seconds.
  1565. */
  1566. 'sharing.mail_link_password_expiration_interval' => 3600,
  1567. /**
  1568. * Define max number of results returned by the search for auto-completion of
  1569. * users, groups, etc. The value must not be lower than 0 (for unlimited).
  1570. *
  1571. * If more, different sources are requested (e.g. different user backends; or
  1572. * both users and groups), the value is applied per source and might not be
  1573. * truncated after collecting the results. I.e. more results can appear than
  1574. * configured here.
  1575. *
  1576. * Default is 25.
  1577. */
  1578. 'sharing.maxAutocompleteResults' => 25,
  1579. /**
  1580. * Define the minimum length of the search string before we start auto-completion
  1581. * Default is no limit (value set to 0)
  1582. */
  1583. 'sharing.minSearchStringLength' => 0,
  1584. /**
  1585. * Set to true to enable that internal shares need to be accepted by the users by default.
  1586. * Users can change this for their account in their personal sharing settings
  1587. */
  1588. 'sharing.enable_share_accept' => false,
  1589. /**
  1590. * Set to true to enforce that internal shares need to be accepted
  1591. */
  1592. 'sharing.force_share_accept' => false,
  1593. /**
  1594. * Set to ``false``, to prevent users from setting a custom share_folder
  1595. */
  1596. 'sharing.allow_custom_share_folder' => true,
  1597. /**
  1598. * Define a default folder for shared files and folders other than root.
  1599. * Changes to this value will only have effect on new shares.
  1600. *
  1601. * Defaults to ``/``
  1602. */
  1603. 'share_folder' => '/',
  1604. /**
  1605. * Set to ``false``, to stop sending a mail when users receive a share
  1606. */
  1607. 'sharing.enable_share_mail' => true,
  1608. /**
  1609. * Set to true to enable the feature to add exceptions for share password enforcement
  1610. */
  1611. 'sharing.allow_disabled_password_enforcement_groups' => false,
  1612. /**
  1613. * Set to true to always transfer incoming shares by default
  1614. * when running "occ files:transfer-ownership".
  1615. * Defaults to false, so incoming shares are not transferred if not specifically requested
  1616. * by a command line argument.
  1617. */
  1618. 'transferIncomingShares' => false,
  1619. /**
  1620. * Hashing
  1621. */
  1622. /**
  1623. * By default, Nextcloud will use the Argon2 password hashing if available.
  1624. * However, if for whatever reason you want to stick with the PASSWORD_DEFAULT
  1625. * of your php version. Then set the setting to true.
  1626. *
  1627. * Nextcloud uses the Argon2 algorithm (with PHP >= 7.2) to create hashes by its
  1628. * own and exposes its configuration options as following. More information can
  1629. * be found at: https://www.php.net/manual/en/function.password-hash.php
  1630. */
  1631. 'hashing_default_password' => false,
  1632. /**
  1633. * The number of CPU threads to be used by the algorithm for computing a hash.
  1634. * The value must be an integer, and the minimum value is 1. Rationally it does
  1635. * not help to provide a number higher than the available threads on the machine.
  1636. * Values that undershoot the minimum will be ignored in favor of the minimum.
  1637. */
  1638. 'hashingThreads' => PASSWORD_ARGON2_DEFAULT_THREADS,
  1639. /**
  1640. * The memory in KiB to be used by the algorithm for computing a hash. The value
  1641. * must be an integer, and the minimum value is 8 times the number of CPU threads.
  1642. * Values that undershoot the minimum will be ignored in favor of the minimum.
  1643. */
  1644. 'hashingMemoryCost' => PASSWORD_ARGON2_DEFAULT_MEMORY_COST,
  1645. /**
  1646. * The number of iterations that are used by the algorithm for computing a hash.
  1647. * The value must be an integer, and the minimum value is 1. Values that
  1648. * undershoot the minimum will be ignored in favor of the minimum.
  1649. */
  1650. 'hashingTimeCost' => PASSWORD_ARGON2_DEFAULT_TIME_COST,
  1651. /**
  1652. * The hashing cost used by hashes generated by Nextcloud
  1653. * Using a higher value requires more time and CPU power to calculate the hashes
  1654. */
  1655. 'hashingCost' => 10,
  1656. /**
  1657. * All other configuration options
  1658. */
  1659. /**
  1660. * Additional driver options for the database connection, e.g. to enable SSL
  1661. * encryption in MySQL or specify a custom wait timeout on a cheap hoster.
  1662. *
  1663. * When setting up TLS/SSL for encrypting the connections, you need to ensure that
  1664. * the passed keys and certificates are readable by the PHP process. In addition,
  1665. * PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT might need to be set to false, if the
  1666. * database servers certificates CN does not match with the hostname used to connect.
  1667. * The standard behavior here is different from the MySQL/MariaDB CLI client, which
  1668. * does not verify the server cert except --ssl-verify-server-cert is passed manually.
  1669. */
  1670. 'dbdriveroptions' => [
  1671. PDO::MYSQL_ATTR_SSL_CA => '/file/path/to/ca_cert.pem',
  1672. PDO::MYSQL_ATTR_SSL_KEY => '/file/path/to/mysql-client-key.pem',
  1673. PDO::MYSQL_ATTR_SSL_CERT => '/file/path/to/mysql-client-cert.pem',
  1674. PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => false,
  1675. PDO::MYSQL_ATTR_INIT_COMMAND => 'SET wait_timeout = 28800'
  1676. ],
  1677. /**
  1678. * sqlite3 journal mode can be specified using this configuration parameter -
  1679. * can be 'WAL' or 'DELETE' see for more details https://www.sqlite.org/wal.html
  1680. */
  1681. 'sqlite.journal_mode' => 'DELETE',
  1682. /**
  1683. * During setup, if requirements are met (see below), this setting is set to true
  1684. * and MySQL can handle 4 byte characters instead of 3 byte characters.
  1685. *
  1686. * If you want to convert an existing 3-byte setup into a 4-byte setup please
  1687. * set the parameters in MySQL as mentioned below and run the migration command:
  1688. * ./occ db:convert-mysql-charset
  1689. * The config setting will be set automatically after a successful run.
  1690. *
  1691. * Consult the documentation for more details.
  1692. *
  1693. * MySQL requires a special setup for longer indexes (> 767 bytes) which are
  1694. * needed:
  1695. *
  1696. * [mysqld]
  1697. * innodb_large_prefix=ON
  1698. * innodb_file_format=Barracuda
  1699. * innodb_file_per_table=ON
  1700. *
  1701. * Tables will be created with
  1702. * * character set: utf8mb4
  1703. * * collation: utf8mb4_bin
  1704. * * row_format: dynamic
  1705. *
  1706. * See:
  1707. * https://dev.mysql.com/doc/refman/5.7/en/charset-unicode-utf8mb4.html
  1708. * https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_large_prefix
  1709. * https://mariadb.com/kb/en/mariadb/xtradbinnodb-server-system-variables/#innodb_large_prefix
  1710. * http://www.tocker.ca/2013/10/31/benchmarking-innodb-page-compression-performance.html
  1711. * http://mechanics.flite.com/blog/2014/07/29/using-innodb-large-prefix-to-avoid-error-1071/
  1712. */
  1713. 'mysql.utf8mb4' => false,
  1714. /**
  1715. * For search queries in the database, a default collation – depending on the
  1716. * character set – is chosen. In some cases a different behaviour is desired,
  1717. * for instances when an accent sensitive search is desired.
  1718. *
  1719. * MariaDB and MySQL have an overlap in available collations, but also
  1720. * incompatible ones, also depending on the version of the database server.
  1721. *
  1722. * This option allows to override the automatic choice. Example:
  1723. *
  1724. * 'mysql.collation' => 'utf8mb4_0900_as_ci',
  1725. *
  1726. * This setting has no effect on setup or creating tables. In those cases
  1727. * always utf8[mb4]_bin is being used. This setting is only taken into
  1728. * consideration in SQL queries that utilize LIKE comparison operators.
  1729. */
  1730. 'mysql.collation' => null,
  1731. /**
  1732. * Database types that are supported for installation.
  1733. *
  1734. * Available:
  1735. * - sqlite (SQLite3)
  1736. * - mysql (MySQL)
  1737. * - pgsql (PostgreSQL)
  1738. * - oci (Oracle)
  1739. *
  1740. * Defaults to the following databases:
  1741. * - sqlite (SQLite3)
  1742. * - mysql (MySQL)
  1743. * - pgsql (PostgreSQL)
  1744. */
  1745. 'supportedDatabases' => [
  1746. 'sqlite',
  1747. 'mysql',
  1748. 'pgsql',
  1749. 'oci',
  1750. ],
  1751. /**
  1752. * Override where Nextcloud stores temporary files. Useful in situations where
  1753. * the system temporary directory is on a limited space ramdisk or is otherwise
  1754. * restricted, or if external storage which do not support streaming are in
  1755. * use.
  1756. *
  1757. * The Web server user/PHP must have write access to this directory.
  1758. * Additionally you have to make sure that your PHP configuration considers this a valid
  1759. * tmp directory, by setting the TMP, TMPDIR, and TEMP variables to the required directories.
  1760. * On top of that you might be required to grant additional permissions in AppArmor or SELinux.
  1761. */
  1762. 'tempdirectory' => '/tmp/nextcloudtemp',
  1763. /**
  1764. * Override where Nextcloud stores update files while updating. Useful in situations
  1765. * where the default `datadirectory` is on network disk like NFS, or is otherwise
  1766. * restricted. Defaults to the value of `datadirectory` if unset.
  1767. *
  1768. * If set, the value MUST be located _outside_ of the installation directory of Nextcloud and
  1769. * writable by the Web server user.
  1770. *
  1771. */
  1772. 'updatedirectory' => '',
  1773. /**
  1774. * Blacklist a specific file or files and disallow the upload of files
  1775. * with this name. ``.htaccess`` is blocked by default.
  1776. * WARNING: USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING.
  1777. *
  1778. * Defaults to ``array('.htaccess')``
  1779. */
  1780. 'blacklisted_files' => ['.htaccess'],
  1781. /**
  1782. * Blacklist characters from being used in filenames. This is useful if you
  1783. * have a filesystem or OS which does not support certain characters like windows.
  1784. *
  1785. * The '/' and '\' characters are always forbidden.
  1786. *
  1787. * Example for windows systems: ``array('?', '<', '>', ':', '*', '|', '"', chr(0), "\n", "\r")``
  1788. * see https://en.wikipedia.org/wiki/Comparison_of_file_systems#Limits
  1789. *
  1790. * Defaults to ``array()``
  1791. */
  1792. 'forbidden_chars' => [],
  1793. /**
  1794. * If you are applying a theme to Nextcloud, enter the name of the theme here.
  1795. * The default location for themes is ``nextcloud/themes/``.
  1796. *
  1797. * Defaults to the theming app which is shipped since Nextcloud 9
  1798. */
  1799. 'theme' => '',
  1800. /**
  1801. * Enforce the user theme. This will disable the user theming settings
  1802. * This must be a valid ITheme ID.
  1803. * E.g. dark, dark-highcontrast, default, light, light-highcontrast, opendyslexic
  1804. */
  1805. 'enforce_theme' => '',
  1806. /**
  1807. * The default cipher for encrypting files. Currently supported are:
  1808. * - AES-256-CTR
  1809. * - AES-128-CTR
  1810. * - AES-256-CFB
  1811. * - AES-128-CFB
  1812. *
  1813. * Defaults to ``AES-256-CTR``
  1814. */
  1815. 'cipher' => 'AES-256-CTR',
  1816. /**
  1817. * Use the legacy base64 format for encrypted files instead of the more space-efficient
  1818. * binary format. The option affects only newly written files, existing encrypted files
  1819. * will not be touched and will remain readable whether they use the new format or not.
  1820. *
  1821. * Defaults to ``false``
  1822. */
  1823. 'encryption.use_legacy_base64_encoding' => false,
  1824. /**
  1825. * The minimum Nextcloud desktop client version that will be allowed to sync with
  1826. * this server instance. All connections made from earlier clients will be denied
  1827. * by the server. Defaults to the minimum officially supported Nextcloud desktop
  1828. * client version at the time of release of this server version.
  1829. *
  1830. * When changing this, note that older unsupported versions of the Nextcloud desktop
  1831. * client may not function as expected, and could lead to permanent data loss for
  1832. * clients or other unexpected results.
  1833. *
  1834. * Defaults to ``2.3.0``
  1835. */
  1836. 'minimum.supported.desktop.version' => '2.3.0',
  1837. /**
  1838. * Option to allow local storage to contain symlinks.
  1839. * WARNING: Not recommended. This would make it possible for Nextcloud to access
  1840. * files outside the data directory and could be considered a security risk.
  1841. *
  1842. * Defaults to ``false``
  1843. */
  1844. 'localstorage.allowsymlinks' => false,
  1845. /**
  1846. * Nextcloud overrides umask to ensure suitable access permissions
  1847. * regardless of webserver/php-fpm configuration and worker state.
  1848. * WARNING: Modifying this value has security implications and
  1849. * may soft-break the installation.
  1850. *
  1851. * Most installs shall not modify this value.
  1852. *
  1853. * Defaults to ``0022``
  1854. */
  1855. 'localstorage.umask' => 0022,
  1856. /**
  1857. * This options allows storage systems that don't allow to modify existing files
  1858. * to overcome this limitation by removing the files before overwriting.
  1859. *
  1860. * Defaults to ``false``
  1861. */
  1862. 'localstorage.unlink_on_truncate' => false,
  1863. /**
  1864. * EXPERIMENTAL: option whether to include external storage in quota
  1865. * calculation, defaults to false.
  1866. *
  1867. * Defaults to ``false``
  1868. */
  1869. 'quota_include_external_storage' => false,
  1870. /**
  1871. * When an external storage is unavailable for some reasons, it will be flagged
  1872. * as such for 10 minutes. When the trigger is a failed authentication attempt
  1873. * the delay is higher and can be controlled with this option. The motivation
  1874. * is to make account lock outs at Active Directories (and compatible) more
  1875. * unlikely.
  1876. *
  1877. * Defaults to ``1800`` (seconds)
  1878. */
  1879. 'external_storage.auth_availability_delay' => 1800,
  1880. /**
  1881. * Allows to create external storages of type "Local" in the web interface and APIs.
  1882. *
  1883. * When disabled, it is still possible to create local storages with occ using
  1884. * the following command:
  1885. *
  1886. * % php occ files_external:create /mountpoint local null::null -c datadir=/path/to/data
  1887. *
  1888. * Defaults to ``true``
  1889. *
  1890. */
  1891. 'files_external_allow_create_new_local' => true,
  1892. /**
  1893. * Specifies how often the local filesystem (the Nextcloud data/ directory, and
  1894. * NFS mounts in data/) is checked for changes made outside Nextcloud. This
  1895. * does not apply to external storage.
  1896. *
  1897. * 0 -> Never check the filesystem for outside changes, provides a performance
  1898. * increase when it's certain that no changes are made directly to the
  1899. * filesystem
  1900. *
  1901. * 1 -> Check each file or folder at most once per request, recommended for
  1902. * general use if outside changes might happen.
  1903. *
  1904. * Defaults to ``0``
  1905. */
  1906. 'filesystem_check_changes' => 0,
  1907. /**
  1908. * By default, Nextcloud will store the part files created during upload in the
  1909. * same storage as the upload target. Setting this to false will store the part
  1910. * files in the root of the users folder which might be required to work with certain
  1911. * external storage setups that have limited rename capabilities.
  1912. *
  1913. * Defaults to ``true``
  1914. */
  1915. 'part_file_in_storage' => true,
  1916. /**
  1917. * Where ``mount.json`` file should be stored, defaults to ``data/mount.json``
  1918. * in the Nextcloud directory.
  1919. *
  1920. * Defaults to ``data/mount.json`` in the Nextcloud directory.
  1921. */
  1922. 'mount_file' => '/var/www/nextcloud/data/mount.json',
  1923. /**
  1924. * When ``true``, prevent Nextcloud from changing the cache due to changes in
  1925. * the filesystem for all storage.
  1926. *
  1927. * Defaults to ``false``
  1928. */
  1929. 'filesystem_cache_readonly' => false,
  1930. /**
  1931. * List of trusted proxy servers
  1932. *
  1933. * You may set this to an array containing a combination of
  1934. * - IPv4 addresses, e.g. `192.168.2.123`
  1935. * - IPv4 ranges in CIDR notation, e.g. `192.168.2.0/24`
  1936. * - IPv6 addresses, e.g. `fd9e:21a7:a92c:2323::1`
  1937. * - IPv6 ranges in CIDR notation, e.g. `2001:db8:85a3:8d3:1319:8a20::/95`
  1938. *
  1939. * When an incoming request's `REMOTE_ADDR` matches any of the IP addresses
  1940. * specified here, it is assumed to be a proxy instead of a client. Thus, the
  1941. * client IP will be read from the HTTP header specified in
  1942. * `forwarded_for_headers` instead of from `REMOTE_ADDR`.
  1943. *
  1944. * So if you configure `trusted_proxies`, also consider setting
  1945. * `forwarded_for_headers` which otherwise defaults to `HTTP_X_FORWARDED_FOR`
  1946. * (the `X-Forwarded-For` header).
  1947. *
  1948. * Defaults to an empty array.
  1949. */
  1950. 'trusted_proxies' => ['203.0.113.45', '198.51.100.128', '192.168.2.0/24'],
  1951. /**
  1952. * Headers that should be trusted as client IP address in combination with
  1953. * `trusted_proxies`. If the HTTP header looks like 'X-Forwarded-For', then use
  1954. * 'HTTP_X_FORWARDED_FOR' here.
  1955. *
  1956. * If set incorrectly, a client can spoof their IP address as visible to
  1957. * Nextcloud, bypassing access controls and making logs useless!
  1958. *
  1959. * Defaults to ``'HTTP_X_FORWARDED_FOR'``
  1960. */
  1961. 'forwarded_for_headers' => ['HTTP_X_FORWARDED', 'HTTP_FORWARDED_FOR'],
  1962. /**
  1963. * max file size for animating gifs on public-sharing-site.
  1964. * If the gif is bigger, it'll show a static preview
  1965. *
  1966. * Value represents the maximum filesize in megabytes. Set to ``-1`` for
  1967. * no limit.
  1968. *
  1969. * Defaults to ``10`` megabytes
  1970. */
  1971. 'max_filesize_animated_gifs_public_sharing' => 10,
  1972. /**
  1973. * Enables transactional file locking.
  1974. * This is enabled by default.
  1975. *
  1976. * Prevents concurrent processes from accessing the same files
  1977. * at the same time. Can help prevent side effects that would
  1978. * be caused by concurrent operations. Mainly relevant for
  1979. * very large installations with many users working with
  1980. * shared files.
  1981. *
  1982. * Defaults to ``true``
  1983. */
  1984. 'filelocking.enabled' => true,
  1985. /**
  1986. * Set the lock's time-to-live in seconds.
  1987. *
  1988. * Any lock older than this will be automatically cleaned up.
  1989. *
  1990. * Defaults to ``60*60`` seconds (1 hour) or the php
  1991. * max_execution_time, whichever is higher.
  1992. */
  1993. 'filelocking.ttl' => 60*60,
  1994. /**
  1995. * Memory caching backend for file locking
  1996. *
  1997. * Because most memcache backends can clean values without warning using redis
  1998. * is highly recommended to *avoid data loss*.
  1999. *
  2000. * Defaults to ``none``
  2001. */
  2002. 'memcache.locking' => '\\OC\\Memcache\\Redis',
  2003. /**
  2004. * Enable locking debug logging
  2005. *
  2006. * Note that this can lead to a very large volume of log items being written which can lead
  2007. * to performance degradation and large log files on busy instance.
  2008. *
  2009. * Thus enabling this in production for longer periods of time is not recommended
  2010. * or should be used together with the ``log.condition`` setting.
  2011. */
  2012. 'filelocking.debug' => false,
  2013. /**
  2014. * Disable the web based updater
  2015. */
  2016. 'upgrade.disable-web' => false,
  2017. /**
  2018. * Allows to modify the cli-upgrade link in order to link to a different documentation
  2019. */
  2020. 'upgrade.cli-upgrade-link' => '',
  2021. /**
  2022. * Allows to modify the exception server logs documentation link in order to link to a different documentation
  2023. */
  2024. 'documentation_url.server_logs' => '',
  2025. /**
  2026. * Set this Nextcloud instance to debugging mode
  2027. *
  2028. * Only enable this for local development and not in production environments
  2029. * This will disable the minifier and outputs some additional debug information
  2030. *
  2031. * Defaults to ``false``
  2032. */
  2033. 'debug' => false,
  2034. /**
  2035. * Sets the data-fingerprint of the current data served
  2036. *
  2037. * This is a property used by the clients to find out if a backup has been
  2038. * restored on the server. Once a backup is restored run
  2039. * ./occ maintenance:data-fingerprint
  2040. * To set this to a new value.
  2041. *
  2042. * Updating/Deleting this value can make connected clients stall until
  2043. * the user has resolved conflicts.
  2044. *
  2045. * Defaults to ``''`` (empty string)
  2046. */
  2047. 'data-fingerprint' => '',
  2048. /**
  2049. * This entry is just here to show a warning in case somebody copied the sample
  2050. * configuration. DO NOT ADD THIS SWITCH TO YOUR CONFIGURATION!
  2051. *
  2052. * If you, brave person, have read until here be aware that you should not
  2053. * modify *ANY* settings in this file without reading the documentation.
  2054. */
  2055. 'copied_sample_config' => true,
  2056. /**
  2057. * use a custom lookup server to publish user data
  2058. */
  2059. 'lookup_server' => 'https://lookup.nextcloud.com',
  2060. /**
  2061. * set to true if the server is used in a setup based on Nextcloud's Global Scale architecture
  2062. */
  2063. 'gs.enabled' => false,
  2064. /**
  2065. * by default federation is only used internally in a Global Scale setup
  2066. * If you want to allow federation outside your environment set it to 'global'
  2067. */
  2068. 'gs.federation' => 'internal',
  2069. /**
  2070. * List of incompatible user agents opted out from Same Site Cookie Protection.
  2071. * Some user agents are notorious and don't really properly follow HTTP
  2072. * specifications. For those, have an opt-out.
  2073. *
  2074. * WARNING: only use this if you know what you are doing
  2075. */
  2076. 'csrf.optout' => [
  2077. '/^WebDAVFS/', // OS X Finder
  2078. '/^Microsoft-WebDAV-MiniRedir/', // Windows webdav drive
  2079. ],
  2080. /**
  2081. * By default, there is on public pages a link shown that allows users to
  2082. * learn about the "simple sign up" - see https://nextcloud.com/signup/
  2083. *
  2084. * If this is set to "false" it will not show the link.
  2085. */
  2086. 'simpleSignUpLink.shown' => true,
  2087. /**
  2088. * By default, autocompletion is enabled for the login form on Nextcloud's login page.
  2089. * While this is enabled, browsers are allowed to "remember" login names and such.
  2090. * Some companies require it to be disabled to comply with their security policy.
  2091. *
  2092. * Simply set this property to "false", if you want to turn this feature off.
  2093. */
  2094. 'login_form_autocomplete' => true,
  2095. /**
  2096. * Timeout for the login form, after this time the login form is reset.
  2097. * This prevents password leaks on public devices if the user forgots to clear the form.
  2098. *
  2099. * Default is 5 minutes (300 seconds), a value of 0 means no timeout.
  2100. */
  2101. 'login_form_timeout' => 300,
  2102. /**
  2103. * If your user is using an outdated or unsupported browser, a warning will be shown
  2104. * to offer some guidance to upgrade or switch and ensure a proper Nextcloud experience.
  2105. * They can still bypass it after they have read the warning.
  2106. *
  2107. * Simply set this property to "true", if you want to turn this feature off.
  2108. */
  2109. 'no_unsupported_browser_warning' => false,
  2110. /**
  2111. * Disable background scanning of files
  2112. *
  2113. * By default, a background job runs every 10 minutes and execute a background
  2114. * scan to sync filesystem and database. Only users with unscanned files
  2115. * (size < 0 in filecache) are included. Maximum 500 users per job.
  2116. *
  2117. * Defaults to ``false``
  2118. */
  2119. 'files_no_background_scan' => false,
  2120. /**
  2121. * Log all queries into a file
  2122. *
  2123. * Warning: This heavily decreases the performance of the server and is only
  2124. * meant to debug/profile the query interaction manually.
  2125. * Also, it might log sensitive data into a plain text file.
  2126. */
  2127. 'query_log_file' => '',
  2128. /**
  2129. * Log all redis requests into a file
  2130. *
  2131. * Warning: This heavily decreases the performance of the server and is only
  2132. * meant to debug/profile the redis interaction manually.
  2133. * Also, it might log sensitive data into a plain text file.
  2134. */
  2135. 'redis_log_file' => '',
  2136. /**
  2137. * Enable diagnostics event logging
  2138. *
  2139. * If enabled the timings of common execution steps will be logged to the
  2140. * Nextcloud log at debug level. log.condition is useful to enable this on
  2141. * production systems to only log under some conditions
  2142. */
  2143. 'diagnostics.logging' => true,
  2144. /**
  2145. * Limit diagnostics event logging to events longer than the configured threshold in ms
  2146. *
  2147. * when set to 0 no diagnostics events will be logged
  2148. */
  2149. 'diagnostics.logging.threshold' => 0,
  2150. /**
  2151. * Enable profile globally
  2152. *
  2153. * Defaults to ``true``
  2154. */
  2155. 'profile.enabled' => true,
  2156. /**
  2157. * Allows to override the default scopes for Account data.
  2158. * The list of overridable properties and valid values for scopes are in
  2159. * ``OCP\Accounts\IAccountManager``. Values added here are merged with
  2160. * default values, which are in ``OC\Accounts\AccountManager``.
  2161. *
  2162. * For instance, if the phone property should default to the private scope
  2163. * instead of the local one:
  2164. *
  2165. * ::
  2166. *
  2167. * [
  2168. * \OCP\Accounts\IAccountManager::PROPERTY_PHONE => \OCP\Accounts\IAccountManager::SCOPE_PRIVATE
  2169. * ]
  2170. *
  2171. */
  2172. 'account_manager.default_property_scope' => [],
  2173. /**
  2174. * Enable the deprecated Projects feature,
  2175. * superseded by Related resources as of Nextcloud 25
  2176. *
  2177. * Defaults to ``false``
  2178. */
  2179. 'projects.enabled' => false,
  2180. /**
  2181. * Enable the bulk upload feature.
  2182. *
  2183. * Defaults to ``true``
  2184. */
  2185. 'bulkupload.enabled' => true,
  2186. /**
  2187. * Enables fetching open graph metadata from remote urls
  2188. *
  2189. * Defaults to ``true``
  2190. */
  2191. 'reference_opengraph' => true,
  2192. /**
  2193. * Enable use of old unified search
  2194. *
  2195. * Defaults to ``false``
  2196. */
  2197. 'unified_search.enabled' => false,
  2198. /**
  2199. * Enable features that are do respect accessibility standards yet.
  2200. *
  2201. * Defaults to ``true``
  2202. */
  2203. 'enable_non-accessible_features' => true,
  2204. ];