You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

config.sample.php 51KB

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