config.sample.php 67 KB

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