2015-01-05 16:54:16 +01:00
|
|
|
|
<?php
|
|
|
|
|
|
2015-07-12 12:16:56 +02:00
|
|
|
|
# Do not modify this file, which defines default values,
|
2022-05-23 14:03:19 +02:00
|
|
|
|
# but instead edit `./data/config.php` after the install process is completed,
|
|
|
|
|
# or edit `./data/config.custom.php` before the install process.
|
2015-01-05 16:54:16 +01:00
|
|
|
|
return array(
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
|
|
|
|
# Set to `development` to get additional error messages,
|
|
|
|
|
# or to `production` to get only the most important messages.
|
2015-01-06 18:53:36 +01:00
|
|
|
|
'environment' => 'production',
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
|
|
|
|
# Used to make crypto more unique. Generated during install.
|
2015-01-06 18:53:36 +01:00
|
|
|
|
'salt' => '',
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2015-05-15 03:21:36 +02:00
|
|
|
|
# Specify address of the FreshRSS instance,
|
2018-12-16 17:02:03 +01:00
|
|
|
|
# used when building absolute URLs, e.g. for WebSub.
|
2015-05-15 03:21:36 +02:00
|
|
|
|
# Examples:
|
|
|
|
|
# https://example.net/FreshRSS/p/
|
|
|
|
|
# https://freshrss.example.net/
|
2015-01-06 18:53:36 +01:00
|
|
|
|
'base_url' => '',
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2015-11-02 20:20:40 +01:00
|
|
|
|
# Specify address of the FreshRSS auto-update server.
|
|
|
|
|
'auto_update_url' => 'https://update.freshrss.org',
|
|
|
|
|
|
2015-05-10 11:50:08 +02:00
|
|
|
|
# Natural language of the user interface, e.g. `en`, `fr`.
|
2015-01-06 18:53:36 +01:00
|
|
|
|
'language' => 'en',
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
|
|
|
|
# Title of this FreshRSS instance in the Web user interface.
|
2015-01-06 18:53:36 +01:00
|
|
|
|
'title' => 'FreshRSS',
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2016-10-07 22:54:23 +02:00
|
|
|
|
# Meta description used when `allow_robots` is true.
|
|
|
|
|
'meta_description' => '',
|
|
|
|
|
|
2022-05-23 14:03:19 +02:00
|
|
|
|
# Override logo of this FreshRSS instance in the Web user interface.
|
|
|
|
|
# It is rendered inside an <a>...</a> element and must be valid HTML or text.
|
|
|
|
|
# Example: '<img class="logo" src="https://example.net/Hello.png" alt="Logo Example" /> Hello'
|
|
|
|
|
'logo_html' => '',
|
|
|
|
|
|
2022-07-04 11:16:57 +02:00
|
|
|
|
# Name of the default user. Also used as the public user for anonymous reading.
|
2015-01-06 18:53:36 +01:00
|
|
|
|
'default_user' => '_',
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2019-08-29 12:02:05 +02:00
|
|
|
|
# Force users to validate their email address. If `true`, an email with a
|
|
|
|
|
# validation URL is sent during registration, and users cannot access their
|
2022-01-08 21:58:55 +01:00
|
|
|
|
# feed if they didn’t access this URL.
|
2019-08-29 12:02:05 +02:00
|
|
|
|
# Note: it is recommended to not enable it with PHP < 5.5 (emails cannot be
|
|
|
|
|
# sent).
|
|
|
|
|
'force_email_validation' => false,
|
|
|
|
|
|
2015-05-10 11:50:08 +02:00
|
|
|
|
# Allow or not visitors without login to see the articles
|
|
|
|
|
# of the default user.
|
2015-01-06 18:53:36 +01:00
|
|
|
|
'allow_anonymous' => false,
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
|
|
|
|
# Allow or not anonymous users to start the refresh process.
|
2015-01-06 18:53:36 +01:00
|
|
|
|
'allow_anonymous_refresh' => false,
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
|
|
|
|
# Login method:
|
|
|
|
|
# `none` is without password and shows only the default user;
|
|
|
|
|
# `form` is a conventional Web login form;
|
2022-01-08 16:25:17 +01:00
|
|
|
|
# `http_auth` is an access controlled by the HTTP Web server (e.g. `/FreshRSS/p/i/.htaccess` for Apache)
|
2015-05-10 11:50:08 +02:00
|
|
|
|
# if you use `http_auth`, remember to protect only `/FreshRSS/p/i/`,
|
|
|
|
|
# and in particular not protect `/FreshRSS/p/api/` if you would like to use the API (different login system).
|
2016-11-06 14:04:06 +01:00
|
|
|
|
'auth_type' => 'form',
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2020-06-19 23:01:19 +02:00
|
|
|
|
# When using http_auth, automatically register any unknown user
|
|
|
|
|
'http_auth_auto_register' => true,
|
|
|
|
|
|
|
|
|
|
# Optionally, you can specify the $_SERVER key containing the email address used when registering
|
|
|
|
|
# the user (e.g. REMOTE_USER_EMAIL).
|
|
|
|
|
'http_auth_auto_register_email_field' => '',
|
|
|
|
|
|
2015-05-10 11:50:08 +02:00
|
|
|
|
# Allow or not the use of the API, used for mobile apps.
|
2017-11-12 15:51:43 +01:00
|
|
|
|
# End-point is https://freshrss.example.net/api/greader.php
|
2022-01-08 21:58:55 +01:00
|
|
|
|
# You need to set the user’s API password.
|
2015-01-06 18:53:36 +01:00
|
|
|
|
'api_enabled' => false,
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
|
|
|
|
# Allow or not the use of an unsafe login,
|
|
|
|
|
# by providing username and password in the login URL:
|
2021-11-14 22:28:46 +01:00
|
|
|
|
# https://example.net/FreshRSS/p/i/?c=auth&a=login&u=alice&p=1234
|
2015-01-06 18:53:36 +01:00
|
|
|
|
'unsafe_autologin_enabled' => false,
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
|
|
|
|
# Enable or not the use of syslog to log the activity of
|
|
|
|
|
# SimplePie, which is retrieving RSS feeds via HTTP requests.
|
2015-03-21 18:20:36 +01:00
|
|
|
|
'simplepie_syslog_enabled' => true,
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2015-07-23 13:54:34 +02:00
|
|
|
|
# Enable or not support of PubSubHubbub.
|
|
|
|
|
# /!\ It should NOT be enabled if base_url is not reachable by an external server.
|
|
|
|
|
'pubsubhubbub_enabled' => false,
|
|
|
|
|
|
2015-10-24 23:47:13 +02:00
|
|
|
|
# Allow or not Web robots (e.g. search engines) in HTML headers.
|
|
|
|
|
'allow_robots' => false,
|
|
|
|
|
|
2016-08-07 13:52:57 +02:00
|
|
|
|
# If true does nothing, if false restricts HTTP Referer via: meta referrer origin
|
|
|
|
|
'allow_referrer' => false,
|
|
|
|
|
|
2024-02-26 09:01:49 +01:00
|
|
|
|
# Number of feeds to refresh in parallel from the Web user interface.
|
|
|
|
|
# Faster with higher values. Reduce for server with little memory or database issues.
|
|
|
|
|
'nb_parallel_refresh' => 10,
|
|
|
|
|
|
2015-01-05 16:54:16 +01:00
|
|
|
|
'limits' => array(
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2016-12-24 16:33:28 +01:00
|
|
|
|
# Duration in seconds of the login cookie.
|
2020-12-26 23:40:24 +01:00
|
|
|
|
'cookie_duration' => FreshRSS_Auth::DEFAULT_COOKIE_DURATION,
|
2016-12-24 16:33:28 +01:00
|
|
|
|
|
2015-05-10 11:50:08 +02:00
|
|
|
|
# Duration in seconds of the SimplePie cache,
|
|
|
|
|
# during which a query to the RSS feed will return the local cached version.
|
|
|
|
|
# Especially important for multi-user setups.
|
2015-01-05 16:54:16 +01:00
|
|
|
|
'cache_duration' => 800,
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
|
|
|
|
# SimplePie HTTP request timeout in seconds.
|
2023-02-06 14:11:41 +01:00
|
|
|
|
'timeout' => 20,
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
|
|
|
|
# If a user has not used FreshRSS for more than x seconds,
|
|
|
|
|
# then its feeds are not refreshed anymore.
|
2015-01-05 16:54:16 +01:00
|
|
|
|
'max_inactivity' => PHP_INT_MAX,
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
|
|
|
|
# Max number of feeds for a user.
|
2022-05-09 15:59:21 +02:00
|
|
|
|
'max_feeds' => 131072,
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
|
|
|
|
# Max number of categories for a user.
|
2015-01-05 16:54:16 +01:00
|
|
|
|
'max_categories' => 16384,
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2020-06-19 23:01:19 +02:00
|
|
|
|
# Max number of accounts that anonymous users can create (only for Web form login type)
|
2015-07-21 15:31:23 +02:00
|
|
|
|
# 0 for an unlimited number of accounts
|
|
|
|
|
# 1 is to not allow user registrations (1 is corresponding to the admin account)
|
|
|
|
|
'max_registrations' => 1,
|
2015-01-05 16:54:16 +01:00
|
|
|
|
),
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2015-07-12 12:16:56 +02:00
|
|
|
|
# Options used by cURL when making HTTP requests, e.g. when the SimplePie library retrieves feeds.
|
2021-11-14 22:28:46 +01:00
|
|
|
|
# https://php.net/manual/function.curl-setopt
|
2015-07-12 12:16:56 +02:00
|
|
|
|
'curl_options' => array(
|
|
|
|
|
# Options to disable SSL/TLS certificate check (e.g. for self-signed HTTPS)
|
|
|
|
|
//CURLOPT_SSL_VERIFYHOST => 0,
|
|
|
|
|
//CURLOPT_SSL_VERIFYPEER => false,
|
|
|
|
|
|
|
|
|
|
# Options to use a proxy for retrieving feeds.
|
2015-07-12 12:52:18 +02:00
|
|
|
|
//CURLOPT_PROXYTYPE => CURLPROXY_HTTP,
|
2015-07-12 12:16:56 +02:00
|
|
|
|
//CURLOPT_PROXY => '127.0.0.1',
|
|
|
|
|
//CURLOPT_PROXYPORT => 8080,
|
2015-07-12 12:52:18 +02:00
|
|
|
|
//CURLOPT_PROXYAUTH => CURLAUTH_BASIC,
|
2015-07-12 12:16:56 +02:00
|
|
|
|
//CURLOPT_PROXYUSERPWD => 'user:password',
|
|
|
|
|
),
|
|
|
|
|
|
2019-10-05 15:48:03 +02:00
|
|
|
|
'db' => [
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2019-10-05 15:48:03 +02:00
|
|
|
|
# Type of database: `sqlite` or `mysql` or 'pgsql'
|
2015-01-05 16:54:16 +01:00
|
|
|
|
'type' => 'sqlite',
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2019-10-05 15:48:03 +02:00
|
|
|
|
# Database server
|
2015-07-17 18:16:00 +02:00
|
|
|
|
'host' => 'localhost',
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2019-10-05 15:48:03 +02:00
|
|
|
|
# Database user
|
2015-01-05 16:54:16 +01:00
|
|
|
|
'user' => '',
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2019-10-05 15:48:03 +02:00
|
|
|
|
# Database password
|
2015-01-05 16:54:16 +01:00
|
|
|
|
'password' => '',
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2019-10-05 15:48:03 +02:00
|
|
|
|
# Database name
|
2015-01-05 16:54:16 +01:00
|
|
|
|
'base' => '',
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2019-10-05 15:48:03 +02:00
|
|
|
|
# Tables prefix (useful if you use the same database for multiple things)
|
2015-07-17 18:16:00 +02:00
|
|
|
|
'prefix' => 'freshrss_',
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2019-10-05 15:48:03 +02:00
|
|
|
|
# Additional connection string parameters, such as PostgreSQL 'sslmode=??;sslrootcert=??'
|
|
|
|
|
# https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS
|
|
|
|
|
'connection_uri_params' => '',
|
|
|
|
|
|
|
|
|
|
# Additional PDO parameters, such as offered by MySQL https://php.net/ref.pdo-mysql
|
|
|
|
|
'pdo_options' => [
|
2015-06-05 20:44:45 +02:00
|
|
|
|
//PDO::MYSQL_ATTR_SSL_KEY => '/path/to/client-key.pem',
|
|
|
|
|
//PDO::MYSQL_ATTR_SSL_CERT => '/path/to/client-cert.pem',
|
|
|
|
|
//PDO::MYSQL_ATTR_SSL_CA => '/path/to/ca-cert.pem',
|
2019-10-05 15:48:03 +02:00
|
|
|
|
],
|
2015-06-03 22:07:25 +02:00
|
|
|
|
|
2019-10-05 15:48:03 +02:00
|
|
|
|
],
|
2015-05-10 11:50:08 +02:00
|
|
|
|
|
2019-08-15 17:19:12 +02:00
|
|
|
|
# Configuration to send emails. Be aware that PHP < 5.5 are not supported.
|
|
|
|
|
# These options are basically a mapping of the PHPMailer class attributes
|
|
|
|
|
# from the PHPMailer library.
|
|
|
|
|
#
|
2021-11-14 22:28:46 +01:00
|
|
|
|
# See https://phpmailer.github.io/PHPMailer/classes/PHPMailer-PHPMailer-PHPMailer.html#properties
|
2019-08-15 17:19:12 +02:00
|
|
|
|
'mailer' => 'mail', // 'mail' or 'smtp'
|
|
|
|
|
'smtp' => array(
|
|
|
|
|
'hostname' => '', // the domain used in the Message-ID header
|
|
|
|
|
'host' => 'localhost', // the SMTP server address
|
|
|
|
|
'port' => 25,
|
|
|
|
|
'auth' => false,
|
|
|
|
|
'auth_type' => '', // 'CRAM-MD5', 'LOGIN', 'PLAIN', 'XOAUTH2' or ''
|
|
|
|
|
'username' => '',
|
|
|
|
|
'password' => '',
|
|
|
|
|
'secure' => '', // '', 'ssl' or 'tls'
|
2019-08-29 12:02:05 +02:00
|
|
|
|
'from' => 'root@localhost',
|
2019-08-15 17:19:12 +02:00
|
|
|
|
),
|
|
|
|
|
|
2015-05-10 11:50:08 +02:00
|
|
|
|
# List of enabled FreshRSS extensions.
|
2020-03-22 16:59:39 +01:00
|
|
|
|
'extensions_enabled' => [
|
|
|
|
|
],
|
2023-12-18 17:59:16 +01:00
|
|
|
|
# Extensions configurations
|
|
|
|
|
'extensions' => [],
|
2017-02-23 21:22:56 +01:00
|
|
|
|
|
|
|
|
|
# Disable self-update,
|
|
|
|
|
'disable_update' => false,
|
2022-04-02 21:40:30 +02:00
|
|
|
|
|
2023-07-30 12:59:18 +02:00
|
|
|
|
# Trusted IPs (e.g. of last proxy) that are allowed to send unsafe HTTP headers.
|
|
|
|
|
# The connection IP used during FreshRSS setup is automatically added to this list.
|
|
|
|
|
# Will be checked against CONN_REMOTE_ADDR (if available, to be robust even when using Apache mod_remoteip)
|
|
|
|
|
# or REMOTE_ADDR environment variable.
|
|
|
|
|
# This array can be overridden by the TRUSTED_PROXY environment variable.
|
|
|
|
|
# Read the documentation before configuring this https://freshrss.github.io/FreshRSS/en/admins/09_AccessControl.html
|
2022-04-02 21:40:30 +02:00
|
|
|
|
'trusted_sources' => [
|
|
|
|
|
'127.0.0.0/8',
|
|
|
|
|
'::1/128',
|
|
|
|
|
]
|
2015-01-05 16:54:16 +01:00
|
|
|
|
);
|