Skip to content

Latest commit

 

History

History
204 lines (144 loc) · 11.5 KB

README.md

File metadata and controls

204 lines (144 loc) · 11.5 KB
Raw

Leed

Français - English - Español

Leed (contraction de Light Feed) est un agrégateur RSS/ATOM minimaliste qui permet la consultation de flux RSS de manière rapide et non intrusive.

Cet agrégateur peut s'installer sur votre propre serveur et fonctionne avec un système de tâches cron afin de traiter les informations de manière transparente et de les afficher le plus rapidement possible lorsque vous vous y connectez.

Toutes les tâches de traitements de flux sont effectuées de manière invisible par une tâche programmée (cron), ainsi, l'utilisateur ne subit pas les lenteurs dues à la récupération et au traitement de chacun des flux suivis.

A noter que Leed est compatible toutes résolutions, sur pc, tablette et smartphone.

Leed est également compatible avec le format d'import/export OPML ce qui le rend compatible avec les agrégateurs respectant ce standard.

Pré-requis

  • Serveur Apache conseillé (non testé sur les autres serveurs type Nginx…)
  • PHP 7.2 minimum
  • MySQL
  • Un peu de bon sens :-)

Installation

  1. Récupérez le projet sur la page github.
  2. Placez le projet dans votre répertoire web et appliquez si nécessaire une permission chmod 775 (si vous êtes sur un hebergement ovh, préférez un 0755 ou vous aurez une erreur 500) sur le dossier et son contenu.
  3. Depuis votre navigateur, accédez à la page d'installation install.php (ex : votre.domaine.fr/leed/install.php) et suivez les instructions.
  4. Une fois l'installation terminée, supprimez le fichier install.php par mesure de sécurité.
  5. [Optionnel] Si vous souhaitez que les mises à jour de flux se fassent automatiquement, mettez en place un cron. Voir ci-après. Il est conseillé de ne pas mettre une fréquence trop rapide pour laisser le temps au script de s'exécuter.
  6. Le script est installé, merci d'avoir choisi Leed, l'agrégateur RSS svelte :p

Tâches programmées avec cron

On peut éditer les tâches programmées avec crontab -e. Il y a deux façons de mettre à jour les flux. Les exemples qui suivent mettent à jour toutes les heures.

  1. En appelant directement Leed. Cette méthode a l'avantage d'être directe et de produire une sortie formatée pour la console mais requiert un accès local :
crontab
0 * * * * cd (...)/leed && php action.php >> logs/cron.log 2>&1
  1. En appelant Leed depuis le client web wget. Cette méthode nécessite un accès réseau mais a l'avantage de pouvoir être déclenchée à distance. Afin de contrôler l'accès, il est nécessaire de fournir le code de synchronisation :
0 * * * * wget --no-check-certificate --quiet --output-document /var/www/leed/cron.log
"http://127.0.0.1/leed/action.php?action=synchronize&code=votre_code_synchronisation"

Si vous n'avez pas accès a la commande wget sur votre serveur, vous pouvez essayer son chemin complet /usr/bin/wget.

Plugins

Le dépot Leed market contient tous les plugins à jour et approuvés officiellement pour le logiciel Leed.

Bibliothèques utilisées

Leed (English documentation)

Leed (short for Light Feed) is a minimalist RSS/ATOM aggregator which offers fast RSS consultation and non-intrusive features.

This reader can be installed on your own server and works with a system of cron tasks to process information in a transparent manner and display the updates as quickly as possible when you connect to it.

All tasks are performed in the background thanks to a scheduled task (cron), so the user does not experience delays due to the recovery and processing of each of the monitored feed.

Note that Leed is compatible with all resolutions on pc, tablet and smartphone.

Leed is also compatible with OPML import / export which makes it compatible with aggregators applying the standard.

Prerequisites

  • Recommended Apache server (not tested on other webservers such as Nginx…)
  • PHP 7.2 minimum
  • MySQL
  • A little common sense :-)

