1
0

config.sample.php 75 KB

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