mirror of https://github.com/FreshRSS/FreshRSS.git
Docs: hidden configs (#6402)
* Create 17_configs_not_ui.md * reorganize admin overview page. Added the link to the new doc * Update 17_configs_not_ui.md * Update 17_configs_not_ui.md * Update 17_configs_not_ui.md * fix typo
This commit is contained in:
maTh
GitHub
parent
40ac02544e
commit
cd66ca54ca
|
|
@ -11,19 +11,32 @@ Learn how to install, update, and backup FreshRSS, as well as how to use the com
|
|||
|
||||
## Tutorials and Examples
|
||||
|
||||
* [User management](12_User_management.md)
|
||||
### General
|
||||
|
||||
* [Backing up FreshRSS](05_Backup.md)
|
||||
* [Installing and managing extensions](15_extensions.md)
|
||||
* [Installing themes](11_Themes.md)
|
||||
* [Setting Up Automatic Feed Updating](08_FeedUpdates.md)
|
||||
* [Database configuration](DatabaseConfig.md)
|
||||
* [Using the command line interface (CLI)](https://github.com/FreshRSS/FreshRSS/tree/edge/cli)
|
||||
* [Configuration without an user interface](17_configs_not_ui.md)
|
||||
* [Frequently asked questions](04_Frequently_Asked_Questions.md)
|
||||
|
||||
### User access
|
||||
|
||||
* [User management](12_User_management.md)
|
||||
* [Access Control](09_AccessControl.md)
|
||||
* [OpenID Connect](16_OpenID-Connect.md)
|
||||
* [Configuring the email address validation](05_Configuring_email_validation.md)
|
||||
|
||||
### Web server configuration
|
||||
|
||||
* [Apache/Nginx configuration files](10_ServerConfig.md)
|
||||
* [Reverse proxy with Caddy](Caddy.md)
|
||||
|
||||
### Special server information
|
||||
|
||||
* [Installation on Debian 9/Ubuntu 16.04](06_LinuxInstall.md)
|
||||
* [Installation on Cloud Providers](14_CloudProviders.md)
|
||||
* [Updating on Debian 9/Ubuntu 16.04](07_LinuxUpdate.md)
|
||||
* [Setting Up Automatic Feed Updating](08_FeedUpdates.md)
|
||||
* [Access Control](09_AccessControl.md)
|
||||
* [OpenID Connect](16_OpenID-Connect.md)
|
||||
* [Apache/Nginx configuration files](10_ServerConfig.md)
|
||||
* [Database configuration](DatabaseConfig.md)
|
||||
* [Using the command line interface (CLI)](https://github.com/FreshRSS/FreshRSS/tree/edge/cli)
|
||||
* [Configuring the email address validation](05_Configuring_email_validation.md)
|
||||
* [Reverse proxy with Caddy](Caddy.md)
|
||||
* [Frequently asked questions](04_Frequently_Asked_Questions.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,93 @@
|
|||
# System Configurations without an User Interface
|
||||
|
||||
Most of configurations are available in the user interface.
|
||||
|
||||
Here is an overview of not available configs
|
||||
|
||||
## System wide configuration
|
||||
|
||||
see `./config.default.php` for all options. This file is very well documented.
|
||||
|
||||
Do not modify this file, which defines default values,
|
||||
but instead edit `./data/config.php` after the install process is completed,
|
||||
or edit `./data/config.custom.php` before the install process.
|
||||
|
||||
### Some selected options
|
||||
|
||||
#### System config: environment
|
||||
|
||||
(recommended) `'production'`: Does not PHP error messages within the application, just in the error log.
|
||||
|
||||
`'development'`: Displays PHP error messages within the application not just in the error log. Useful for code writing and testing. Use it on your secure development environment. Do not use it on production systems.
|
||||
|
||||
It does not have any effect for choosing the release channels.
|
||||
|
||||
`'environment'` default value `'production'`
|
||||
|
||||
#### System config: base_url
|
||||
|
||||
This option is displayed in Administration -> System configuration, but is not editable there.
|
||||
|
||||
This settings needs to be changed after moving the FreshRSS application from one server to another.
|
||||
|
||||
`'base_url'` value will be set while install process and depends on your server environment.
|
||||
|
||||
#### System config: logo_html
|
||||
|
||||
Replace the FreshRSS logo in the user interface with an own HTML code that includes the `<img>` tag as well.
|
||||
|
||||
It is rendered inside an `<a>...</a>` element and must be valid HTML or text.
|
||||
|
||||
It does not replace the FreshRSS logo as favicon, in the browser notification, and shortcut icon.
|
||||
|
||||
`'logo_html'` default value `''`
|
||||
|
||||
Example: `'<img class="logo" src="https://example.net/Hello.png" alt="Logo Example" /> Hello'`
|
||||
|
||||
#### System config: Sending an email
|
||||
|
||||
See the documentation directly in the source code `config.default.php`
|
||||
|
||||
## Application wide constants
|
||||
|
||||
See `./constants.php`. Do not edit this file. Create/edit `./constants.local.php` instead.
|
||||
|
||||
Some constants cannot be `update safe` changed. They are marked with `Not customisable`
|
||||
|
||||
### Example of constants.local.php
|
||||
|
||||
``` php
|
||||
<?php
|
||||
define('CLEANCACHE_HOURS', 100);
|
||||
```
|
||||
|
||||
File name: `constants.local.php`
|
||||
|
||||
Location: root directory of FreshRSS
|
||||
|
||||
### Some selected constants
|
||||
|
||||
#### Application constant: FRESHRSS_USERAGENT
|
||||
|
||||
FreshRSS has a default user agent string that can be overwritten in each feed setting.
|
||||
|
||||
`'FRESHRSS_USERAGENT'` default value starts with `'FreshRSS/'` and the FreshRSS version, used operating system and link to FreshRSS website.
|
||||
|
||||
|
||||
#### Application constant: CLEANCACHE_HOURS
|
||||
|
||||
FreshRSS keeps feeds and fetched websites as `.spc` or `.html` file in `./data/cache` for a limited time. In some cases the storage could use a lot of storage space. Reducing the clean cache hours reduces the space.
|
||||
|
||||
`'CLEANCACHE_HOURS'` default value `720` (hours = 30 days)
|
||||
|
||||
|
||||
## User wide configuration
|
||||
|
||||
Available for each user in `config.php` in `./data/users/username`. Edit there. Do not edit `./config-user.default.php` (it will be overwritten by the next system update and overruled by the user config file).
|
||||
|
||||
|
||||
### User: simplify_over_n_feeds
|
||||
|
||||
Advanced property to automatically simplify the layout when there are many (1k+) feeds so that FreshRSS works out of the box with 20k+ feeds scenarios
|
||||
|
||||
`'simplify_over_n_feeds'` default value: `1000`
|
||||
Loading…
Reference in New Issue