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 33KB

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