config.sample.php 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224
  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. */
  54. 'trusted_domains' =>
  55. array (
  56. 'demo.example.org',
  57. 'otherdomain.example.org',
  58. ),
  59. /**
  60. * Where user files are stored; this defaults to ``data/`` in the Nextcloud
  61. * directory. The SQLite database is also stored here, when you use SQLite.
  62. */
  63. 'datadirectory' => '/var/www/nextcloud/data',
  64. /**
  65. * The current version number of your Nextcloud installation. This is set up
  66. * during installation and update, so you shouldn't need to change it.
  67. */
  68. 'version' => '',
  69. /**
  70. * Identifies the database used with this installation. See also config option
  71. * ``supportedDatabases``
  72. *
  73. * Available:
  74. * - sqlite (SQLite3)
  75. * - mysql (MySQL/MariaDB)
  76. * - pgsql (PostgreSQL)
  77. * - oci (Oracle)
  78. */
  79. 'dbtype' => 'sqlite',
  80. /**
  81. * Your host server name, for example ``localhost``, ``hostname``,
  82. * ``hostname.example.com``, or the IP address. To specify a port use
  83. * ``hostname:####``; to specify a Unix socket use
  84. * ``localhost:/path/to/socket``.
  85. */
  86. 'dbhost' => '',
  87. /**
  88. * The name of the Nextcloud database, which is set during installation. You
  89. * should not need to change this.
  90. */
  91. 'dbname' => 'nextcloud',
  92. /**
  93. * The user that Nextcloud uses to write to the database. This must be unique
  94. * across Nextcloud instances using the same SQL database. This is set up during
  95. * installation, so you shouldn't need to change it.
  96. */
  97. 'dbuser' => '',
  98. /**
  99. * The password for the database user. This is set up during installation, so
  100. * you shouldn't need to change it.
  101. */
  102. 'dbpassword' => '',
  103. /**
  104. * Prefix for the Nextcloud tables in the database.
  105. */
  106. 'dbtableprefix' => '',
  107. /**
  108. * Indicates whether the Nextcloud instance was installed successfully; ``true``
  109. * indicates a successful installation, and ``false`` indicates an unsuccessful
  110. * installation.
  111. */
  112. 'installed' => false,
  113. /**
  114. * User Experience
  115. *
  116. * These optional parameters control some aspects of the user interface. Default
  117. * values, where present, are shown.
  118. */
  119. /**
  120. * This sets the default language on your Nextcloud server, using ISO_639-1
  121. * language codes such as ``en`` for English, ``de`` for German, and ``fr`` for
  122. * French. It overrides automatic language detection on public pages like login
  123. * or shared items. User's language preferences configured under "personal ->
  124. * language" override this setting after they have logged in.
  125. */
  126. 'default_language' => 'en',
  127. /**
  128. * Set the default app to open on login. Use the app names as they appear in the
  129. * URL after clicking them in the Apps menu, such as documents, calendar, and
  130. * gallery. You can use a comma-separated list of app names, so if the first
  131. * app is not enabled for a user then Nextcloud will try the second one, and so
  132. * on. If no enabled apps are found it defaults to the Files app.
  133. */
  134. 'defaultapp' => 'files',
  135. /**
  136. * ``true`` enables the Help menu item in the user menu (top right of the
  137. * Nextcloud Web interface). ``false`` removes the Help item.
  138. */
  139. 'knowledgebaseenabled' => true,
  140. /**
  141. * ``true`` enables avatars, or user profile photos. These appear on the User
  142. * page, on user's Personal pages and are used by some apps (contacts, mail,
  143. * etc). ``false`` disables them.
  144. */
  145. 'enable_avatars' => true,
  146. /**
  147. * ``true`` allows users to change their display names (on their Personal
  148. * pages), and ``false`` prevents them from changing their display names.
  149. */
  150. 'allow_user_to_change_display_name' => true,
  151. /**
  152. * Lifetime of the remember login cookie, which is set when the user clicks the
  153. * ``remember`` checkbox on the login screen. The default is 15 days, expressed
  154. * in seconds.
  155. */
  156. 'remember_login_cookie_lifetime' => 60*60*24*15,
  157. /**
  158. * The lifetime of a session after inactivity; the default is 24 hours,
  159. * expressed in seconds.
  160. */
  161. 'session_lifetime' => 60 * 60 * 24,
  162. /**
  163. * Enable or disable session keep-alive when a user is logged in to the Web UI.
  164. * Enabling this sends a "heartbeat" to the server to keep it from timing out.
  165. */
  166. 'session_keepalive' => true,
  167. /**
  168. * The directory where the skeleton files are located. These files will be
  169. * copied to the data directory of new users. Leave empty to not copy any
  170. * skeleton files.
  171. */
  172. 'skeletondirectory' => '/path/to/nextcloud/core/skeleton',
  173. /**
  174. * The ``user_backends`` app (which needs to be enabled first) allows you to
  175. * configure alternate authentication backends. Supported backends are:
  176. * IMAP (OC_User_IMAP), SMB (OC_User_SMB), and FTP (OC_User_FTP).
  177. */
  178. 'user_backends' => array(
  179. array(
  180. 'class' => 'OC_User_IMAP',
  181. 'arguments' => array('{imap.gmail.com:993/imap/ssl}INBOX')
  182. )
  183. ),
  184. /**
  185. * If your user backend does not allow to reset the password (e.g. when it's a
  186. * read-only user backend like LDAP), you can specify a custom link, where the
  187. * user is redirected to, when clicking the "reset password" link after a failed
  188. * login-attempt.
  189. */
  190. 'lost_password_link' => 'https://example.org/link/to/password/reset',
  191. /**
  192. * Mail Parameters
  193. *
  194. * These configure the email settings for Nextcloud notifications and password
  195. * resets.
  196. */
  197. /**
  198. * The return address that you want to appear on emails sent by the Nextcloud
  199. * server, for example ``nc-admin@example.com``, substituting your own domain,
  200. * of course.
  201. */
  202. 'mail_domain' => 'example.com',
  203. /**
  204. * FROM address that overrides the built-in ``sharing-noreply`` and
  205. * ``lostpassword-noreply`` FROM addresses.
  206. */
  207. 'mail_from_address' => 'nextcloud',
  208. /**
  209. * Enable SMTP class debugging.
  210. */
  211. 'mail_smtpdebug' => false,
  212. /**
  213. * Which mode to use for sending mail: ``sendmail``, ``smtp``, ``qmail`` or
  214. * ``php``.
  215. *
  216. * If you are using local or remote SMTP, set this to ``smtp``.
  217. *
  218. * If you are using PHP mail you must have an installed and working email system
  219. * on the server. The program used to send email is defined in the ``php.ini``
  220. * file.
  221. *
  222. * For the ``sendmail`` option you need an installed and working email system on
  223. * the server, with ``/usr/sbin/sendmail`` installed on your Unix system.
  224. *
  225. * For ``qmail`` the binary is /var/qmail/bin/sendmail, and it must be installed
  226. * on your Unix system.
  227. */
  228. 'mail_smtpmode' => 'sendmail',
  229. /**
  230. * This depends on ``mail_smtpmode``. Specify the IP address of your mail
  231. * server host. This may contain multiple hosts separated by a semi-colon. If
  232. * you need to specify the port number append it to the IP address separated by
  233. * a colon, like this: ``127.0.0.1:24``.
  234. */
  235. 'mail_smtphost' => '127.0.0.1',
  236. /**
  237. * This depends on ``mail_smtpmode``. Specify the port for sending mail.
  238. */
  239. 'mail_smtpport' => 25,
  240. /**
  241. * This depends on ``mail_smtpmode``. This sets the SMTP server timeout, in
  242. * seconds. You may need to increase this if you are running an anti-malware or
  243. * spam scanner.
  244. */
  245. 'mail_smtptimeout' => 10,
  246. /**
  247. * This depends on ``mail_smtpmode``. Specify when you are using ``ssl`` or
  248. * ``tls``, or leave empty for no encryption.
  249. */
  250. 'mail_smtpsecure' => '',
  251. /**
  252. * This depends on ``mail_smtpmode``. Change this to ``true`` if your mail
  253. * server requires authentication.
  254. */
  255. 'mail_smtpauth' => false,
  256. /**
  257. * This depends on ``mail_smtpmode``. If SMTP authentication is required, choose
  258. * the authentication type as ``LOGIN`` (default) or ``PLAIN``.
  259. */
  260. 'mail_smtpauthtype' => 'LOGIN',
  261. /**
  262. * This depends on ``mail_smtpauth``. Specify the username for authenticating to
  263. * the SMTP server.
  264. */
  265. 'mail_smtpname' => '',
  266. /**
  267. * This depends on ``mail_smtpauth``. Specify the password for authenticating to
  268. * the SMTP server.
  269. */
  270. 'mail_smtppassword' => '',
  271. /**
  272. * Proxy Configurations
  273. */
  274. /**
  275. * The automatic hostname detection of Nextcloud can fail in certain reverse
  276. * proxy and CLI/cron situations. This option allows you to manually override
  277. * the automatic detection; for example ``www.example.com``, or specify the port
  278. * ``www.example.com:8080``.
  279. */
  280. 'overwritehost' => '',
  281. /**
  282. * When generating URLs, Nextcloud attempts to detect whether the server is
  283. * accessed via ``https`` or ``http``. However, if Nextcloud is behind a proxy
  284. * and the proxy handles the ``https`` calls, Nextcloud would not know that
  285. * ``ssl`` is in use, which would result in incorrect URLs being generated.
  286. * Valid values are ``http`` and ``https``.
  287. */
  288. 'overwriteprotocol' => '',
  289. /**
  290. * Nextcloud attempts to detect the webroot for generating URLs automatically.
  291. * For example, if ``www.example.com/nextcloud`` is the URL pointing to the
  292. * Nextcloud instance, the webroot is ``/nextcloud``. When proxies are in use,
  293. * it may be difficult for Nextcloud to detect this parameter, resulting in
  294. * invalid URLs.
  295. */
  296. 'overwritewebroot' => '',
  297. /**
  298. * This option allows you to define a manual override condition as a regular
  299. * expression for the remote IP address. For example, defining a range of IP
  300. * addresses starting with ``10.0.0.`` and ending with 1 to 3:
  301. * ``^10\.0\.0\.[1-3]$``
  302. */
  303. 'overwritecondaddr' => '',
  304. /**
  305. * Use this configuration parameter to specify the base URL for any URLs which
  306. * are generated within Nextcloud using any kind of command line tools (cron or
  307. * occ). The value should contain the full base URL:
  308. * ``https://www.example.com/nextcloud``
  309. */
  310. 'overwrite.cli.url' => '',
  311. /**
  312. * To have clean URLs without `/index.php` this parameter needs to be configured.
  313. *
  314. * This parameter will be written as "RewriteBase" on update and installation of
  315. * Nextcloud to your `.htaccess` file. While this value is often simply the URL
  316. * path of the Nextcloud installation it cannot be set automatically properly in
  317. * every scenario and needs thus some manual configuration.
  318. *
  319. * In a standard Apache setup this usually equals the folder that Nextcloud is
  320. * accessible at. So if Nextcloud is accessible via "https://mycloud.org/nextcloud"
  321. * the correct value would most likely be "/nextcloud". If Nextcloud is running
  322. * under "https://mycloud.org/" then it would be "/".
  323. *
  324. * Note that above rule is not valid in every case, there are some rare setup
  325. * cases where this may not apply. However, to avoid any update problems this
  326. * configuration value is explicitly opt-in.
  327. *
  328. * After setting this value run `occ maintenance:update:htaccess` and when following
  329. * conditions are met Nextcloud uses URLs without index.php in it:
  330. *
  331. * - `mod_rewrite` is installed
  332. * - `mod_env` is installed
  333. */
  334. 'htaccess.RewriteBase' => '/',
  335. /**
  336. * The URL of your proxy server, for example ``proxy.example.com:8081``.
  337. */
  338. 'proxy' => '',
  339. /**
  340. * The optional authentication for the proxy to use to connect to the internet.
  341. * The format is: ``username:password``.
  342. */
  343. 'proxyuserpwd' => '',
  344. /**
  345. * Deleted Items (trash bin)
  346. *
  347. * These parameters control the Deleted files app.
  348. */
  349. /**
  350. * If the trash bin app is enabled (default), this setting defines the policy
  351. * for when files and folders in the trash bin will be permanently deleted.
  352. * The app allows for two settings, a minimum time for trash bin retention,
  353. * and a maximum time for trash bin retention.
  354. * Minimum time is the number of days a file will be kept, after which it
  355. * may be deleted. Maximum time is the number of days at which it is guaranteed
  356. * to be deleted.
  357. * Both minimum and maximum times can be set together to explicitly define
  358. * file and folder deletion. For migration purposes, this setting is installed
  359. * initially set to "auto", which is equivalent to the default setting in
  360. * Nextcloud.
  361. *
  362. * Available values:
  363. *
  364. * * ``auto``
  365. * default setting. keeps files and folders in the trash bin for 30 days
  366. * and automatically deletes anytime after that if space is needed (note:
  367. * files may not be deleted if space is not needed).
  368. * * ``D, auto``
  369. * keeps files and folders in the trash bin for D+ days, delete anytime if
  370. * space needed (note: files may not be deleted if space is not needed)
  371. * * ``auto, D``
  372. * delete all files in the trash bin that are older than D days
  373. * automatically, delete other files anytime if space needed
  374. * * ``D1, D2``
  375. * keep files and folders in the trash bin for at least D1 days and
  376. * delete when exceeds D2 days
  377. * * ``disabled``
  378. * trash bin auto clean disabled, files and folders will be kept forever
  379. */
  380. 'trashbin_retention_obligation' => 'auto',
  381. /**
  382. * File versions
  383. *
  384. * These parameters control the Versions app.
  385. */
  386. /**
  387. * If the versions app is enabled (default), this setting defines the policy
  388. * for when versions will be permanently deleted.
  389. * The app allows for two settings, a minimum time for version retention,
  390. * and a maximum time for version retention.
  391. * Minimum time is the number of days a version will be kept, after which it
  392. * may be deleted. Maximum time is the number of days at which it is guaranteed
  393. * to be deleted.
  394. * Both minimum and maximum times can be set together to explicitly define
  395. * version deletion. For migration purposes, this setting is installed
  396. * initially set to "auto", which is equivalent to the default setting in
  397. * Nextcloud.
  398. *
  399. * Available values:
  400. *
  401. * * ``auto``
  402. * default setting. Automatically expire versions according to expire
  403. * rules. Please refer to :doc:`../configuration_files/file_versioning` for
  404. * more information.
  405. * * ``D, auto``
  406. * keep versions at least for D days, apply expire rules to all versions
  407. * that are older than D days
  408. * * ``auto, D``
  409. * delete all versions that are older than D days automatically, delete
  410. * other versions according to expire rules
  411. * * ``D1, D2``
  412. * keep versions for at least D1 days and delete when exceeds D2 days
  413. * * ``disabled``
  414. * versions auto clean disabled, versions will be kept forever
  415. */
  416. 'versions_retention_obligation' => 'auto',
  417. /**
  418. * Nextcloud Verifications
  419. *
  420. * Nextcloud performs several verification checks. There are two options,
  421. * ``true`` and ``false``.
  422. */
  423. /**
  424. * Checks an app before install whether it uses private APIs instead of the
  425. * proper public APIs. If this is set to true it will only allow to install or
  426. * enable apps that pass this check.
  427. */
  428. 'appcodechecker' => true,
  429. /**
  430. * Check if Nextcloud is up-to-date and shows a notification if a new version is
  431. * available.
  432. */
  433. 'updatechecker' => true,
  434. /**
  435. * URL that Nextcloud should use to look for updates
  436. */
  437. 'updater.server.url' => 'https://updates.nextcloud.com/updater_server/',
  438. /**
  439. * Release channel to use for updates
  440. */
  441. 'updater.release.channel' => 'stable',
  442. /**
  443. * Is Nextcloud connected to the Internet or running in a closed network?
  444. */
  445. 'has_internet_connection' => true,
  446. /**
  447. * Allows Nextcloud to verify a working WebDAV connection. This is done by
  448. * attempting to make a WebDAV request from PHP.
  449. */
  450. 'check_for_working_webdav' => true,
  451. /**
  452. * Allows Nextcloud to verify a working .well-known URL redirects. This is done
  453. * by attempting to make a request from JS to
  454. * https://your-domain.com/.well-known/caldav/
  455. */
  456. 'check_for_working_wellknown_setup' => true,
  457. /**
  458. * This is a crucial security check on Apache servers that should always be set
  459. * to ``true``. This verifies that the ``.htaccess`` file is writable and works.
  460. * If it is not, then any options controlled by ``.htaccess``, such as large
  461. * file uploads, will not work. It also runs checks on the ``data/`` directory,
  462. * which verifies that it can't be accessed directly through the Web server.
  463. */
  464. 'check_for_working_htaccess' => true,
  465. /**
  466. * In certain environments it is desired to have a read-only configuration file.
  467. * When this switch is set to ``true`` Nextcloud will not verify whether the
  468. * configuration is writable. However, it will not be possible to configure
  469. * all options via the Web interface. Furthermore, when updating Nextcloud
  470. * it is required to make the configuration file writable again for the update
  471. * process.
  472. */
  473. 'config_is_read_only' => false,
  474. /**
  475. * Logging
  476. */
  477. /**
  478. * By default the Nextcloud logs are sent to the ``owncloud.log`` file in the
  479. * default Nextcloud data directory.
  480. * If syslogging is desired, set this parameter to ``syslog``.
  481. * Setting this parameter to ``errorlog`` will use the PHP error_log function
  482. * for logging.
  483. */
  484. 'log_type' => 'owncloud',
  485. /**
  486. * Log file path for the Nextcloud logging type.
  487. * Defaults to ``[datadirectory]/owncloud.log``
  488. */
  489. 'logfile' => '/var/log/owncloud.log',
  490. /**
  491. * Loglevel to start logging at. Valid values are: 0 = Debug, 1 = Info, 2 =
  492. * Warning, 3 = Error, and 4 = Fatal. The default value is Warning.
  493. */
  494. 'loglevel' => 2,
  495. /**
  496. * If you maintain different instances and aggregate the logs, you may want
  497. * to distinguish between them. ``syslog_tag`` can be set per instance
  498. * with a unique id. Only available if ``log_type`` is set to ``syslog``.
  499. * The default value is ``Nextcloud``.
  500. */
  501. 'syslog_tag' => 'Nextcloud',
  502. /**
  503. * Log condition for log level increase based on conditions. Once one of these
  504. * conditions is met, the required log level is set to debug. This allows to
  505. * debug specific requests, users or apps
  506. *
  507. * Supported conditions:
  508. * - ``shared_secret``: if a request parameter with the name `log_secret` is set to
  509. * this value the condition is met
  510. * - ``users``: if the current request is done by one of the specified users,
  511. * this condition is met
  512. * - ``apps``: if the log message is invoked by one of the specified apps,
  513. * this condition is met
  514. *
  515. * Defaults to an empty array.
  516. */
  517. 'log.condition' => [
  518. 'shared_secret' => '57b58edb6637fe3059b3595cf9c41b9',
  519. 'users' => ['sample-user'],
  520. 'apps' => ['files'],
  521. ],
  522. /**
  523. * This uses PHP.date formatting; see http://php.net/manual/en/function.date.php
  524. */
  525. 'logdateformat' => 'F d, Y H:i:s',
  526. /**
  527. * The default timezone for logfiles is UTC. You may change this; see
  528. * http://php.net/manual/en/timezones.php
  529. */
  530. 'logtimezone' => 'Europe/Berlin',
  531. /**
  532. * Append all database queries and parameters to the log file. Use this only for
  533. * debugging, as your logfile will become huge.
  534. */
  535. 'log_query' => false,
  536. /**
  537. * Log successful cron runs.
  538. */
  539. 'cron_log' => true,
  540. /**
  541. * Enables log rotation and limits the total size of logfiles. The default is 0,
  542. * or no rotation. Specify a size in bytes, for example 104857600 (100 megabytes
  543. * = 100 * 1024 * 1024 bytes). A new logfile is created with a new name when the
  544. * old logfile reaches your limit. If a rotated log file is already present, it
  545. * will be overwritten.
  546. */
  547. 'log_rotate_size' => false,
  548. /**
  549. * This section is for configuring the download links for Nextcloud clients, as
  550. * seen in the first-run wizard and on Personal pages.
  551. */
  552. 'customclient_desktop' =>
  553. 'https://nextcloud.com/install/',
  554. 'customclient_android' =>
  555. 'https://play.google.com/store/apps/details?id=com.nextcloud.client',
  556. 'customclient_ios' =>
  557. 'https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8',
  558. /**
  559. * Apps
  560. *
  561. * Options for the Apps folder, Apps store, and App code checker.
  562. */
  563. /**
  564. * When enabled, admins may install apps from the Nextcloud app store.
  565. */
  566. 'appstoreenabled' => true,
  567. /**
  568. * The URL of the appstore to use.
  569. */
  570. 'appstoreurl' => 'https://api.owncloud.com/v1',
  571. /**
  572. * Whether to show experimental apps in the appstore interface
  573. *
  574. * Experimental apps are not checked for security issues and are new or known
  575. * to be unstable and under heavy development. Installing these can cause data
  576. * loss or security breaches.
  577. */
  578. 'appstore.experimental.enabled' => false,
  579. /**
  580. * Use the ``apps_paths`` parameter to set the location of the Apps directory,
  581. * which should be scanned for available apps, and where user-specific apps
  582. * should be installed from the Apps store. The ``path`` defines the absolute
  583. * file system path to the app folder. The key ``url`` defines the HTTP Web path
  584. * to that folder, starting from the Nextcloud webroot. The key ``writable``
  585. * indicates if a Web server can write files to that folder.
  586. */
  587. 'apps_paths' => array(
  588. array(
  589. 'path'=> '/var/www/nextcloud/apps',
  590. 'url' => '/apps',
  591. 'writable' => true,
  592. ),
  593. ),
  594. /**
  595. * @see appcodechecker
  596. */
  597. /**
  598. * Previews
  599. *
  600. * Nextcloud supports previews of image files, the covers of MP3 files, and text
  601. * files. These options control enabling and disabling previews, and thumbnail
  602. * size.
  603. */
  604. /**
  605. * By default, Nextcloud can generate previews for the following filetypes:
  606. *
  607. * - Image files
  608. * - Covers of MP3 files
  609. * - Text documents
  610. *
  611. * Valid values are ``true``, to enable previews, or
  612. * ``false``, to disable previews
  613. */
  614. 'enable_previews' => true,
  615. /**
  616. * The maximum width, in pixels, of a preview. A value of ``null`` means there
  617. * is no limit.
  618. */
  619. 'preview_max_x' => 2048,
  620. /**
  621. * The maximum height, in pixels, of a preview. A value of ``null`` means there
  622. * is no limit.
  623. */
  624. 'preview_max_y' => 2048,
  625. /**
  626. * If a lot of small pictures are stored on the Nextcloud instance and the
  627. * preview system generates blurry previews, you might want to consider setting
  628. * a maximum scale factor. By default, pictures are upscaled to 10 times the
  629. * original size. A value of ``1`` or ``null`` disables scaling.
  630. */
  631. 'preview_max_scale_factor' => 10,
  632. /**
  633. * max file size for generating image previews with imagegd (default behaviour)
  634. * If the image is bigger, it'll try other preview generators,
  635. * but will most likely show the default mimetype icon
  636. *
  637. * Value represents the maximum filesize in megabytes
  638. * Default is 50
  639. * Set to -1 for no limit
  640. */
  641. 'preview_max_filesize_image' => 50,
  642. /**
  643. * custom path for LibreOffice/OpenOffice binary
  644. */
  645. 'preview_libreoffice_path' => '/usr/bin/libreoffice',
  646. /**
  647. * Use this if LibreOffice/OpenOffice requires additional arguments.
  648. */
  649. 'preview_office_cl_parameters' =>
  650. ' --headless --nologo --nofirststartwizard --invisible --norestore '.
  651. '--convert-to pdf --outdir ',
  652. /**
  653. * Only register providers that have been explicitly enabled
  654. *
  655. * The following providers are enabled by default:
  656. *
  657. * - OC\Preview\PNG
  658. * - OC\Preview\JPEG
  659. * - OC\Preview\GIF
  660. * - OC\Preview\BMP
  661. * - OC\Preview\XBitmap
  662. * - OC\Preview\MarkDown
  663. * - OC\Preview\MP3
  664. * - OC\Preview\TXT
  665. *
  666. * The following providers are disabled by default due to performance or privacy
  667. * concerns:
  668. *
  669. * - OC\Preview\Illustrator
  670. * - OC\Preview\Movie
  671. * - OC\Preview\MSOffice2003
  672. * - OC\Preview\MSOffice2007
  673. * - OC\Preview\MSOfficeDoc
  674. * - OC\Preview\OpenDocument
  675. * - OC\Preview\PDF
  676. * - OC\Preview\Photoshop
  677. * - OC\Preview\Postscript
  678. * - OC\Preview\StarOffice
  679. * - OC\Preview\SVG
  680. * - OC\Preview\TIFF
  681. * - OC\Preview\Font
  682. *
  683. * .. note:: Troubleshooting steps for the MS Word previews are available
  684. * at the :doc:`../configuration_files/collaborative_documents_configuration`
  685. * section of the Administrators Manual.
  686. *
  687. * The following providers are not available in Microsoft Windows:
  688. *
  689. * - OC\Preview\Movie
  690. * - OC\Preview\MSOfficeDoc
  691. * - OC\Preview\MSOffice2003
  692. * - OC\Preview\MSOffice2007
  693. * - OC\Preview\OpenDocument
  694. * - OC\Preview\StarOffice
  695. */
  696. 'enabledPreviewProviders' => array(
  697. 'OC\Preview\PNG',
  698. 'OC\Preview\JPEG',
  699. 'OC\Preview\GIF',
  700. 'OC\Preview\BMP',
  701. 'OC\Preview\XBitmap',
  702. 'OC\Preview\MP3',
  703. 'OC\Preview\TXT',
  704. 'OC\Preview\MarkDown'
  705. ),
  706. /**
  707. * LDAP
  708. *
  709. * Global settings used by LDAP User and Group Backend
  710. */
  711. /**
  712. * defines the interval in minutes for the background job that checks user
  713. * existence and marks them as ready to be cleaned up. The number is always
  714. * minutes. Setting it to 0 disables the feature.
  715. * See command line (occ) methods ldap:show-remnants and user:delete
  716. */
  717. 'ldapUserCleanupInterval' => 51,
  718. /**
  719. * Comments
  720. *
  721. * Global settings for the Comments infrastructure
  722. */
  723. /**
  724. * Replaces the default Comments Manager Factory. This can be utilized if an
  725. * own or 3rdParty CommentsManager should be used that – for instance – uses the
  726. * filesystem instead of the database to keep the comments.
  727. */
  728. 'comments.managerFactory' => '\OC\Comments\ManagerFactory',
  729. /**
  730. * Replaces the default System Tags Manager Factory. This can be utilized if an
  731. * own or 3rdParty SystemTagsManager should be used that – for instance – uses the
  732. * filesystem instead of the database to keep the comments.
  733. */
  734. 'systemtags.managerFactory' => '\OC\SystemTag\ManagerFactory',
  735. /**
  736. * Maintenance
  737. *
  738. * These options are for halting user activity when you are performing server
  739. * maintenance.
  740. */
  741. /**
  742. * Enable maintenance mode to disable Nextcloud
  743. *
  744. * If you want to prevent users from logging in to Nextcloud before you start
  745. * doing some maintenance work, you need to set the value of the maintenance
  746. * parameter to true. Please keep in mind that users who are already logged-in
  747. * are kicked out of Nextcloud instantly.
  748. */
  749. 'maintenance' => false,
  750. /**
  751. * When set to ``true``, the Nextcloud instance will be unavailable for all
  752. * users who are not in the ``admin`` group.
  753. */
  754. 'singleuser' => false,
  755. /**
  756. * SSL
  757. */
  758. /**
  759. * Extra SSL options to be used for configuration.
  760. */
  761. 'openssl' => array(
  762. 'config' => '/absolute/location/of/openssl.cnf',
  763. ),
  764. /**
  765. * Allow the configuration of system wide trusted certificates
  766. */
  767. 'enable_certificate_management' => false,
  768. /**
  769. * Memory caching backend configuration
  770. *
  771. * Available cache backends:
  772. *
  773. * * ``\OC\Memcache\APC`` Alternative PHP Cache backend
  774. * * ``\OC\Memcache\APCu`` APC user backend
  775. * * ``\OC\Memcache\ArrayCache`` In-memory array-based backend (not recommended)
  776. * * ``\OC\Memcache\Memcached`` Memcached backend
  777. * * ``\OC\Memcache\Redis`` Redis backend
  778. * * ``\OC\Memcache\XCache`` XCache backend
  779. *
  780. * Advice on choosing between the various backends:
  781. *
  782. * * APCu should be easiest to install. Almost all distributions have packages.
  783. * Use this for single user environment for all caches.
  784. * * Use Redis or Memcached for distributed environments.
  785. * For the local cache (you can configure two) take APCu.
  786. */
  787. /**
  788. * Memory caching backend for locally stored data
  789. *
  790. * * Used for host-specific data, e.g. file paths
  791. */
  792. 'memcache.local' => '\OC\Memcache\APCu',
  793. /**
  794. * Memory caching backend for distributed data
  795. *
  796. * * Used for installation-specific data, e.g. database caching
  797. * * If unset, defaults to the value of memcache.local
  798. */
  799. 'memcache.distributed' => '\OC\Memcache\Memcached',
  800. /**
  801. * Connection details for redis to use for memory caching.
  802. *
  803. * For enhanced security it is recommended to configure Redis
  804. * to require a password. See http://redis.io/topics/security
  805. * for more information.
  806. */
  807. 'redis' => array(
  808. 'host' => 'localhost', // can also be a unix domain socket: '/tmp/redis.sock'
  809. 'port' => 6379,
  810. 'timeout' => 0.0,
  811. 'password' => '', // Optional, if not defined no password will be used.
  812. 'dbindex' => 0, // Optional, if undefined SELECT will not run and will use Redis Server's default DB Index.
  813. ),
  814. /**
  815. * Server details for one or more memcached servers to use for memory caching.
  816. */
  817. 'memcached_servers' => array(
  818. // hostname, port and optional weight. Also see:
  819. // http://www.php.net/manual/en/memcached.addservers.php
  820. // http://www.php.net/manual/en/memcached.addserver.php
  821. array('localhost', 11211),
  822. //array('other.host.local', 11211),
  823. ),
  824. /**
  825. * Location of the cache folder, defaults to ``data/$user/cache`` where
  826. * ``$user`` is the current user. When specified, the format will change to
  827. * ``$cache_path/$user`` where ``$cache_path`` is the configured cache directory
  828. * and ``$user`` is the user.
  829. */
  830. 'cache_path' => '',
  831. /**
  832. * Using Object Store with Nextcloud
  833. */
  834. /**
  835. * This example shows how to configure Nextcloud to store all files in a
  836. * swift object storage.
  837. *
  838. * It is important to note that Nextcloud in object store mode will expect
  839. * exclusive access to the object store container because it only stores the
  840. * binary data for each file. The metadata is currently kept in the local
  841. * database for performance reasons.
  842. *
  843. * WARNING: The current implementation is incompatible with any app that uses
  844. * direct file IO and circumvents our virtual filesystem. That includes
  845. * Encryption and Gallery. Gallery will store thumbnails directly in the
  846. * filesystem and encryption will cause severe overhead because key files need
  847. * to be fetched in addition to any requested file.
  848. *
  849. * One way to test is applying for a trystack account at http://trystack.org/
  850. */
  851. 'objectstore' => array(
  852. 'class' => 'OC\\Files\\ObjectStore\\Swift',
  853. 'arguments' => array(
  854. // trystack will user your facebook id as the user name
  855. 'username' => 'facebook100000123456789',
  856. // in the trystack dashboard go to user -> settings -> API Password to
  857. // generate a password
  858. 'password' => 'Secr3tPaSSWoRdt7',
  859. // must already exist in the objectstore, name can be different
  860. 'container' => 'nextcloud',
  861. // create the container if it does not exist. default is false
  862. 'autocreate' => true,
  863. // required, dev-/trystack defaults to 'RegionOne'
  864. 'region' => 'RegionOne',
  865. // The Identity / Keystone endpoint
  866. 'url' => 'http://8.21.28.222:5000/v2.0',
  867. // required on dev-/trystack
  868. 'tenantName' => 'facebook100000123456789',
  869. // dev-/trystack uses swift by default, the lib defaults to 'cloudFiles'
  870. // if omitted
  871. 'serviceName' => 'swift',
  872. // The Interface / url Type, optional
  873. 'urlType' => 'internal'
  874. ),
  875. ),
  876. /**
  877. * Sharing
  878. *
  879. * Global settings for Sharing
  880. */
  881. /**
  882. * Replaces the default Share Provider Factory. This can be utilized if
  883. * own or 3rdParty Share Providers be used that – for instance – uses the
  884. * filesystem instead of the database to keep the share information.
  885. */
  886. 'sharing.managerFactory' => '\OC\Share20\ProviderFactory',
  887. /**
  888. * All other configuration options
  889. */
  890. /**
  891. * Additional driver options for the database connection, eg. to enable SSL
  892. * encryption in MySQL or specify a custom wait timeout on a cheap hoster.
  893. */
  894. 'dbdriveroptions' => array(
  895. PDO::MYSQL_ATTR_SSL_CA => '/file/path/to/ca_cert.pem',
  896. PDO::MYSQL_ATTR_INIT_COMMAND => 'SET wait_timeout = 28800'
  897. ),
  898. /**
  899. * sqlite3 journal mode can be specified using this configuration parameter -
  900. * can be 'WAL' or 'DELETE' see for more details https://www.sqlite.org/wal.html
  901. */
  902. 'sqlite.journal_mode' => 'DELETE',
  903. /**
  904. * Database types that are supported for installation.
  905. *
  906. * Available:
  907. * - sqlite (SQLite3)
  908. * - mysql (MySQL)
  909. * - pgsql (PostgreSQL)
  910. * - oci (Oracle)
  911. */
  912. 'supportedDatabases' => array(
  913. 'sqlite',
  914. 'mysql',
  915. 'pgsql',
  916. 'oci',
  917. ),
  918. /**
  919. * Override where Nextcloud stores temporary files. Useful in situations where
  920. * the system temporary directory is on a limited space ramdisk or is otherwise
  921. * restricted, or if external storages which do not support streaming are in
  922. * use.
  923. *
  924. * The Web server user must have write access to this directory.
  925. */
  926. 'tempdirectory' => '/tmp/nextcloudtemp',
  927. /**
  928. * The hashing cost used by hashes generated by Nextcloud
  929. * Using a higher value requires more time and CPU power to calculate the hashes
  930. */
  931. 'hashingCost' => 10,
  932. /**
  933. * Blacklist a specific file or files and disallow the upload of files
  934. * with this name. ``.htaccess`` is blocked by default.
  935. * WARNING: USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING.
  936. */
  937. 'blacklisted_files' => array('.htaccess'),
  938. /**
  939. * Define a default folder for shared files and folders other than root.
  940. */
  941. 'share_folder' => '/',
  942. /**
  943. * If you are applying a theme to Nextcloud, enter the name of the theme here.
  944. * The default location for themes is ``nextcloud/themes/``.
  945. */
  946. 'theme' => '',
  947. /**
  948. * The default cipher for encrypting files. Currently AES-128-CFB and
  949. * AES-256-CFB are supported.
  950. */
  951. 'cipher' => 'AES-256-CFB',
  952. /**
  953. * The minimum Nextcloud desktop client version that will be allowed to sync with
  954. * this server instance. All connections made from earlier clients will be denied
  955. * by the server. Defaults to the minimum officially supported Nextcloud desktop
  956. * client version at the time of release of this server version.
  957. *
  958. * When changing this, note that older unsupported versions of the Nextcloud desktop
  959. * client may not function as expected, and could lead to permanent data loss for
  960. * clients or other unexpected results.
  961. */
  962. 'minimum.supported.desktop.version' => '1.7.0',
  963. /**
  964. * EXPERIMENTAL: option whether to include external storage in quota
  965. * calculation, defaults to false.
  966. */
  967. 'quota_include_external_storage' => false,
  968. /**
  969. * Specifies how often the local filesystem (the Nextcloud data/ directory, and
  970. * NFS mounts in data/) is checked for changes made outside Nextcloud. This
  971. * does not apply to external storages.
  972. *
  973. * 0 -> Never check the filesystem for outside changes, provides a performance
  974. * increase when it's certain that no changes are made directly to the
  975. * filesystem
  976. *
  977. * 1 -> Check each file or folder at most once per request, recommended for
  978. * general use if outside changes might happen.
  979. */
  980. 'filesystem_check_changes' => 0,
  981. /**
  982. * By default Nextcloud will store the part files created during upload in the
  983. * same storage as the upload target. Setting this to false will store the part
  984. * files in the root of the users folder which might be required to work with certain
  985. * external storage setups that have limited rename capabilities.
  986. */
  987. 'part_file_in_storage' => true,
  988. /**
  989. * All css and js files will be served by the Web server statically in one js
  990. * file and one css file if this is set to ``true``. This improves performance.
  991. */
  992. 'asset-pipeline.enabled' => false,
  993. /**
  994. * The parent of the directory where css and js assets will be stored if
  995. * pipelining is enabled; this defaults to the Nextcloud directory. The assets
  996. * will be stored in a subdirectory of this directory named 'assets'. The
  997. * server *must* be configured to serve that directory as $WEBROOT/assets.
  998. * You will only likely need to change this if the main Nextcloud directory
  999. * is not writeable by the Web server in your configuration.
  1000. */
  1001. 'assetdirectory' => '/var/www/nextcloud',
  1002. /**
  1003. * Where ``mount.json`` file should be stored, defaults to ``data/mount.json``
  1004. * in the Nextcloud directory.
  1005. */
  1006. 'mount_file' => '/var/www/nextcloud/data/mount.json',
  1007. /**
  1008. * When ``true``, prevent Nextcloud from changing the cache due to changes in
  1009. * the filesystem for all storage.
  1010. */
  1011. 'filesystem_cache_readonly' => false,
  1012. /**
  1013. * Secret used by Nextcloud for various purposes, e.g. to encrypt data. If you
  1014. * lose this string there will be data corruption.
  1015. */
  1016. 'secret' => '',
  1017. /**
  1018. * List of trusted proxy servers
  1019. *
  1020. * If you configure these also consider setting `forwarded_for_headers` which
  1021. * otherwise defaults to `HTTP_X_FORWARDED_FOR` (the `X-Forwarded-For` header).
  1022. */
  1023. 'trusted_proxies' => array('203.0.113.45', '198.51.100.128'),
  1024. /**
  1025. * Headers that should be trusted as client IP address in combination with
  1026. * `trusted_proxies`. If the HTTP header looks like 'X-Forwarded-For', then use
  1027. * 'HTTP_X_FORWARDED_FOR' here.
  1028. *
  1029. * If set incorrectly, a client can spoof their IP address as visible to
  1030. * Nextcloud, bypassing access controls and making logs useless!
  1031. *
  1032. * Defaults to 'HTTP_X_FORWARED_FOR' if unset
  1033. */
  1034. 'forwarded_for_headers' => array('HTTP_X_FORWARDED', 'HTTP_FORWARDED_FOR'),
  1035. /**
  1036. * max file size for animating gifs on public-sharing-site.
  1037. * If the gif is bigger, it'll show a static preview
  1038. *
  1039. * Value represents the maximum filesize in megabytes. Default is ``10``. Set to
  1040. * ``-1`` for no limit.
  1041. */
  1042. 'max_filesize_animated_gifs_public_sharing' => 10,
  1043. /**
  1044. * Enables transactional file locking.
  1045. * This is enabled by default.
  1046. *
  1047. * Prevents concurrent processes from accessing the same files
  1048. * at the same time. Can help prevent side effects that would
  1049. * be caused by concurrent operations. Mainly relevant for
  1050. * very large installations with many users working with
  1051. * shared files.
  1052. */
  1053. 'filelocking.enabled' => true,
  1054. /**
  1055. * Memory caching backend for file locking
  1056. *
  1057. * Because most memcache backends can clean values without warning using redis
  1058. * is highly recommended to *avoid data loss*.
  1059. */
  1060. 'memcache.locking' => '\\OC\\Memcache\\Redis',
  1061. /**
  1062. * Set this Nextcloud instance to debugging mode
  1063. *
  1064. * Only enable this for local development and not in production environments
  1065. * This will disable the minifier and outputs some additional debug information
  1066. */
  1067. 'debug' => false,
  1068. /**
  1069. * This entry is just here to show a warning in case somebody copied the sample
  1070. * configuration. DO NOT ADD THIS SWITCH TO YOUR CONFIGURATION!
  1071. *
  1072. * If you, brave person, have read until here be aware that you should not
  1073. * modify *ANY* settings in this file without reading the documentation.
  1074. */
  1075. 'copied_sample_config' => true,
  1076. );