config.sample.php 74 KB

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