From 097d7718699af0a9d81368d7bf37538f5ca6fb7f Mon Sep 17 00:00:00 2001 From: Fake4d Date: Mon, 29 Apr 2019 10:35:28 +0200 Subject: Update 03_Main_view.md Document all the parameters for "feed actualize". the new parameter "maxfeeds" from Pull Request #2388 is already considered. --- docs/en/users/03_Main_view.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'docs') diff --git a/docs/en/users/03_Main_view.md b/docs/en/users/03_Main_view.md index 53d7131b6..9588063d7 100644 --- a/docs/en/users/03_Main_view.md +++ b/docs/en/users/03_Main_view.md @@ -30,6 +30,23 @@ Here is an example to trigger article update every hour. 0 * * * * php /path/to/FreshRSS/app/actualize_script.php > /tmp/FreshRSS.log 2>&1 ``` +Special parameters to configure the script - all parameters can be combined: + +- Parameter "force" +https://freshrss.example.net/i/?c=feed&a=actualize&force=1 +If force is set to 1 all feeds will be refreshed at once. + +- Parameter "ajax" +https://freshrss.example.net/i/?c=feed&a=actualize&ajax=1 +Only a status site is returned and not a complete website. Example: "OK" + +- Parameter "maxfeeds" +https://freshrss.example.net/i/?c=feed&a=actualize&maxfeeds=30 +If maxfeeds is set the confgured amount of feeds is refreshed at once. The default setting is "10". + +- Parameter "token" +https://freshrss.example.net/i/?c=feed&a=actualize&token=542345872345734 +Security parameter to prevent unauthorized refreshs. For detailed Documentation see "Form authentication". ### Online cron -- cgit v1.2.3 From 0cd992df37fa9152ff2c1320d07f25451a7abcc8 Mon Sep 17 00:00:00 2001 From: Fake4d Date: Mon, 29 Apr 2019 10:40:54 +0200 Subject: Update 03_Main_view.md Typo in Param maxFeeds --- docs/en/users/03_Main_view.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/en/users/03_Main_view.md b/docs/en/users/03_Main_view.md index 9588063d7..2ec30f333 100644 --- a/docs/en/users/03_Main_view.md +++ b/docs/en/users/03_Main_view.md @@ -40,9 +40,9 @@ If force is set to 1 all feeds will be refreshed at once. https://freshrss.example.net/i/?c=feed&a=actualize&ajax=1 Only a status site is returned and not a complete website. Example: "OK" -- Parameter "maxfeeds" -https://freshrss.example.net/i/?c=feed&a=actualize&maxfeeds=30 -If maxfeeds is set the confgured amount of feeds is refreshed at once. The default setting is "10". +- Parameter "maxFeeds" +https://freshrss.example.net/i/?c=feed&a=actualize&maxFeeds=30 +If maxFeeds is set the confgured amount of feeds is refreshed at once. The default setting is "10". - Parameter "token" https://freshrss.example.net/i/?c=feed&a=actualize&token=542345872345734 -- cgit v1.2.3 From 8df7caa0cf8209fcd2bedbc0c064578deb7330db Mon Sep 17 00:00:00 2001 From: Fake4d Date: Mon, 29 Apr 2019 11:03:01 +0200 Subject: Update 06_Fever_API.md Reeder-4 is new - Reeder-3 is the old version BUT: 3 is free ;-) And you have to pay for the new version.. So I dont know whether this should be linked here.. --- docs/en/users/06_Fever_API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/en/users/06_Fever_API.md b/docs/en/users/06_Fever_API.md index 909164516..dd575f54c 100644 --- a/docs/en/users/06_Fever_API.md +++ b/docs/en/users/06_Fever_API.md @@ -26,7 +26,7 @@ Tested with: - iOS - [Fiery Feeds](https://itunes.apple.com/app/fiery-feeds-rss-reader/id1158763303) - [Unread](https://itunes.apple.com/app/unread-rss-reader/id1252376153) - - [Reeder-3](https://itunes.apple.com/app/reeder-3/id697846300) + - [Reeder-4](https://itunes.apple.com/de/app/reeder-4/id1449412357) - MacOS - [Readkit](https://itunes.apple.com/app/readkit/id588726889) -- cgit v1.2.3 From 05420ef40e02f0f8af7263a1e702d33a24b34f48 Mon Sep 17 00:00:00 2001 From: Alexandre Alapetite Date: Thu, 30 May 2019 12:30:35 +0200 Subject: Remove /de/ in URL --- docs/en/users/06_Fever_API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/en/users/06_Fever_API.md b/docs/en/users/06_Fever_API.md index dd575f54c..b895d4eae 100644 --- a/docs/en/users/06_Fever_API.md +++ b/docs/en/users/06_Fever_API.md @@ -26,7 +26,7 @@ Tested with: - iOS - [Fiery Feeds](https://itunes.apple.com/app/fiery-feeds-rss-reader/id1158763303) - [Unread](https://itunes.apple.com/app/unread-rss-reader/id1252376153) - - [Reeder-4](https://itunes.apple.com/de/app/reeder-4/id1449412357) + - [Reeder-4](https://itunes.apple.com/app/reeder-4/id1449412357) - MacOS - [Readkit](https://itunes.apple.com/app/readkit/id588726889) -- cgit v1.2.3 From 5ccbd662c5aa1cb2bbdf5bf7cd2bbd64f556b1b2 Mon Sep 17 00:00:00 2001 From: Alexandre Alapetite Date: Thu, 30 May 2019 12:33:27 +0200 Subject: Fix typos --- docs/en/users/03_Main_view.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/en/users/03_Main_view.md b/docs/en/users/03_Main_view.md index 2ec30f333..59d051e7e 100644 --- a/docs/en/users/03_Main_view.md +++ b/docs/en/users/03_Main_view.md @@ -34,7 +34,7 @@ Special parameters to configure the script - all parameters can be combined: - Parameter "force" https://freshrss.example.net/i/?c=feed&a=actualize&force=1 -If force is set to 1 all feeds will be refreshed at once. +If *force* is set to 1 all feeds will be refreshed at once. - Parameter "ajax" https://freshrss.example.net/i/?c=feed&a=actualize&ajax=1 @@ -42,11 +42,11 @@ Only a status site is returned and not a complete website. Example: "OK" - Parameter "maxFeeds" https://freshrss.example.net/i/?c=feed&a=actualize&maxFeeds=30 -If maxFeeds is set the confgured amount of feeds is refreshed at once. The default setting is "10". +If *maxFeeds* is set the configured amount of feeds is refreshed at once. The default setting is "10". - Parameter "token" https://freshrss.example.net/i/?c=feed&a=actualize&token=542345872345734 -Security parameter to prevent unauthorized refreshs. For detailed Documentation see "Form authentication". +Security parameter to prevent unauthorized refreshes. For detailed Documentation see "Form authentication". ### Online cron -- cgit v1.2.3 From f9d0f20dbc09bb25562118bf39dbfc354e92ce36 Mon Sep 17 00:00:00 2001 From: Sp3r4z Date: Sun, 16 Jun 2019 15:16:21 +0000 Subject: Add Dockerfile links for PHP modules list (#2409) * Add whole PHP modules Dockerfile link * Add Dockerfile link to whole PHP modules list --- docs/en/admins/02_Installation.md | 2 +- docs/fr/users/01_Installation.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/en/admins/02_Installation.md b/docs/en/admins/02_Installation.md index 7d001c3e4..f21c5a05f 100644 --- a/docs/en/admins/02_Installation.md +++ b/docs/en/admins/02_Installation.md @@ -8,7 +8,7 @@ You need to verify that your server can run FreshRSS before installing it. If yo | ----------- | ---------------- | ----------------------------- | | Web server | **Apache 2** | Nginx | | PHP | **PHP 5.5+** | PHP 5.3.8+ | -| PHP modules | Required: libxml, cURL, PDO_MySQL, PCRE and ctype. \\ Required (32-bit only): GMP \\Recommanded: JSON, Zlib, mbstring, iconv, ZipArchive | | +| PHP modules | Required: libxml, cURL, PDO_MySQL, PCRE and ctype. \\Required (32-bit only): GMP \\Recommanded: JSON, Zlib, mbstring, iconv, ZipArchive \\(For the whole modules list see [Dockerfile](https://github.com/FreshRSS/FreshRSS/blob/744a9e8cf00aef7dec0acfa5f90f0dcfa2ef8837/Docker/Dockerfile-Alpine#L7-L9)) | | | Database | **MySQL 5.5.3+** | SQLite 3.7.4+ | | Browser | **Firefox** | Chrome, Opera, Safari, or IE11+ | diff --git a/docs/fr/users/01_Installation.md b/docs/fr/users/01_Installation.md index 7901aa698..2bcb317cf 100644 --- a/docs/fr/users/01_Installation.md +++ b/docs/fr/users/01_Installation.md @@ -8,7 +8,7 @@ Il est toutefois de votre responsabilité de vérifier que votre hébergement pe | -------- | ----------- | --------------------- | | Serveur web | **Apache 2** | Nginx | | PHP | **PHP 5.5+** | PHP 5.3.8+ | - | Modules PHP | Requis : libxml, cURL, PDO_MySQL, PCRE et ctype \\ Requis (32 bits seulement) : GMP \\ Recommandé : JSON, Zlib, mbstring et iconv, ZipArchive | | + | Modules PHP | Requis : libxml, cURL, PDO_MySQL, PCRE et ctype \\ Requis (32 bits seulement) : GMP \\ Recommandé : JSON, Zlib, mbstring et iconv, ZipArchive \\(Pour une liste complète des modules nécessaires voir le [Dockerfile](https://github.com/FreshRSS/FreshRSS/blob/744a9e8cf00aef7dec0acfa5f90f0dcfa2ef8837/Docker/Dockerfile-Alpine#L7-L9)) | | | Base de données | **MySQL 5.5.3+** | SQLite 3.7.4+ | | Navigateur | **Firefox** | Chrome, Opera, Safari, or IE 11+ | -- cgit v1.2.3 From 1a1486004095db9b058cedcffdedc35e9ef3f789 Mon Sep 17 00:00:00 2001 From: Sp3r4z Date: Sun, 16 Jun 2019 18:12:51 +0000 Subject: Fix line break in table (#2413) * Fix line return Better with HTML native `
` than with `\\` * Fix line break Replace `\\` by native HTML `
` --- docs/en/admins/02_Installation.md | 2 +- docs/fr/users/01_Installation.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/en/admins/02_Installation.md b/docs/en/admins/02_Installation.md index f21c5a05f..8cb15edb4 100644 --- a/docs/en/admins/02_Installation.md +++ b/docs/en/admins/02_Installation.md @@ -8,7 +8,7 @@ You need to verify that your server can run FreshRSS before installing it. If yo | ----------- | ---------------- | ----------------------------- | | Web server | **Apache 2** | Nginx | | PHP | **PHP 5.5+** | PHP 5.3.8+ | -| PHP modules | Required: libxml, cURL, PDO_MySQL, PCRE and ctype. \\Required (32-bit only): GMP \\Recommanded: JSON, Zlib, mbstring, iconv, ZipArchive \\(For the whole modules list see [Dockerfile](https://github.com/FreshRSS/FreshRSS/blob/744a9e8cf00aef7dec0acfa5f90f0dcfa2ef8837/Docker/Dockerfile-Alpine#L7-L9)) | | +| PHP modules | Required: libxml, cURL, PDO_MySQL, PCRE and ctype.
Required (32-bit only): GMP
Recommanded: JSON, Zlib, mbstring, iconv, ZipArchive
*For the whole modules list see [Dockerfile](https://github.com/FreshRSS/FreshRSS/blob/744a9e8cf00aef7dec0acfa5f90f0dcfa2ef8837/Docker/Dockerfile-Alpine#L7-L9)* | | | Database | **MySQL 5.5.3+** | SQLite 3.7.4+ | | Browser | **Firefox** | Chrome, Opera, Safari, or IE11+ | diff --git a/docs/fr/users/01_Installation.md b/docs/fr/users/01_Installation.md index 2bcb317cf..a6495d2fd 100644 --- a/docs/fr/users/01_Installation.md +++ b/docs/fr/users/01_Installation.md @@ -8,7 +8,7 @@ Il est toutefois de votre responsabilité de vérifier que votre hébergement pe | -------- | ----------- | --------------------- | | Serveur web | **Apache 2** | Nginx | | PHP | **PHP 5.5+** | PHP 5.3.8+ | - | Modules PHP | Requis : libxml, cURL, PDO_MySQL, PCRE et ctype \\ Requis (32 bits seulement) : GMP \\ Recommandé : JSON, Zlib, mbstring et iconv, ZipArchive \\(Pour une liste complète des modules nécessaires voir le [Dockerfile](https://github.com/FreshRSS/FreshRSS/blob/744a9e8cf00aef7dec0acfa5f90f0dcfa2ef8837/Docker/Dockerfile-Alpine#L7-L9)) | | + | Modules PHP | Requis : libxml, cURL, PDO_MySQL, PCRE et ctype
Requis (32 bits seulement) : GMP
Recommandé : JSON, Zlib, mbstring et iconv, ZipArchive
*Pour une liste complète des modules nécessaires voir le [Dockerfile](https://github.com/FreshRSS/FreshRSS/blob/744a9e8cf00aef7dec0acfa5f90f0dcfa2ef8837/Docker/Dockerfile-Alpine#L7-L9)* | | | Base de données | **MySQL 5.5.3+** | SQLite 3.7.4+ | | Navigateur | **Firefox** | Chrome, Opera, Safari, or IE 11+ | -- cgit v1.2.3 From 9720ab6a4d5b80784109482e4c02d1633c2d8326 Mon Sep 17 00:00:00 2001 From: Alexis Degrugillier Date: Sun, 23 Jun 2019 21:37:30 +0200 Subject: Add FAQ for admin section (#2427) See #1987 and #2102 --- docs/en/admins/01_Index.md | 1 + docs/en/admins/04_Frequently_Asked_Questions.md | 28 +++++++++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 docs/en/admins/04_Frequently_Asked_Questions.md (limited to 'docs') diff --git a/docs/en/admins/01_Index.md b/docs/en/admins/01_Index.md index 446780060..45ed02c0f 100644 --- a/docs/en/admins/01_Index.md +++ b/docs/en/admins/01_Index.md @@ -6,3 +6,4 @@ Learn how to install, update and backup FreshRSS and how to use the command line * [Update your installation](03_Updating.md) to the latest stable or dev version * [The command line interface](https://github.com/FreshRSS/FreshRSS/tree/master/cli) can be used to administrate feeds and users * [Automatic feed updates](https://github.com/FreshRSS/FreshRSS#automatic-feed-update) using cron is the preferred way to get the latest feeds entries +* [Frequently asked questions](04_Frequently_Asked_Questions.md) diff --git a/docs/en/admins/04_Frequently_Asked_Questions.md b/docs/en/admins/04_Frequently_Asked_Questions.md new file mode 100644 index 000000000..8a2ead73e --- /dev/null +++ b/docs/en/admins/04_Frequently_Asked_Questions.md @@ -0,0 +1,28 @@ +We may not have answered all of your questions in the previous sections. The FAQ contains some questions that have not been answered elsewhere. + +## Promoting a user to admin + +At the moment, there can be only one *admin* user for the system. +Thus promoting one user to *admin* demotes the current *admin* user. + +The recommended way of promoting a user is with the help of the CLI tool. +You only have to do is to run the following command: +```sh +./cli/reconfigure.php --default_user +``` + +Alternatively, you can edit configuration files manually. +To do so, you need to change the *default_user* value in the file *./data/config.php*. +As the file is a PHP file, you have to make sure that it's still valid after the update by running the following command: +```sh +php -l ./data/config.php +``` + +## Disabling self-registration + +Users can register directly on the login screen only if the configuration allows them. +Under *Administration* > *System configuration*, you have access to *Max number of accounts*. +As stated on that page, there is no limitation if you input **0**, thus allowing any number of user to self-register. +If you input any other number, you will create a limitation on self-registering users. +That means that as soon as the limit is reached, users cannot self-register but they can still be registered by the *admin* user. +Using the value **1**, disables the self-registration since the spot is used by the *admin* user. -- cgit v1.2.3 From e09cf3fc7145f3f43b55522aa10b9f0d9f3391ea Mon Sep 17 00:00:00 2001 From: Purexo Date: Mon, 15 Jul 2019 15:44:50 +0200 Subject: Promote FreshRSS-Notify in user documentation (#2445) * Add FreshRSS-Notify in Clients compatibles section * Add FreshRSS-Notify in Compatible clients section * Use language-neutral link https://addons.mozilla.org/firefox/addon/freshrss-notify-webextension/ --- docs/en/users/06_Mobile_access.md | 2 ++ docs/fr/users/06_Mobile_access.md | 2 ++ 2 files changed, 4 insertions(+) (limited to 'docs') diff --git a/docs/en/users/06_Mobile_access.md b/docs/en/users/06_Mobile_access.md index 4a2068404..13dba828d 100644 --- a/docs/en/users/06_Mobile_access.md +++ b/docs/en/users/06_Mobile_access.md @@ -55,6 +55,8 @@ See the [page about the Fever compatible API](06_Fever_API.md) for another possi * [FeedReader 2.0+](https://jangernert.github.io/FeedReader/) (Open source) * MacOS * [Vienna RSS](http://www.vienna-rss.com/) (Open source) + * Firefox + * [FreshRSS-Notify](https://addons.mozilla.org/firefox/addon/freshrss-notify-webextension/) (Open source) # Google Reader compatible API diff --git a/docs/fr/users/06_Mobile_access.md b/docs/fr/users/06_Mobile_access.md index 4f5d24157..7bce9eea3 100644 --- a/docs/fr/users/06_Mobile_access.md +++ b/docs/fr/users/06_Mobile_access.md @@ -69,6 +69,8 @@ Tout client supportant une API de type Google Reader. Sélection : * [FeedReader 2.0+](https://jangernert.github.io/FeedReader/) (Libre) * MacOS * [Vienna RSS](http://www.vienna-rss.com/) (Libre) +* Firefox + * [FreshRSS-Notify](https://addons.mozilla.org/fr/firefox/addon/freshrss-notify-webextension/) (Libre) # API compatible Google Reader -- cgit v1.2.3