config.sample.php 67 KB

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