config.sample.php 47 KB

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