1
0

config.sample.php 73 KB

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