config.sample.php 76 KB

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