config.sample.php 73 KB

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