config.sample.php 71 KB

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