You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

config.sample.php 40KB

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