config.default.php 7.3 KB

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