config.sample.php 52 KB

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