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 46KB

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