Normal view

TODO

Global view

TODO

Reader view

TODO

Refreshing feeds

To take full advantage of FreshRSS, it needs to retrieve new items from the feeds you have subscribed to. There are several ways to do this.

Automatic update

This is the recommended method since you can forget about it once it is configured.

With the actualize_script.php script

This method is only available if you have access to the scheduled tasks of the machine on which your FreshRSS instance is installed.

The script is named actualize_script.php and is located in the app folder. The scheduled task syntax will not be explained here. However, here is a quick introduction to crontab that might help you.

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:

Online cron

If you do not have access to the installation server scheduled task, you can still automate the update process.

To do so, you need to create a scheduled task, which need to call a specific URL: https://freshrss.example.net/i/?c=feed&a=actualize (it could be different depending on your installation). Depending on your application authentication method, you need to adapt the scheduled task.

No authentication

This is the most straightforward since you have a public instance; there is nothing special to configure:

0 * * * * curl 'https://freshrss.example.net/i/?c=feed&a=actualize'

Form authentication

If you configure the application to allow anonymous reading, you can also allow anonymous users to update feeds (“Allow anonymous refresh of the articles”).

Anonymous access configuration

The URL used in the previous section will now become accessible to anyone. Therefore you can use the same syntax for the scheduled task.

You can also configure an authentication token to grant special access on the server.

Token configuration

The scheduled task syntax should look as follows:

0 * * * * curl 'https://freshrss.example.net/i/?c=feed&a=actualize&token=my-token'

You can also target a different user by adding their username to the query string, with &user=insert-username:

0 * * * * curl 'https://freshrss.example.net/i/?c=feed&a=actualize&user=someone&token=my-token'

HTTP authentication

When using HTTP authentication, the syntax in the two previous sections is unusable. You’ll need to provide your credentials to the scheduled task. Note that this method is highly discouraged since it means that your credentials will be in plain sight!

0 * * * * curl -u alice:password123 'https://freshrss.example.net/i/?c=feed&a=actualize'

Manual update

If you can’t or don’t want to use the automatic method, you can update manually. There are two methods for updating all or some of the feeds.

Complete update

This update occurs on all feeds. To trigger it, simply click on the update link in the navigation menu.

Navigation menu

When the update starts, a progress bar appears and changes while feeds are processed.

Progress bar

Partial update

This update occurs on the selected feed only. To trigger it, simply click on the update link in the feed menu.

Feed menu

Filtering articles

When the number of articles stored by FreshRSS inevitably grows larger, it’s important to use efficient filters to display only a subset of the articles. There are several methods that filter with different criteria. Usually those methods can be combined.

By category

This is the easiest method. You only need to click on the category title in the side panel. There are two special categories at the top of the panel:

By feed

There are several methods to filter articles by feed:

Feed filter

By status

Each article has two attributes that can be combined. The first attribute indicates whether or not the article has been read. The second attribute indicates if the article was marked as favorite or not.

In version 0.7, attribute filters are available in the article display dropdown list. With this version, it’s not possible to combine filters. For instance, it’s not possible to display only read and favorite articles.

Attribute filters in 0.7

Starting with version 0.8, all attribute filters are visible as toggle icons. They can be combined. As any combination is possible, some have the same result. For instance, the result for all filters selected is the same as no filter selected.

Attribute filters in 0.8

By default, this filter displays only unread articles

By content

It is possible to filter articles by their content by inputting a string in the search field.

With the search field

You can use the search field to further refine results:

Be careful not to enter a space between the operator and the search value.

Some operators can be used negatively, to exclude articles, with the same syntax as above, but prefixed by a ! or -: !f:234, -author:name, -intitle:keyword, -inurl:keyword, -#tag, !keyword, !date:2019, !date:P1W, !pubdate:P3d/.

It is also possible to combine keywords to create a more precise filter. For example, you can enter multiple instances of f:, author:, intitle:, inurl:, #, and free-text.

Combining several search criteria implies a logical and, but the keyword ` OR ` can be used to combine several search criteria with a logical or instead: author:Dupont OR author:Dupond