You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

config.sample.php 68KB

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