diff options
| author |  maTh <math-home@web.de>
| 2022-08-21 22:44:03 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-08-21 22:44:03 +0200 |
| commit | 4214954ea169e6cf6b9a7b2927dce892463c851c (patch) | |
| tree | 2ef0a50dfe56343a51eaeb4864f3eee77d7d82d2 /docs | |
| parent | 85991d1c5ca1b29503e11be65a33da9a7e0c154a (diff) | |
Improved: error page (#4465)
* error page: true HTML page
* error page: http500 erorr
* error page: add CSP header
* 'log.txt' replaced by LOG_FILENAME
* use ADMIN_LOG
* log.txt => LOG_FILENAME
* error message: add <title>
* Docs created
* delete: documentation on error message page
* line break added
* added: new line at the end
* typo fixed
* Update lib/lib_rss.php
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Update lib/lib_rss.php
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Minz HTTP 500
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/en/admins/01_Index.md | 3 | ||||
| -rw-r--r-- | docs/en/admins/logs_and_errors.md | 40 |
2 files changed, 43 insertions, 0 deletions
diff --git a/docs/en/admins/01_Index.md b/docs/en/admins/01_Index.md index 792434389..8bf07c021 100644 --- a/docs/en/admins/01_Index.md +++ b/docs/en/admins/01_Index.md @@ -2,9 +2,12 @@ Learn how to install, update, and backup FreshRSS, as well as how to use the command line tools. +## System Basics + 1. [Prerequisites](02_Prerequisites.md): What you’ll need to run FreshRSS 2. [General installation instructions](03_Installation.md) for FreshRSS 3. [Update your installation](04_Updating.md) to the latest stable or development version +4. [Logging and error messages](logs_and_errors.md) in case of any troubles ## Tutorials and Examples diff --git a/docs/en/admins/logs_and_errors.md b/docs/en/admins/logs_and_errors.md new file mode 100644 index 000000000..efb05fdb8 --- /dev/null +++ b/docs/en/admins/logs_and_errors.md @@ -0,0 +1,40 @@ +# Logging and Error Messages + +## Read the Log + +### Log in the Application + +The log files are displayed in the config menu. + +### Log as Text Files + +FreshRSS logs are located in: +* user related: `./FreshRSS/data/users/*/log.txt` +* general/system related: `./FreshRSS/data/users/_/log.txt` + +### More Logging Information + +More logs can be generated by enabling `'environment' => 'development'` (default: `'production'`), in `./FreshRSS/data/config.php` + +## Error Message + +If there is an 'Application Problem' or 'Fatal Error', then a HTTP 500 error message is shown with more information. + +## Often the Cause of Problems + +A typical problem is wrong file permissions in the `./FreshRSS/data/` folder so make sure the Web server can write there and in sub-directories. + +## Common locations for additional logs + +Adapt names and paths according to your local setup. + +* If using Docker: `docker logs -f freshrss` +* To check Web server logs on a Linux system using systemd: `journalctl -xeu apache2` and if you are using php-fpm: `journalctl -xeu php-fpm` +* Otherwise, Web server logs are typically located in `/var/log/apache2/` or similar +* System logs may also contain relevant information in `/var/log/syslog`, or if using systemd: `sudo journalctl -xe` + +Running the feed update script (with the same user and PHP version as your Web server) might provide other hints, e.g.: `sudo -u www-data /usr/bin/php ./FreshRSS/app/actualize_script.php` + +## Help needed + +see: [Report a bug](https://freshrss.github.io/FreshRSS/en/contributing.html) |