config.default.php 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  1. <?php
  2. # Do not modify this file, which defines default values,
  3. # but edit `./data/config.php` instead, after the install process is completed.
  4. return array(
  5. # Set to `development` to get additional error messages,
  6. # or to `production` to get only the most important messages.
  7. 'environment' => 'production',
  8. # Used to make crypto more unique. Generated during install.
  9. 'salt' => '',
  10. # Specify address of the FreshRSS instance,
  11. # used when building absolute URLs, e.g. for WebSub.
  12. # Examples:
  13. # https://example.net/FreshRSS/p/
  14. # https://freshrss.example.net/
  15. 'base_url' => '',
  16. # Specify address of the FreshRSS auto-update server.
  17. 'auto_update_url' => 'https://update.freshrss.org',
  18. # Natural language of the user interface, e.g. `en`, `fr`.
  19. 'language' => 'en',
  20. # Title of this FreshRSS instance in the Web user interface.
  21. 'title' => 'FreshRSS',
  22. # Meta description used when `allow_robots` is true.
  23. 'meta_description' => '',
  24. # Name of the user that has administration rights.
  25. 'default_user' => '_',
  26. # Force users to validate their email address. If `true`, an email with a
  27. # validation URL is sent during registration, and users cannot access their
  28. # feed if they didn’t access this URL.
  29. # Note: it is recommended to not enable it with PHP < 5.5 (emails cannot be
  30. # sent).
  31. 'force_email_validation' => false,
  32. # Allow or not visitors without login to see the articles
  33. # of the default user.
  34. 'allow_anonymous' => false,
  35. # Allow or not anonymous users to start the refresh process.
  36. 'allow_anonymous_refresh' => false,
  37. # Login method:
  38. # `none` is without password and shows only the default user;
  39. # `form` is a conventional Web login form;
  40. # `http_auth` is an access controlled by the HTTP Web server (e.g. `/FreshRSS/p/i/.htaccess` for Apache)
  41. # if you use `http_auth`, remember to protect only `/FreshRSS/p/i/`,
  42. # and in particular not protect `/FreshRSS/p/api/` if you would like to use the API (different login system).
  43. 'auth_type' => 'form',
  44. # When using http_auth, automatically register any unknown user
  45. 'http_auth_auto_register' => true,
  46. # Optionally, you can specify the $_SERVER key containing the email address used when registering
  47. # the user (e.g. REMOTE_USER_EMAIL).
  48. 'http_auth_auto_register_email_field' => '',
  49. # Allow or not the use of the API, used for mobile apps.
  50. # End-point is https://freshrss.example.net/api/greader.php
  51. # You need to set the user’s API password.
  52. 'api_enabled' => false,
  53. # Allow or not the use of an unsafe login,
  54. # by providing username and password in the login URL:
  55. # https://example.net/FreshRSS/p/i/?c=auth&a=login&u=alice&p=1234
  56. 'unsafe_autologin_enabled' => false,
  57. # Enable or not the use of syslog to log the activity of
  58. # SimplePie, which is retrieving RSS feeds via HTTP requests.
  59. 'simplepie_syslog_enabled' => true,
  60. # Enable or not support of PubSubHubbub.
  61. # /!\ It should NOT be enabled if base_url is not reachable by an external server.
  62. 'pubsubhubbub_enabled' => false,
  63. # Allow or not Web robots (e.g. search engines) in HTML headers.
  64. 'allow_robots' => false,
  65. # If true does nothing, if false restricts HTTP Referer via: meta referrer origin
  66. 'allow_referrer' => false,
  67. 'limits' => array(
  68. # Duration in seconds of the login cookie.
  69. 'cookie_duration' => FreshRSS_Auth::DEFAULT_COOKIE_DURATION,
  70. # Duration in seconds of the SimplePie cache,
  71. # during which a query to the RSS feed will return the local cached version.
  72. # Especially important for multi-user setups.
  73. 'cache_duration' => 800,
  74. # SimplePie HTTP request timeout in seconds.
  75. 'timeout' => 15,
  76. # If a user has not used FreshRSS for more than x seconds,
  77. # then its feeds are not refreshed anymore.
  78. 'max_inactivity' => PHP_INT_MAX,
  79. # Max number of feeds for a user.
  80. 'max_feeds' => 16384,
  81. # Max number of categories for a user.
  82. 'max_categories' => 16384,
  83. # Max number of accounts that anonymous users can create (only for Web form login type)
  84. # 0 for an unlimited number of accounts
  85. # 1 is to not allow user registrations (1 is corresponding to the admin account)
  86. 'max_registrations' => 1,
  87. ),
  88. # Options used by cURL when making HTTP requests, e.g. when the SimplePie library retrieves feeds.
  89. # https://php.net/manual/function.curl-setopt
  90. 'curl_options' => array(
  91. # Options to disable SSL/TLS certificate check (e.g. for self-signed HTTPS)
  92. //CURLOPT_SSL_VERIFYHOST => 0,
  93. //CURLOPT_SSL_VERIFYPEER => false,
  94. # Options to use a proxy for retrieving feeds.
  95. //CURLOPT_PROXYTYPE => CURLPROXY_HTTP,
  96. //CURLOPT_PROXY => '127.0.0.1',
  97. //CURLOPT_PROXYPORT => 8080,
  98. //CURLOPT_PROXYAUTH => CURLAUTH_BASIC,
  99. //CURLOPT_PROXYUSERPWD => 'user:password',
  100. ),
  101. 'db' => [
  102. # Type of database: `sqlite` or `mysql` or 'pgsql'
  103. 'type' => 'sqlite',
  104. # Database server
  105. 'host' => 'localhost',
  106. # Database user
  107. 'user' => '',
  108. # Database password
  109. 'password' => '',
  110. # Database name
  111. 'base' => '',
  112. # Tables prefix (useful if you use the same database for multiple things)
  113. 'prefix' => 'freshrss_',
  114. # Additional connection string parameters, such as PostgreSQL 'sslmode=??;sslrootcert=??'
  115. # https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS
  116. 'connection_uri_params' => '',
  117. # Additional PDO parameters, such as offered by MySQL https://php.net/ref.pdo-mysql
  118. 'pdo_options' => [
  119. //PDO::MYSQL_ATTR_SSL_KEY => '/path/to/client-key.pem',
  120. //PDO::MYSQL_ATTR_SSL_CERT => '/path/to/client-cert.pem',
  121. //PDO::MYSQL_ATTR_SSL_CA => '/path/to/ca-cert.pem',
  122. ],
  123. ],
  124. # Configuration to send emails. Be aware that PHP < 5.5 are not supported.
  125. # These options are basically a mapping of the PHPMailer class attributes
  126. # from the PHPMailer library.
  127. #
  128. # See https://phpmailer.github.io/PHPMailer/classes/PHPMailer-PHPMailer-PHPMailer.html#properties
  129. 'mailer' => 'mail', // 'mail' or 'smtp'
  130. 'smtp' => array(
  131. 'hostname' => '', // the domain used in the Message-ID header
  132. 'host' => 'localhost', // the SMTP server address
  133. 'port' => 25,
  134. 'auth' => false,
  135. 'auth_type' => '', // 'CRAM-MD5', 'LOGIN', 'PLAIN', 'XOAUTH2' or ''
  136. 'username' => '',
  137. 'password' => '',
  138. 'secure' => '', // '', 'ssl' or 'tls'
  139. 'from' => 'root@localhost',
  140. ),
  141. # List of enabled FreshRSS extensions.
  142. 'extensions_enabled' => [
  143. 'Google-Groups' => true,
  144. 'Tumblr-GDPR' => true,
  145. ],
  146. # Disable self-update,
  147. 'disable_update' => false,
  148. );