config.sample.php 56 KB

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