diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/en/admins/01_Index.md | 1 | ||||
| -rw-r--r-- | docs/en/admins/02_Installation.md | 2 | ||||
| -rw-r--r-- | docs/en/admins/04_Frequently_Asked_Questions.md | 28 | ||||
| -rw-r--r-- | docs/en/users/03_Main_view.md | 17 | ||||
| -rw-r--r-- | docs/en/users/06_Fever_API.md | 2 | ||||
| -rw-r--r-- | docs/en/users/06_Mobile_access.md | 2 | ||||
| -rw-r--r-- | docs/fr/users/01_Installation.md | 2 | ||||
| -rw-r--r-- | docs/fr/users/06_Mobile_access.md | 2 |
8 files changed, 53 insertions, 3 deletions
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/02_Installation.md b/docs/en/admins/02_Installation.md index 7d001c3e4..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 | | +| PHP modules | Required: libxml, cURL, PDO_MySQL, PCRE and ctype. <br>Required (32-bit only): GMP <br> Recommanded: JSON, Zlib, mbstring, iconv, ZipArchive <br> *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/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 <username> +``` + +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. diff --git a/docs/en/users/03_Main_view.md b/docs/en/users/03_Main_view.md index 53d7131b6..59d051e7e 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 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 refreshes. For detailed Documentation see "Form authentication". ### Online cron diff --git a/docs/en/users/06_Fever_API.md b/docs/en/users/06_Fever_API.md index 909164516..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-3](https://itunes.apple.com/app/reeder-3/id697846300) + - [Reeder-4](https://itunes.apple.com/app/reeder-4/id1449412357) - MacOS - [Readkit](https://itunes.apple.com/app/readkit/id588726889) 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/01_Installation.md b/docs/fr/users/01_Installation.md index 7901aa698..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 | | + | Modules PHP | Requis : libxml, cURL, PDO_MySQL, PCRE et ctype<br>Requis (32 bits seulement) : GMP<br>Recommandé : JSON, Zlib, mbstring et iconv, ZipArchive<br>*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+ | 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 |