aboutsummaryrefslogtreecommitdiff
path: root/docs/en/users
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2018-12-22 13:22:20 +0100
committerGravatar GitHub <noreply@github.com> 2018-12-22 13:22:20 +0100
commitf0a359619fa2936d66a2b96dd086d4686e7405fa (patch)
treeddad42a7f6813bd458f39d5203d083daad4cc1c5 /docs/en/users
parente04804d0f67dd43fd3f072b9a127768ee7b7b56c (diff)
parent4a1a852f457d52fa47191e3f7e3e9073e1324cd9 (diff)
Merge pull request #2186 from FreshRSS/dev1.13.0
FreshRSS 1.13.0
Diffstat (limited to 'docs/en/users')
-rw-r--r--docs/en/users/03_Main_view.md13
-rw-r--r--docs/en/users/04_Subscriptions.md10
-rw-r--r--docs/en/users/05_Configuration.md38
-rw-r--r--docs/en/users/06_Mobile_access.md2
4 files changed, 35 insertions, 28 deletions
diff --git a/docs/en/users/03_Main_view.md b/docs/en/users/03_Main_view.md
index 57eab192d..53d7131b6 100644
--- a/docs/en/users/03_Main_view.md
+++ b/docs/en/users/03_Main_view.md
@@ -35,14 +35,14 @@ Here is an example to trigger article update every hour.
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://your.server.net/FreshRSS/p/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.
+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:
```cron
-0 * * * * curl 'https://your.server.net/FreshRSS/p/i/?c=feed&a=actualize'
+0 * * * * curl 'https://freshrss.example.net/i/?c=feed&a=actualize'
```
### Form authentication
@@ -60,16 +60,21 @@ You can also configure an authentication token to grant a special right on the s
The scheduled task syntax to use will be the following:
```cron
-0 * * * * curl 'https://your.server.net/FreshRSS/p/i/?c=feed&a=actualize&token=my-token'
+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`:
+
+```cron
+0 * * * * curl 'https://freshrss.example.net/i/?c=feed&a=actualize&user=someone&token=my-token'
+```
### HTTP authentication
In that case, the syntax in the two previous section are unusable. It means that you 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!**
```cron
-0 * * * * curl -u alice:password123 'https://your.server.net/FreshRSS/p/i/?c=feed&a=actualize'
+0 * * * * curl -u alice:password123 'https://freshrss.example.net/i/?c=feed&a=actualize'
```
## Manual update
diff --git a/docs/en/users/04_Subscriptions.md b/docs/en/users/04_Subscriptions.md
index 0772be4cc..4b40f691a 100644
--- a/docs/en/users/04_Subscriptions.md
+++ b/docs/en/users/04_Subscriptions.md
@@ -8,7 +8,11 @@
# Use bookmarklet
-**TODO**
+Bookmarklets are little scripts that you can execute to perform useful or frivolous tasks. FreshRSS offers a bookmarklet for subscribing to newsfeeds.
+
+ 1. Open "Subscriptions management".
+ 2. Click on "Subscription tools".
+ 3. Drag the "Subscribe" button to your bookmark toolbar or right click and choose your browser's "Bookmark link" action.
# Feed management
@@ -16,7 +20,9 @@
# Firefox subscription service
-You can manually add your FreshRSS app to the list of Firefox subscription services which will enable you to subscribe to sites which provide a feed link using the Firefox built-in "Subscribe" button. An in-depth process is described in the [official documentation](https://developer.mozilla.org/en-US/Firefox/Releases/2/Adding_feed_readers_to_Firefox) but you can use the following steps:
+NB: From version 63 and onwards Firefox has removed the ability to add your own subscription services that aren't standalone programs. This makes it impossible to add FreshRSS to the feed preview/subscription page, though this page is set to be removed from version 64 anyway (see [bugzilla](https://bugzilla.mozilla.org/show_bug.cgi?id=1477667)). You can use the bookmarklet mentioned above for an easy way to subscribe to feeds.
+
+If you're using a version pre-63 you can manually add your FreshRSS app to the list of Firefox subscription services, which enables you to subscribe to sites which provide a feed link using the Firefox built-in "Subscribe" button. An in-depth process is described in the [official documentation](https://developer.mozilla.org/en-US/Firefox/Releases/2/Adding_feed_readers_to_Firefox) but you can use the following steps:
1. Open about:config in Firefox
diff --git a/docs/en/users/05_Configuration.md b/docs/en/users/05_Configuration.md
index 154cd98b5..225c1e5f9 100644
--- a/docs/en/users/05_Configuration.md
+++ b/docs/en/users/05_Configuration.md
@@ -9,36 +9,22 @@ the missing bits or add a new language, please check how you can [contribute to
There are parts of FreshRSS that are not translated and are not intended to be translated. For now, the logs visible in the application as well as the one generated by automatic update scripts are part of it.
-Not all languages are equals regarding completion:
-
-| Language | Completion |
-|----------|-----------:|
-| cz | 87.4% |
-| de | 88.1% |
-| en | 100% |
-| es | 88.7% |
-| fr | 99.3% |
-| he | 69.6% |
-| it | 86.4% |
-| kr | 96.3% |
-| nl | 95.4% |
-| pt-br | 87.4% |
-| ru | 36.4% |
-| tr | 88.1% |
-| zh-cn | 99.0% |
+Available languages are: cz, de, en, es, fr, he, it, kr, nl, oc, pt-br, ru, tr, zh-cn.
## Theme
-In matters of taste and color, there can be no disputes. This is why FreshRSS offers six official themes:
+In matters of taste and color, there can be no disputes. This is why FreshRSS offers eight official themes:
* *Blue Lagoon* by **Mister aiR**
* *Dark* by **AD**
* *Flat design* by **Marien Fressinaud**
* *Origine* by **Marien Fressinaud**
+ * *Origine-compact* by **Kevin Papst**
* *Pafat* by **Plopoyop**
* *Screwdriver* by **Mister aiR**
+ * *Swage* par **Patrick Crandol**
-If none of these are suitable for you, it is always possible to create your own.
+If none of these are suitable for you, it is always possible to [create your own](../developers/04_Frontend/02_Design.md).
To select a theme, simply scroll through the themes and select one that strikes your fancy. After confirmation, the theme will be applied to the interface.
@@ -146,7 +132,7 @@ At the moment, there is no helper to build a user query from here.
1. User control is based on the `.htaccess` file.
2. It is best practice to place the `.htaccess` file in the `./i/` subdirectory so the API and other third party services can work.
- 3. If you want to limit all access to registered users only, place the file in the FreshRSS directory itself or in a parent directory. Note that PubsubHubbub and API will not work!
+ 3. If you want to limit all access to registered users only, place the file in the FreshRSS directory itself or in a parent directory. Note that WebSub and API will not work!
4. Example `.htaccess` file for a user "marie":
```
@@ -175,7 +161,7 @@ More information can be found in the [Apache documentation](http://httpd.apache.
## Advanced
-### Retrieve a truncated stream
+### Retrieve a truncated stream from within FreshRSS
The question comes up regularly, so we will try to clarify here how one can retrieve a truncated RSS feed with FreshRSS. Please note that the process is absolutely not "user friendly", but it works :)
@@ -183,7 +169,7 @@ Also know that this way you are generating much more traffic to the originating
What is meant by "CSS path of articles on the original site" actually corresponds to the "path" consisting of IDs and classes (which in html, matches the id and class attributes) to retrieve only the interesting part that corresponds to the article. Ideally, this path starts with an id (which is unique to the page).
-#### Example 1: Rue89
+#### Example: Rue89
To find this path, you must go to the address of one of the truncated articles (for example http://www.rue89.com/2013/10/15/prof-maths-jai-atteint-lextase-dihn-pedagogie-inversee-246635). You must then look for the "block" of HTML corresponding to the content of the article (in the source code!).
@@ -194,3 +180,11 @@ We find here that the block that encompasses only the content of the article is
* Rue89: ```#article .content```
* PCINpact: ```#actu_content```
* Lesnumériques: ```article#body div.text.clearfix```
+* Phoronix : ```#main .content```
+
+### Retrieve a truncated stream with external tools
+
+Complimentary tools can be used to retrieve full article content, such as:
+
+* [RSS-Bridge](https://github.com/RSS-Bridge/rss-bridge)
+* [Full-Text RSS](https://bitbucket.org/fivefilters/full-text-rss)
diff --git a/docs/en/users/06_Mobile_access.md b/docs/en/users/06_Mobile_access.md
index c354f98f0..d1b310db3 100644
--- a/docs/en/users/06_Mobile_access.md
+++ b/docs/en/users/06_Mobile_access.md
@@ -53,6 +53,8 @@ See the [page about the Fever compatible API](06_Fever_API.md) for another possi
* [EasyRSS](https://github.com/Alkarex/EasyRSS) (Open source, [F-Droid](https://f-droid.org/packages/org.freshrss.easyrss/))
* Linux
* [FeedReader 2.0+](https://jangernert.github.io/FeedReader/) (Open source)
+ * MacOS
+ * [Vienna RSS](http://www.vienna-rss.com/) (Open source)
# Google Reader compatible API