diff options
| author | 2021-03-15 00:00:25 +0100 | |
|---|---|---|
| committer | 2021-03-15 00:00:25 +0100 | |
| commit | 1c3159058fd256ec7163a29c9865dbd3dbe05f17 (patch) | |
| tree | 5b3a9df3cc709a4b370f6f03cf79c50483275344 /docs/en/users | |
| parent | 769f34e958b50e748acf6a151805f4a255df2043 (diff) | |
Quick update the doc for master renaming to edge
Diffstat (limited to 'docs/en/users')
| -rw-r--r-- | docs/en/users/04_Subscriptions.md | 26 | ||||
| -rw-r--r-- | docs/en/users/07_Frequently_Asked_Questions.md | 13 |
2 files changed, 23 insertions, 16 deletions
diff --git a/docs/en/users/04_Subscriptions.md b/docs/en/users/04_Subscriptions.md index bfb3eabe4..881899ce0 100644 --- a/docs/en/users/04_Subscriptions.md +++ b/docs/en/users/04_Subscriptions.md @@ -8,13 +8,13 @@ 6. (optional): You can set a timeout for the feed request if the feed requires it. 7. (optional): You can choose to ignore SSL certificate errors (such as with self-signed certificates) by setting "Verify SSL security" to "No". This is not recommended, and it is better to either add the root certificate to the FreshRSS server or to fix the SSL certificate problems on the feed hosting server. -# Subscription management +## Subscription management The "Subscription management" submenu allows categories and feeds to be configured. Feeds can be moved between categories by drag-and-drop, or in the individual feed's settings. Hovering over a feed/category will cause a gear icon to appear. Clicking the icon will bring up the settings for that item. ## Category Settings -### Information +### Information * **Title:** Name of category * **Display position:** Defines the order of categories. Lower numbers get priority, non-numbered items come last, and equally numbered items will sort by alphabetical order. @@ -25,7 +25,6 @@ If "Purge Policy" has "By default" selected, then the [default purge policy](./0 ## Feed Settings - These fields will be auto-filled when adding a feed, but they can be modified later. **Visibility** will define if the feed is displayed in the main feed, only in specific categories, or not at all. ### Archival @@ -60,8 +59,10 @@ Here we find that the block that encompasses nothing but the content of the arti * Phoronix: ```#main .content``` ##### Combining CSS Classes + Let's say we have an article which contains ads, and we do not want to have those ads retrieved by FreshRSS. Example HTML: -``` + +```html <div id="article"> <h2>wanted</h2> <p class="content">wanted content</p> @@ -73,6 +74,7 @@ Let's say we have an article which contains ads, and we do not want to have thos <p class="content">wanted content</p> </div> ``` + In this case it's possible to combine multiple CSS selectors with a comma: ```#article p.content, #article h2``` #### Retrieve a truncated feed with external tools @@ -86,8 +88,9 @@ Complementary tools can be used to retrieve full article content, such as: Articles can be automatically marked as read based on some search terms. See [filtering](./03_Main_view.md#filtering-articles) for more information on how to create these filters. -# Import / export -See [SQLite export/import]( https://github.com/FreshRSS/FreshRSS/tree/master/cli) as an alternative. +## Import / export + +See [SQLite export/import]( https://github.com/FreshRSS/FreshRSS/tree/edge/cli) as an alternative. ## Export @@ -101,7 +104,7 @@ See [SQLite export/import]( https://github.com/FreshRSS/FreshRSS/tree/master/cli 4. Click on “export”. ## Import - + 1. Go to the page “Import / export”. 2. Click on “Browse” and select your OPML or archive file on your computer. 3. Click on “Import” @@ -109,11 +112,12 @@ See [SQLite export/import]( https://github.com/FreshRSS/FreshRSS/tree/master/cli > **Important**: you can not import directly a list of feeds from a text file. > You need to convert it beforehand to _OPML_. > Here is some tools you could use : -> - [Pandoc](https://pandoc.org/) available for most systems, -> - [OPML generator](https://opml-gen.ovh/) available online, -> - [txt2opml](https://alterfiles.com/convert/txt/opml) available online. +> +> * [Pandoc](https://pandoc.org/) available for most systems, +> * [OPML generator](https://opml-gen.ovh/) available online, +> * [txt2opml](https://alterfiles.com/convert/txt/opml) available online. -# Use bookmarklet +## Use bookmarklet Bookmarklets are little scripts that you can execute to perform various tasks. FreshRSS offers a bookmarklet for subscribing to newsfeeds. diff --git a/docs/en/users/07_Frequently_Asked_Questions.md b/docs/en/users/07_Frequently_Asked_Questions.md index c5f039f17..f9b6fcd61 100644 --- a/docs/en/users/07_Frequently_Asked_Questions.md +++ b/docs/en/users/07_Frequently_Asked_Questions.md @@ -34,14 +34,17 @@ Since the [1.10.0](https://github.com/FreshRSS/FreshRSS/releases/tag/1.10.0) rel Select a user, enter a password, and validate. Since the [1.8.0](https://github.com/FreshRSS/FreshRSS/releases/tag/1.8.0) release, admins can change user passwords using a terminal. It worth mentioning that you must have access to PHP CLI. Open a terminal, and type the following command: + ```sh ./cli/update_user.php --user <username> --password <password> ``` -For more information on that matter, please refer to the [dedicated documentation](https://github.com/FreshRSS/FreshRSS/blob/master/cli/README.md). + +For more information on that matter, please refer to the [dedicated documentation](https://github.com/FreshRSS/FreshRSS/blob/edge/cli/README.md). ## Permissions under SELinux Some Linux distribution, like Fedora or RedHat Enterprise Linux, have SELinux enabled. This acts similar to a firewall application, so that applications can't write or modify files under certain conditions. While installing FreshRSS, step 2 can fail if the httpd process can't write to some data sub-directories. The following command should be executed as root to fix this problem: + ```sh semanage fcontext -a -t httpd_sys_rw_content_t '/usr/share/FreshRSS/data(/.*)?' restorecon -Rv /usr/share/FreshRSS/data @@ -55,8 +58,8 @@ If you are using a version prior to 1.16, you can disable your ad-blocker for Fr Examples with _uBlock_: -- Whitelist your FreshRSS instance by adding it in _uBlock > Open the dashboard > Whitelist_. -- Authorize your FreshRSS instance to call `sharing` configuration page by adding the rule `*sharing,domain=~yourdomain.com` in _uBlock > Open the dashboard > My filters_ +* Whitelist your FreshRSS instance by adding it in _uBlock > Open the dashboard > Whitelist_. +* Authorize your FreshRSS instance to call `sharing` configuration page by adding the rule `*sharing,domain=~yourdomain.com` in _uBlock > Open the dashboard > My filters_ ## Problems with firewalls @@ -64,8 +67,8 @@ If you have the error "Blast! This feed has encountered a problem. Please verify To identify the problem, here are the steps to follow: -- step 1: Try to reach the feed locally to discard a problem with the feed itself. You can use your browser to this purpose. -- step 2: Try to reach the feed from the host in which FreshRSS is installed. Something like `time curl -v 'https://github.com/FreshRSS/FreshRSS/commits/master.atom'` should make the deal. If you are running FreshRSS within a Docker container, then you can check connectivity from within the container itself with something similar to `sudo docker exec freshrss php -r "readfile('https://github.com/FreshRSS/FreshRSS/commits/master.atom');"`. If none of this works, then it might be a problem with your firewall. +* step 1: Try to reach the feed locally to discard a problem with the feed itself. You can use your browser to this purpose. +* step 2: Try to reach the feed from the host in which FreshRSS is installed. Something like `time curl -v 'https://github.com/FreshRSS/FreshRSS/commits/edge.atom'` should make the deal. If you are running FreshRSS within a Docker container, then you can check connectivity from within the container itself with something similar to `sudo docker exec freshrss php -r "readfile('https://github.com/FreshRSS/FreshRSS/commits/edge.atom');"`. If none of this works, then it might be a problem with your firewall. Then to fix it, you need to do check your firewall configuration and ensure that you are not blocking connections to IPs and/or ports in which your feeds are located. If using iptables and you are blocking inbound connections to ports 80/443, check that the rules are properly configured and you are not also blocking outbound connections to the very same ports. |
