1
0

config.sample.php 47 KB

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