config.default.php 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206
  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 user that has administration rights.
  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. 'limits' => array(
  73. # Duration in seconds of the login cookie.
  74. 'cookie_duration' => FreshRSS_Auth::DEFAULT_COOKIE_DURATION,
  75. # Duration in seconds of the SimplePie cache,
  76. # during which a query to the RSS feed will return the local cached version.
  77. # Especially important for multi-user setups.
  78. 'cache_duration' => 800,
  79. # SimplePie HTTP request timeout in seconds.
  80. 'timeout' => 15,
  81. # If a user has not used FreshRSS for more than x seconds,
  82. # then its feeds are not refreshed anymore.
  83. 'max_inactivity' => PHP_INT_MAX,
  84. # Max number of feeds for a user.
  85. 'max_feeds' => 131072,
  86. # Max number of categories for a user.
  87. 'max_categories' => 16384,
  88. # Max number of accounts that anonymous users can create (only for Web form login type)
  89. # 0 for an unlimited number of accounts
  90. # 1 is to not allow user registrations (1 is corresponding to the admin account)
  91. 'max_registrations' => 1,
  92. ),
  93. # Options used by cURL when making HTTP requests, e.g. when the SimplePie library retrieves feeds.
  94. # https://php.net/manual/function.curl-setopt
  95. 'curl_options' => array(
  96. # Options to disable SSL/TLS certificate check (e.g. for self-signed HTTPS)
  97. //CURLOPT_SSL_VERIFYHOST => 0,
  98. //CURLOPT_SSL_VERIFYPEER => false,
  99. # Options to use a proxy for retrieving feeds.
  100. //CURLOPT_PROXYTYPE => CURLPROXY_HTTP,
  101. //CURLOPT_PROXY => '127.0.0.1',
  102. //CURLOPT_PROXYPORT => 8080,
  103. //CURLOPT_PROXYAUTH => CURLAUTH_BASIC,
  104. //CURLOPT_PROXYUSERPWD => 'user:password',
  105. ),
  106. 'db' => [
  107. # Type of database: `sqlite` or `mysql` or 'pgsql'
  108. 'type' => 'sqlite',
  109. # Database server
  110. 'host' => 'localhost',
  111. # Database user
  112. 'user' => '',
  113. # Database password
  114. 'password' => '',
  115. # Database name
  116. 'base' => '',
  117. # Tables prefix (useful if you use the same database for multiple things)
  118. 'prefix' => 'freshrss_',
  119. # Additional connection string parameters, such as PostgreSQL 'sslmode=??;sslrootcert=??'
  120. # https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS
  121. 'connection_uri_params' => '',
  122. # Additional PDO parameters, such as offered by MySQL https://php.net/ref.pdo-mysql
  123. 'pdo_options' => [
  124. //PDO::MYSQL_ATTR_SSL_KEY => '/path/to/client-key.pem',
  125. //PDO::MYSQL_ATTR_SSL_CERT => '/path/to/client-cert.pem',
  126. //PDO::MYSQL_ATTR_SSL_CA => '/path/to/ca-cert.pem',
  127. ],
  128. ],
  129. # Configuration to send emails. Be aware that PHP < 5.5 are not supported.
  130. # These options are basically a mapping of the PHPMailer class attributes
  131. # from the PHPMailer library.
  132. #
  133. # See https://phpmailer.github.io/PHPMailer/classes/PHPMailer-PHPMailer-PHPMailer.html#properties
  134. 'mailer' => 'mail', // 'mail' or 'smtp'
  135. 'smtp' => array(
  136. 'hostname' => '', // the domain used in the Message-ID header
  137. 'host' => 'localhost', // the SMTP server address
  138. 'port' => 25,
  139. 'auth' => false,
  140. 'auth_type' => '', // 'CRAM-MD5', 'LOGIN', 'PLAIN', 'XOAUTH2' or ''
  141. 'username' => '',
  142. 'password' => '',
  143. 'secure' => '', // '', 'ssl' or 'tls'
  144. 'from' => 'root@localhost',
  145. ),
  146. # List of enabled FreshRSS extensions.
  147. 'extensions_enabled' => [
  148. 'Google-Groups' => true,
  149. 'Tumblr-GDPR' => true,
  150. ],
  151. # Disable self-update,
  152. 'disable_update' => false,
  153. # Trusted IPs that are allowed to send unsafe headers
  154. # Please read the documentation, before configuring this
  155. # https://freshrss.github.io/FreshRSS/en/admins/09_AccessControl.html
  156. 'trusted_sources' => [
  157. '127.0.0.0/8',
  158. '::1/128',
  159. ]
  160. );