Installation

  1. Retrieve the project archive at github.
  2. Place the project in your web directory and if necessary apply a permission chmod 775 (if you're on a ovh hosting, prefer 0755 or you will get an error 500) onto the folder and its contents .
  3. From your browser, go to the setup page install.php (eg your.domaine.fr/leed/install.ph ) and follow the instructions.
  4. Once the installation is complete, remove the install.php as a security measure.
  5. [Optional] If you want the update process to run in the background, set up a crontask. See below for more info. It is advisable not to put too rapid frequency to allow time to run the script.
  6. The script is installed, thank you for choosing Leed, slender RSS aggregator :p

Scheduled tasks with cron

You can edit scheduled tasks with crontab -e. There are two ways to update feeds. The following examples update every hour.

  1. Calling directly Leed. This method has the advantage of being direct and produce formatted output to the console but requires local access :
Crontab
0 * * * * cd (...)/leed && php action.php >> logs/cron.log 2>&1
  1. Leed calling from the web client wget. This method requires network access but has the advantage that it can be triggered remotely. To control access, it is necessary to provide the synchronization code :
0 * * * * wget --no-check-certificate --quiet --output-document /var/www/leed/cron.log
"http://127.0.0.1/leed/action.php?action=synchronize&code=votre_code_synchronisation"

If you do not have access to the wget command on your server, you can try the full path /usr/bin/wget.

Plugins

The Leed-market repository contains all the plugins up to date and officially approved for Leed software.

Libraries used

Leed (Documentación española)

Leed (contracción de Light Feed) es un agregator RSS/ATOM minimalista que permite leer sus RSS rapidamente y facilmente.

Se puede instalar este agregador sobre su servidor. Leed funciona con un sistema de tareas cron para procesar los RSS de manera transparente y mostrarse tan pronto como sea posible cuando se conecta.

Todas las tareas de tratamiento de los RSS se efectuan de manera invisible gracias a una tarea sincronizada (Cron). Así, el usuario no debe sufrir los largos tiempos necesarios para recuperar y tratar los RSS.

Se debe notar que Leed es compatible con todas las resoluciones, sobre un ordenador, una tablet o un móvil y funciona con todos los navegadores.

El script también está compatible con los archivos de exportación/importación OPML para permitir una migración rápida y fácil a partir de todos los agregadores que respetan el formato OPML.

Prerrequisito

  • Se recomienda Apache (non testé sur les autres serveurs type Nginx…)
  • PHP versión 7.2 mínima
  • MySQL
  • Un poco de sentido común ;-)

Instalación

  1. Recuperar el proyecto sobre github.
  2. Poner el proyecto en su directorio web y aplicar un permiso chmod 775 sobre el directorio y su contenido (si su web host es OVH, aplicar un permiso 0755 para no tener un error 500).
  3. Desde el navegador, ir a la página de configuración install.php (por ejemplo : http://su.sitio.fr/leed/install.php) y seguir las instrucciones.
  4. Una vez terminada la instalación, suprimir el archivo install.php por medida de seguridad.
  5. [Opcional] Si desea que las actualizaciones sean automaticas, necesita una tarea cron. Véase más abajo. Es aconsejable no poner frecuencia demasiado rápida para que el script tenga tiempo para ejecutarse.
  6. Se ha instalado el script, gracias por elegir Leed, delgado agregador RSS: p

Tareas cron

Se puede modificar las tareas cron con crontab -e. Hay dos maneras de actualizar los RSS. Los ejemplos siguientes actualizan los RSS cada hora.

  1. Llamando directamente Leed. Esta manera es directa y genera una salida formatada para el terminal, pero necesita un acceso local :
crontab
0 * * * * cd (...)/leed && php action.php >> logs/cron.log 2>&1
  1. Llamando directamente Leed desde el cliente web wget. Esta manera necesita un acceso a la red pero se puede utilizarla de manera remota. Para controlar el acceso, se necesita un código de sincronización :
0 * * * * wget --no-check-certificate --quiet --output-document /var/www/leed/cron.log
"http://127.0.0.1/leed/action.php?action=synchronize&code=votre_code_synchronisation"

Si no tiene wget en su servido, puede intentar con el camino complejo /usr/bin/wget.

Complementos

El repositorio Leed market contiene todos los complementos oficialemente aprobados para Leed.

Bibliotecas usadas