diff options
| author | 2018-11-18 21:08:41 +0100 | |
|---|---|---|
| committer | 2018-11-18 21:08:41 +0100 | |
| commit | e2cb8b929bba51cbfa8c28200881899c451ec7d2 (patch) | |
| tree | 58dad135853ff653f17361ba358fbf26b16c8a4b /docs | |
| parent | ebb9ee0873333c111546412ad08bf5207529f24a (diff) | |
[docs] Add note about specific user for webcron (#2142)
* [docs] Add note about specific user for webcron
Cf. https://github.com/FreshRSS/FreshRSS/issues/613#issuecomment-353585547
* Small changes
* Use one of the RFC addresses for examples
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/en/users/03_Main_view.md | 13 | ||||
| -rw-r--r-- | docs/fr/users/03_Main_view.md | 14 |
2 files changed, 19 insertions, 8 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/fr/users/03_Main_view.md b/docs/fr/users/03_Main_view.md index af3a5a1db..8382340c5 100644 --- a/docs/fr/users/03_Main_view.md +++ b/docs/fr/users/03_Main_view.md @@ -35,14 +35,20 @@ Ci-dessous vous trouverez un exemple permettant la mise à jour des articles tou Il se peut que vous n’ayez pas accès aux tâches planifiées du serveur hébergeant votre instance de FreshRSS. Il reste une possibilité pour mettre les flux à jour automatiquement. -Pour cela vous devez paramétrer une tâche cron qui devra charger régulièrement une url spécifique : https://votre.serveur.net/FreshRSS/p/i/?c=feed&a=actualize (à adapter selon votre installation). Différents cas de figure peuvent se présenter à vous désormais. +Pour cela vous devez paramétrer une tâche cron qui devra charger régulièrement une url spécifique : https://freshrss.example.net/i/?c=feed&a=actualize (à adapter selon votre installation). Différents cas de figure peuvent se présenter à vous désormais. ##### Aucune authentification C’est le cas le plus simple, puisque votre instance est publique, vous n’avez rien de particulier à préciser : ```cron -0 * * * * curl 'https://votre.serveur.net/FreshRSS/p/i/?c=feed&a=actualize' +0 * * * * curl 'https://freshrss.example.net/i/?c=feed&a=actualize' +``` + +Vous pouvez également choisir un utilisateur différent en ajoutant son nom d'utilisateur à la chaîne de requête, avec `&user=nom-dutilisateur` : + +```cron +0 * * * * curl 'https://freshrss.example.net/i/?c=feed&a=actualize&user=someone&token=my-token' ``` ##### Authentification par formulaire @@ -60,7 +66,7 @@ Vous pouvez aussi configurer un jeton d’authentification pour accorder un droi La tâche cron à utiliser sera de la forme suivante : ```cron -0 * * * * curl 'https://votre.serveur.net/FreshRSS/p/i/?c=feed&a=actualize&token=mon-token' +0 * * * * curl 'https://freshrss.example.net/i/?c=feed&a=actualize&token=mon-token' ``` @@ -69,7 +75,7 @@ La tâche cron à utiliser sera de la forme suivante : Dans ce cas-là, le token et les permissions “anonymes” sont inutilisables et il vous sera nécessaire d’indiquer vos identifiants dans la tâche cron. **Notez que cette solution est grandement déconseillée puisqu’elle implique que vos identifiants seront visibles en clair !** ```cron -0 * * * * curl -u alice:password123 'https://votre.serveur.net/FreshRSS/p/i/?c=feed&a=actualize' +0 * * * * curl -u alice:password123 'https://freshrss.example.net/i/?c=feed&a=actualize' ``` ## Mise à jour manuelle |
