config.sample.php 39 KB

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