config.sample.php 51 KB

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